Overview
The purpose of this document is to describe the file format for the import of quantities. This will be organized via XLSX file containing one single sheet.
/*<![CDATA[*/ div.rbtoc1770892089488 {padding: 0px;} div.rbtoc1770892089488 ul {list-style: disc;margin-left: 0px;} div.rbtoc1770892089488 li {margin-left: 0px;padding-left: 0px;} /*]]>*/ Overview General Information Overall Conventions Software Worksheet Table Columns Column name Column Code Requirement of Contained Data Data types Column Description Translatability IN/OUT Identifiers (IDs) Import of Quantities
General Information
A file format defines syntax and semantics of data within files. It represents a bidirectional mapping between information and its storage in a medium. Knowledge of the file format is crucial for the interpretation of data stored in a file.
This specification details the layout of data within a file. The document describes the following:
-
exchanged information
-
format and layout of the exchanged document
Overall 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.
Worksheet
An Excel file can be structured in multiple work sheets. Each work sheet has a name that must be adhered to.
Each 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.
Table 1: available data types
|
Data type |
Description |
Example |
|---|---|---|
|
Integer |
whole number (positive and negative) |
-10, 20 |
|
Real |
Rational numbers (positive and negative)
|
10, 10.5, -12,44
|
|
String |
Sequence of characters (excluding inverted comma)
|
AbC |
Column Description
Description of the content for each column.
Translatability
The content of each column can be either translatable or 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. 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
Import of Quantities
Worksheet is used for describing Quantities.
Quantities will always be of type non-dependent and will have any measure data type.
|
Column name |
Obligation |
Relevant for Import |
Column Code |
Data Type |
Description |
Example |
Translatable |
|---|---|---|---|---|---|---|---|
|
Identifier of the quantity |
M |
Yes |
Q1 |
String |
Identifier of the quantity, either internal ID or eptos ID. When eptos ID and non empty the entity is created with the given IRDI/SCV (after check that given code is available). Else IRDI/SCV is generated. |
PAR1-AAC490-001 |
N |
|
Primary language |
M |
Yes |
Q2 |
String |
Locale in which the quantity was initially defined |
en_US |
N |
|
Name of quantity |
M |
Yes |
Q04 (LG) |
String |
Contains the language specific name of quantity. |
mechanical tension |
Y |
|
Entity Scope |
M |
Yes |
A14 |
String |
Definition class of the quantity. The identifier can be either specified as IRDI or as SCV notation. |
PAR1-RAA001-001 |
N |
|
Code of level 1 (basic) quantity |
O |
No |
E26 |
String |
Code (extended attribute Z35) of level 1 quantity |
1000 |
N |
|
Identifier of the level 1 quantity |
O |
No |
E27 |
String |
Identification of the level 1 quantity. The identifier can be either specified as IRDI or as SCV notation. |
PAR1-BAJ925-001 |
N |
|
Name of level 1 quantity |
O |
No |
E28 (LG) |
String |
Contains the language specific name of level 1 quantity. |
mechanical tension |
Y |
|
Description of the level 1 quantity |
O |
No |
E29 (LG) |
String |
Contains the language specific definition of the level 1 quantity |
[…] the limit value of the ratio between the force and […] |
Y |
|
Code of level 2 (specified) quantity |
O |
No |
E30 |
String |
Code of level 2 quantity |
1000 |
N |
|
Identifier of the level 2 quantity |
O |
No |
E31 |
String |
Identification of the level 2 quantity. The identifier can be either specified as IRDI or as SCV notation. |
PAR1-BAJ925-001 |
N |
|
Name of level 2 quantity |
O |
No |
E32 (LG) |
String |
Contains the language specific name of level 2 quantity. |
mechanical tension |
Y |
|
Description of the level 2 quantity |
O |
No |
E33 (LG) |
String |
Contains the language specific definition of the level 2 quantity |
[…] the limit value of the ratio between the force and […] |
Y |
|
Code of level 3 (structured) quantity |
O |
No |
E34 |
String |
Code of level 3 quantity |
1000 |
N |
|
Identifier of the level 3 quantity |
O |
No |
E35 |
String |
Identification of the level 3 quantity. The identifier can be either specified as IRDI or as SCV notation. |
PAR1-BAJ925-001 |
N |
|
Name of level 3 quantity |
O |
No |
E36 (LG) |
String |
Contains the language specific name of level 3 quantity. |
mechanical tension |
Y |
|
Description of the level 3 quantity |
O |
No |
E37 (LG) |
String |
Contains the language specific definition of the level 3 quantity |
[…] the limit value of the ratio between the force and […] |
Y |
|
Description of quantity |
O |
Yes |
Q05 (LG) |
String |
Contains the language specific definition of the quantity |
[…] the limit value of the ratio between the force and […] |
Y |
|
Source of Definition |
O |
Yes |
A05 (LG) |
String |
Contains the language specific source of definition of the quantity |
|
Y |
|
Note to Definition |
O |
Yes |
A06 (LG) |
String |
Contains the language specific note to definition of the quantity |
|
Y |
|
Aspect of conversion |
O |
No |
E16 |
String |
Aspect of conversion of the quantity. |
m⁻¹ kg s⁻² |
|
|
Identifier for the aspect of conversion |
O |
Yes |
E17 |
String |
Identification of the aspect of conversion for the quantity. The identifier can be either specified as IRDI or as SCV notation. |
PAR1-AAA066-001 |
N |
|
Shortname of supplier |
M |
No |
C08 |
String |
DIN name of supplier |
PAR1 |
N |
|
Superelement |
O |
Yes |
C09 |
String |
Identifier of the parent quantity. The identifier can be specified as IRDI, as SCV notation or as internal ID as specified under column Q1 (“Identifier of the quantity”). |
PAR1-AAC490-001 |
|
|
Entity Scope - Preferred Name |
O |
No |
P04 (LG) |
String |
Preferred name of the entity scope (definition class). The identifier can be either specified as IRDI or as SCV notation. |
PAR Definition Class |
Y |
Quantities columns
NOTES:
Column codes for translatable fields are expected to contain the language code according to ISO 639-1 in uppercase. Example: E28 (EN) will contain the English name of level 1 quantity while E28 (DE) will contain the German name of level 1 quantity.
Quantities will always be of type non-dependent and will have any measure data type.