/*<![CDATA[*/ div.rbtoc1770892091955 {padding: 0px;} div.rbtoc1770892091955 ul {list-style: disc;margin-left: 0px;} div.rbtoc1770892091955 li {margin-left: 0px;padding-left: 0px;} /*]]>*/ Introduction Purpose Scope Generalities Translations Import Translations Export File Format Specification Sheet Class Sheet Property Sheet Value Sheet Value List Sheet Unit
Introduction
Purpose
The purpose of the present File Format Specification is to define import formats to allow adding Structure Elements Change Text and Translations, without change request management.
At the same time, all translatable fields of Structure Elements included in present FFS will be included in an xlsx export.
Scope
In scope of this document is:
-
description of the File Format Specification
Out of scope of this document is:
-
Description of the Use Cases and User Interface
Generalities
Change Text and Translations of Structure Elements, without change management, shall be organized via Import of Excel file (XLSX).
Import file will be based on 5 separate sheets (name of the sheets is not pre-defined, it can be entered by users as desired):
-
Sheet containing only Classes
-
Sheet containing only Properties
-
Sheet containing only Values
-
Sheet containing only Value Lists
-
Sheet containing only Units
Import file serves the scope to enhance Structure Elements translations of all translatable fields.
Modification or addition of new translations under a "translation release" are out of scope of this import.
Translations Import
-
Import file type will be Excel 2003. Sheet names are not pre-defined.
-
It is not mandatory to have all the sheets in import file.
-
System allows import of ".xlsx"-files packed as ".zip".
For each line from import file the textual attributes of referenced structure element will be updated. If user specifies only preferred name of a class in English, the translations in German, Spanish and definition will remain as is. In other words, information from import file is used to update textual attributes, there will be no change/delete of translations or values of attributes which are not mentioned in import file. This import can't be used to delete translations and values of textual attributes.
Translations Export
All translatable fields for the Structure Elements included in present document (Classes, Properties, Values, Value Lists and Units) will also be exportable in xlsx format.
Classes will be exported in separate sheets, according to their type: Classification Classes, Application Classes, Blocks and Aspects.
Languages and elements to be included in export file will be selected in export interface in portal.
Each column header will contain beside the name of the field the language_country contained.
File Format Specification
Sheet Class
Sheet "Class" serves as working table for the user allowing input of Change Textual Attributes / Translations for Classes.
|
Column name |
Column code |
Mandatory
|
Description |
|
Coded Name |
C01 |
C |
Coded Name of Classification Class (ex:27.01.02.03) |
|
Class IRDI |
C02 |
C |
IRDI of Class (Classification Class, Application Class, Block, Aspect) |
|
[Extended Attribute Code] |
C03 |
C |
Code of Extended Attribute for Class Identification |
|
Preferred Name (language_country) |
C04 |
O |
Preferred Name of Class |
|
Definition (language_country) |
C05 |
O |
Definition of Class |
|
Short Preferred Name
|
C06 |
O |
Contains the short preferred name of Class |
|
Short Name (language_country) |
C07 |
O |
Contains the Short Name of Class |
|
Note (language_country) |
C08 |
O |
Contains the Note of Class |
|
Remark (language_country) |
C09 |
O |
Contains the Remark of Class |
Notes:
-
User has three possibilities to specify the class to be updated:
-
Coded Name
-
IRDI
-
Extended Attribute Code
At least one of them must be filled out.
-
Additional column will be added for each additional language corresponding to the editable field to be imported.
Sheet Property
Sheet "Property" serves as working table for the user allowing input of Change Text / Translations for Properties.
|
Column name |
|
Mandatory
|
Description |
|
Property IRDI |
P01 |
C |
IRDI of Property |
|
[Extended Attribute Code] |
P02 |
C |
Code of Extended Attribute for Identification of Property |
|
Preferred Name (language_country) |
P03 |
O |
Preferred Name of Property |
|
Definition (language_country) |
P04 |
O |
Definition of Properties |
|
Short Preferred Name (language_country) |
P05 |
O |
Contains the short preferred name of Property |
|
Short Name (language_country) |
P06 |
O |
Contains the short name of Property |
|
Source of definition
|
P07 |
O |
Contains the Source of definition of Property |
|
Note (language_country) |
P08 |
O |
Contains the Note of Property |
|
Remark (language_country) |
P09 |
O |
Contains the Remark of Property |
Notes:
-
User has three possibilities to specify the property to be updated:
-
IRDI
-
Extended Attribute Code
At least one of them must be filled out.
-
Additional column will be added for each additional language corresponding to the editable field to be imported.
Sheet Value
Sheet "Value" serves as working table for the user allowing input of Change Text / Translations for Values.
|
Column name |
|
Mandatory
|
Description |
|
Value IRDI |
V01 |
C |
IRDI of Value |
|
[Extended Attribute Code] |
V02 |
C |
Extended Attribute Code for Identification of Value |
|
Preferred Name (language_country) |
V03 |
O |
Preferred Name of Value |
|
Definition (language_country) |
V04 |
O |
Definition of Value |
|
Short Preferred Name
|
V05 |
O |
Contains the short preferred name of Value |
|
Short Name (language_country) |
V06 |
O |
Contains the short name of Value |
|
Note (language_country) |
V07 |
O |
Contains the Note of Value |
|
Remark (language_country) |
V08 |
O |
Contains the Remark of Value |
|
Long text (language_country) |
V09 |
O |
Contains the Long Text of Value |
Notes:
-
User has three possibilities to specify the value to be updated:
-
IRDI
-
Extended Attribute Code
At least one of them must be filled out.
-
Additional column will be added for each additional language corresponding to the editable field to be imported.
Sheet Value List
Sheet "Value list" serves as working table for the user allowing input of Change Text / Translations for Value lists.
|
Column name |
|
Mandatory
|
Description |
|
Value list IRDI |
VL01 |
C |
IRDI of Value list |
|
[Extended Attribute Code] |
VL02 |
C |
Extended Attribute Code for Identification of Value list |
|
Preferred Name (language_country) |
VL03 |
O |
Preferred Name of Value list |
|
Definition (language_country) |
VL04 |
O |
Definition of Value list |
|
Short Preferred Name (language_country) |
VL05 |
O |
Contains the short preferred name of Value list |
|
Short Name (language_country) |
VL06 |
O |
Contains the short name of Value list |
|
Note (language_country) |
VL07 |
O |
Contains the Note of Value list |
|
Remark (language_country) |
VL08 |
O |
Contains the Remark of Value list |
Notes:
-
User has three possibilities to specify the value list to be updated:
-
IRDI
-
Extended Attribute Code
At least one of them must be filled out.
-
Additional column will be added for each additional language corresponding to the editable field to be imported.
Sheet Unit
Sheet "Unit" serves as working table for the user allowing input of Change Text / Translations for Units.
|
Column name |
|
Mandatory
|
Description |
|
Unit IRDI |
|
C |
IRDI of Unit |
|
[Extended Attribute Code] |
U01 |
C |
Extended Attribute Code for Identification of Unit |
|
Preferred Name (language_country) |
U02 |
O |
Preferred Name of Unit |
|
Structured naming
|
U03 |
O |
Contains the Structured naming of Unit |
|
Definition (language_country) |
U04 |
O |
Definition of Unit |
|
Short Preferred Name
|
U05 |
O |
Contains the short preferred name of Unit |
|
Short Name (language_country) |
U06 |
O |
Contains the short name of Unit |
|
Comment (language_country) |
U07 |
O |
Contains the Comment of Unit |
|
Source of definition
|
U08 |
O |
Contains the Source of definition of Unit |
|
Name (language_country) |
U09 |
O |
Contains the Name of the Unit |
Notes:
-
User has three possibilities to specify the value list to be updated:
-
IRDI
-
Extended Attribute Code
At least one of them must be filled out.
-
Additional column will be added for each additional language corresponding to the editable field to be imported.