Conventions
Software
The document comes in .xlsx format, therefore to build the file a program needs to be installed that can handle the XLSX format, such as Microsoft Excel. Documents which implement this file format specification need to be saved as .xlsx files (i.e. Microsoft Excel 2003 format).
Worksheet
An Excel file can be structured in multiple work sheets. Each work sheet has a name that must be adhered to.
In this document the work sheet for organization unit import is described.
The sheet has two header lines and a data payload.
In row 1 the human readable column names are printed – the row will be ignored by import
Row 2 contains the column codes that are used by the import program to identify the content.
Then follow the data rows.
Table Columns
Column name
Each table column has a name which gives a human comprehensive short reference of the column's content.
Note: the column name is for convenience only and not used to interpret the file.
Column Code
In order to reference the column unambiguously each column gets a unique code within the worksheet.
The import program is relying on Column Codes. If Column orders are changed, the codes must be preserved.
Requirement of Contained Data
Each column of contained data can be either
-
Mandatory – values MUST be present
-
Optional – values MAY be present
-
Conditional – values MUST be present IF a condition applies
Data types
Each column has a defined data type, i.e. a restricted set of available values. For example the data type integer only allows whole numbers while the data type string allows any sequences of characters. Additionally the data type string can be syntactically further constrained by a grammar.
|
Data type |
Description |
Example |
|
Integer |
whole number (positve and negative) |
-10, 20 |
|
Real |
Rational numbers (positive and negative)
|
10, 10.5, -12,44
|
|
String |
Sequence of characters (excluding inverted comma)
|
AbC |
available data types
Column Description
Description of the content for each column.
Translatability
The content of each column can be either translatable of not. In case a column's content data are translatable, the column code in the header is suffixed by a locale code comprising of a language code, an underscore and a country code. Example of locale codes: "de_DE", "en_US".
IN/OUT
For each column it can be defined whether the contained data is relevant for import or only gives additional information to a human reader of the file.
Identifiers (IDs)
References within the exchange file are made by an ID. There are two kinds of IDs to be separated:
-
Transient ID
Any sequence of characters can be treated as a transient ID when it cannot be confused with a code or an IRDI (see: https://eclass.eu/support/technical-specification/data-model/irdi-path). It is recommended to use 6 digits long zero padded running numbers, e.g. 000001. The running number must be unique within the file and will be replaced by a code during import.
-
Persistent ID
A persistent ID can be used for references during load of new entries and for updates of existing entries. For updates of data that are already stored in eptos using a persistent ID is mandatory. The format of the persistent ID in eptos is the international registration data identifier (IRDI). For classification classes also the coded name may be used.
When an import file contains more than one ID for the same entity, the following precedence is taken:
-
Persistent ID (IRDI)
-
Coded Name
-
Transient ID
Worksheet Classes
Classes - Worksheet
Worksheet is used for describing classification classes, application classes, aspect classes, block classes.
|
Column Name |
Column Code |
Obligation |
IN/OUT |
Data type |
Description |
Translatable |
|
Import Action |
Z01 |
M |
IN |
String |
In imports, if no value is specified, the system will try an update of element if exists, else will consider it as new element. Import actions in case of development releases:
|
N |
|
Class Discriminator
|
Z52 |
M |
IN/OUT |
Char(1) |
Because worksheet "Classes" handles all class types, user needs a means to transmit to the system which Class should be created by import as an Application Class, which as an Classification Class, etc. This means is the "Class Discriminator" by which user can specify the type of class. Possible values:
|
N |
|
Application Class Type |
Z19 |
C |
IN/OUT |
String |
Specifies type of application class. Allowed values:
|
N |
|
Hierarchical Position |
Z28 |
C |
IN/OUT |
String |
For classification classes it contains Hierarchical Position. Value and syntax of this field depends on dictionary settings where classification class belongs. In general hierarchical position may serve also to identify the super class of current class (except dictionaries where hierarchical position is defined as free text in dictionary). Example of hierarchical position values (17010101, PB101) |
N |
|
Identifier |
C04 |
C:
|
IN/OUT |
String |
Contains Identifier of dictionary-element which will be imported. If dictionary-element is already present in the system an update will take place (directly or through change request depending on dictionary change management type) The following types of identifiers are allowed:
|
N |
|
Internal ID |
Z04 |
O |
IN |
String |
Contains an identifier valid inside import file. This identifier is used to reference this line in other work sheets (e.g. import a new property without identifier and assign it to a class). |
N |
|
Preset SCV |
Z66 |
O |
IN |
String |
Contains a fixed eptos ID for the newly imported structure element. It is used to maintain the same IDs in different systems. If an element of the same type with this code already exists in the system a validation error will be included in the report. |
N |
|
Super Class ID |
Z44 |
O, C |
IN/OUT |
String |
Contains Identifier of an existing class. The following types of identifiers are allowed:
It is used to identify the super class to be imported. If no value is entered in this column, system automatically sets the root class as super class. Note: The root class is the uppermost class in the hierarchical structure and it is created/defined at create Dictionary. Note: If another class is identified as super class (different than the root class), the result is that the system will create a hierarchical (parent class-specialized class) relation between the two classes. The specialized classes inherit the properties from the parent class. On import, this inheritance can be controlled via the GUI Option "Inherit properties from superclass". |
N |
|
Super Class Internal ID |
Z46 |
O |
IN |
String |
Contains Identifier of a new Application Class, Block or Aspect described in the same file. It is used to identify the super class of current Application Class, Block or Aspect. |
N |
|
Preferred Name |
A01 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the application class. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Preferred Name 2 |
Z34 (LC_CC) |
O |
|
String |
|
Y |
|
Preferred Name Short |
Z35 (LC_CC) |
O |
|
String |
|
Y |
|
Short Name |
A08 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the application class. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Definition |
A04 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the application class. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Source of Definition |
A05 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the application class. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Note |
A06 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the application class. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Remark |
A07 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the application class. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Synonymous Name |
Z48 (LC_CC) |
O |
|
String |
|
Y |
|
Restricted |
Z36 |
O |
|
String |
Adds Access Control restriction for visibility. Possible values: ALLOW or DENY. |
N |
|
Extended Attribute |
{EA CODE} |
O |
IN/OUT |
String |
Code of extended attribute for dictionary-element identification. When column is present, "EA Code" is used to identify the extended attribute template. This code must not overlap with one of the existing codes of the other dictionary-element attributes. |
N |
Worksheet Properties
Properties - Worksheet
Worksheet is used for describing properties.
|
Column Name |
Column Code |
Obligation |
IN/OUT |
Data type |
Description |
Translatable |
|
Import Action |
Z01 |
O |
IN |
String |
In imports, if no value is specified, the system will try an update of element if exists, else will consider it as new element. Import actions in case of development releases:
|
N |
|
Identifier |
C04 |
O |
IN/OUT |
String |
Contains Identifier of dictionary-element which will be imported. If dictionary-element is already present in the system an update will take place (directly or through change request depending on dictionary change management type) The following types of identifiers are allowed:
|
N |
|
Change Request ID |
Z03 |
O |
IN/OUT |
Integer |
Specifies if an existing Change Request will be updated (only textual attributes or status can be changed). When a value is specified in this column the other values for identification of structure element are ignored. |
N |
|
Internal ID |
Z04 |
O |
IN |
String |
Contains an identifier valid inside import file. This identifier is used to reference this line in other work sheets (e.g. import a new property without identifier and assign it to a class). |
N |
|
Extended Attribute |
{EA CODE} |
O |
IN/OUT |
String |
Code of extended attribute for dictionary-element identification. When column is present, "EA Code" is used to identify the extended attribute template. This code must not overlap with one of the existing codes of the other dictionary-element attributes. |
N |
|
Preferred Name |
A01 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the property. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Short Name |
A08 (CL_CC) |
C, O |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the property. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Definition |
A04 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the property. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Note |
A06 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the property. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Remark |
A07 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the property. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Source of Definition |
A05 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the property. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW)
|
Y |
|
Definition Class ID |
A14 |
C |
IN/OUT |
String |
Contains the identifier of an existing Class which will be set as definition Class for the Property to be imported. This means the Property can be used in this Class. If the Property is existing, the value of this field will be ignored because changing the Definition Class of the Property is out of scope of this import. The following types of identifiers are allowed:
|
N |
|
Type |
A13 |
O |
IN/OUT |
String |
Specifies type of property. Allowed values are:
If value is not specified for a new property, "non dependent" is considered by default. |
N |
|
Data Type |
A15 |
C |
IN/OUT |
String |
Value is mandatory for new properties. For textual changes of property it will be ignored, modification of property data type is not supported. Specifies the data type of the property. Allowed values are:
|
N |
|
Digits before comma |
Z05 |
O |
IN/OUT |
Integer |
Specifies number of integer digits for numeric properties |
N |
|
Digits after comma |
Z06 |
O |
IN/OUT |
Integer |
Specifies number of fraction digits for numeric properties |
N |
|
Number of characters |
Z07 |
O |
IN/OUT |
Integer |
Specifies maximum number of characters for String properties
|
N |
|
Unit ID |
E24 |
O |
IN/OUT |
String |
For measure properties, contains the identifier of the default unit. The following types of identifiers are allowed:
|
N |
|
Unit Name |
Z08 |
O |
IN/OUT |
String |
For measure properties, it contains one of the following attributes of the default unit:
|
N |
|
Alternate Units ID |
Z09 |
O |
IN/OUT |
String |
For measure properties, contains a list of identifiers for alternate units. The following types of identifiers are allowed:
List of identifiers may be separated by comma or semicolon. |
N |
|
Quantity ID |
Q01 |
O |
IN/OUT |
String |
For measure properties, contains the identifier of the quantity. The following types of identifiers are allowed:
|
N |
|
Class Type |
B07 |
O |
IN/OUT |
String |
Specifies the 3 character IEC code for class type of property (e.g. R91, Q52)
|
N |
|
Reference Class ID |
Z10 |
O |
IN/OUT |
String |
Contains Identifier of an existing class. The following types of identifiers are allowed:
It is used to identify the referenced block in the case of reference properties. |
N |
|
Valency |
Z13 |
O |
IN/OUT |
String |
Specifies valency of property. Allowed values are:
|
N |
|
Value List ID |
A17 |
O |
IN/OUT |
String |
Contains Identifier of an existing value list. The following types of identifiers are allowed:
It is used to identify the value list of the property. |
N |
|
Value List Internal ID |
Z15 |
O |
IN |
String |
Contains Identifier of a new value list described in the same file. It is used to identify the value list of the property. |
N |
|
Preferred Symbol |
B01 |
O |
IN/OUT |
String |
Contains the Preferred Symbol of the property |
N |
|
Substitute Symbol |
B02 |
O |
IN/OUT |
String |
Contains the Substitute Symbol of the property |
N |
|
Preset SCV
|
Z66 |
O |
IN |
String |
Contains a fixed eptos ID for the newly imported structure element. It is used to maintain the same IDs in different systems. If an element of the same type with this code already exists in the system a validation error will be included in the report. |
N |
Worksheet Values
Values - Worksheet
Worksheet is used for describing coded values.
|
Column Name |
Column Code |
Obligation |
IN/OUT |
Data type |
Description |
Translatable |
|
Import Action |
Z01 |
O |
IN/OUT |
String |
In imports, if no value is specified, the system will try an update of element if exists, else will consider it as new element. Import actions in case of development releases:
|
N |
|
Identifier |
C04 |
O |
IN/OUT |
String |
Contains Identifier of dictionary-element which will be imported. If dictionary-element is already present in the system an update will take place (directly or through change request depending on dictionary change management type) The following types of identifiers are allowed:
|
N |
|
Internal ID |
Z04 |
O |
IN |
String |
Contains an identifier valid inside import file. This identifier is used to reference this line in other work sheets (e.g. import a new property without identifier and assign it to a class). |
N |
|
Extended Attribute |
{EA CODE} |
O |
IN/OUT |
String |
Code of extended attribute for dictionary-element identification. When column is present, "EA Code" is used to identify the extended attribute template. This code must not overlap with one of the existing codes of the other dictionary-element attributes. |
N |
|
Value |
A18 |
O |
IN/OUT |
<anyType> |
Value according to Data Type. |
N |
|
Preferred Name |
A01 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the value. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Short Name |
A08 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the value. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Definition |
A04 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the value. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Note |
A06 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the value. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Remark |
A07 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the value. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Source of Definition |
A05 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the value. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Value Specification Type |
A16 |
O |
IN/OUT |
String |
Indicate value specification for value. Allowed Values:
|
N |
|
Data Type |
A15 |
C |
IN/OUT |
String |
Specifies the data type of the value. Allowed values are:
Note: Field is mandatory on create but optional on edit. |
N |
|
Unit Name |
Z39 |
O |
IN/OUT |
String |
For value(s) with measure datatype, contains the name of the unit. |
N |
Worksheet Value Lists
Values Lists - Worksheet
Worksheet is used for describing value lists.
|
Column Name |
Column Code |
Obligation |
IN/OUT |
Data type |
Description |
Translatable |
|
Import Action |
Z01 |
O |
IN/OUT |
String |
In imports, if no value is specified, the system will try an update of element if exists, else will consider it as new element. Import actions in case of development releases:
|
N |
|
Identifier |
C04 |
O |
IN/OUT |
String |
Contains Identifier of dictionary-element which will be imported. If dictionary-element is already present in the system an update will take place (directly or through change request depending on dictionary change management type) The following types of identifiers are allowed:
|
N |
|
Internal ID |
Z04 |
O |
IN |
String |
Contains an identifier valid inside import file. This identifier is used to reference this line in other work sheets (e.g. import a new property without identifier and assign it to a class). |
N |
|
Preferred Name |
A01 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the value list. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Short Name |
A08 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the value list. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Definition |
A04 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the value list. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Note |
A06 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the value list. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Remark |
A07 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the value list. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Value Specification |
Z53 |
O |
IN/OUT |
String |
Indicate value specification for value list. Allowed Values:
|
N |
|
Source of Definition |
A05 (LC_CC) |
C |
IN/OUT |
String |
Field may appear multiple times and it specifies the value of textual attribute of the value list. Each apparition contains language information for text attribute (e.g. en_US, de_DE, zh_CN, zh_TW) |
Y |
|
Data Type |
A15 |
O |
IN/OUT |
String |
Specifies the data type of the property. Allowed values are:
|
N |
|
Unit ID |
E24 |
O |
IN/OUT |
String |
For measure properties, contains the identifier of the default unit. The following types of identifiers are allowed:
|
N |
|
Unit Name |
Z08 |
O, C |
IN/OUT |
String |
For measure properties, contains the name of the default unit. |
N |
|
Domain Type |
Z55 |
M |
IN/OUT |
String |
Specifies the type of value list. Possible values:
|
N |
Worksheet Class Class Relations
Class Class Relations - Worksheet
|
Column Name |
Column Code |
Obligation |
IN/OUT |
Data type |
Description |
Translatable |
|
Import Action |
Z01 |
O |
IN/OUT |
String |
Possible values are:
|
N |
|
Source ID |
Z41 |
C |
IN/OUT |
String |
Contains Identifier of an existing class. The following types of identifiers are allowed:
It is used to identify the source class in relation class - class. |
N |
|
Source Internal ID |
Z43 |
C |
IN |
String |
Contains Identifier of a new class described in the same file. It is used to identify the source class in relation class - class. |
N |
|
Target ID |
Z49 |
C |
IN/OUT |
String |
Contains Identifier of an existing class. The following types of identifiers are allowed:
It is used to identify the target class in relation class - class. |
N |
|
Target Internal ID |
Z51 |
C |
IN |
String |
Contains Identifier of a new class described in the same file. It is used to identify the target class in relation class - class. |
N |
Worksheet Class Property Relations
Class Property Relations - Worksheet
Worksheet is used for describing used properties of class.
|
Column Name |
Column Code |
Obligation |
IN/OUT |
Data type |
Description |
Translatable |
|
Import Action |
Z01 |
M |
IN/OUT |
String |
Possible values are:
|
N |
|
Source ID |
Z41 |
C |
IN/OUT |
String |
Contains Identifier of an existing class (application, aspect, block). The following types of identifiers are allowed:
It is used to identify the class in relation class - property. |
N |
|
Source Internal ID |
Z43 |
C |
IN/OUT |
String |
Contains Identifier of a new class (application, aspect, block) described in the same file. It is used to identify the class in relation class - property. |
N |
|
Target ID |
Z49 |
C |
IN/OUT |
String |
Contains Identifier of an existing property. The following types of identifiers are allowed:
It is used to identify the property in relation class - property. |
N |
|
Target CR ID |
Z50 |
C |
IN/OUT |
String |
Contains Identifier of a change request of type new property. It is used to identify the property in relation class - property. |
N |
|
Target Internal ID |
Z51 |
C |
IN/OUT |
String |
Contains Identifier of a new property described in the same file. It is used to identify the property in relation class - property. |
N |
Worksheet Value List Value Relations
Value List Value Relations - Worksheet
Worksheet is used for describing values in value lists.
|
Column Name |
Column Code |
Obligation |
IN/OUT |
Data type |
Description |
Translatable |
|
Import Action |
Z01 |
M |
IN/OUT |
String |
Possible values are:
|
N |
|
Value List ID |
A17 |
C |
IN/OUT |
String |
Contains Identifier of an existing value list. The following types of identifiers are allowed:
It is used to identify the value list in relation value list - value. |
N |
|
Value List Internal ID |
Z15 |
C |
IN |
String |
Contains Identifier of a new value list described in the same file. It is used to identify the value list in relation value list - value. |
N |
|
Value ID |
Z61 |
C |
IN/OUT |
String |
Contains Identifier of an existing value. The following types of identifiers are allowed:
It is used to identify the value in relation value list - value. |
N |
|
Value Internal ID |
Z62 |
C |
IN/OUT |
String |
Contains Identifier of a new value described in the same file. It is used to identify the value in relation value list - value. |
N |
|
Order Index |
Z33 |
O |
IN/OUT |
Integer |
Contains a number indicating the position of the value within the value list. |
N |
|
Parent Value ID |
Z57 |
O |
IN/OUT |
String |
Contains Identifier of an existing value. The following types of identifiers are allowed:
It is used to identify the parent value in relation value list - value. It is used for hierarchical presentation of values. The parent is specified at level of association between value and value list. It is not structural parent of value |
N |
|
Parent Value Internal ID |
Z58 |
|
|
String |
Contains Identifier of a new value described in the same file. It is used to identify the parent value in relation value list - value. It is used for hierarchical presentation of values. The parent is specified at level of association between value and value list. It is not structural parent of value |
|
|
Order Index Under Parent |
Z60 |
C |
IN/OUT |
Integer |
Contains a number indicating the position of the value under parent values within the value list. |
N |