Exchange via XLSX
General requirements
- You have called up the Project Builder.
- You have opened a library.
- You have selected a target project and opened the configurator.
Preconditions: Structure of the XLSX file
The XLSX file must have a specific structure so that it can be used in the Project Builder.
The internal name of the corresponding element in the XLSX file must exist so that the contents of an XLSX file can be assigned to the configuration variables, Macro-Typicals and Typical-Groups available in the Project Builder. If a translated displayed name exists, it is therefore supplemented with the technically required, model-internal name. The model-internal name is enclosed by braces { }. If no translated displayed names exist for an element, these braces are not required.
Example: Internal name and translated displayed name of a configuration variable
- Configuration variable with internal name
Var01 - Displayed name of the configuration variable
Here you see the display of the internal name and the translated displayed names of the configuration variable in the XLSX file.
A | B | |
---|---|---|
1 |
* |
|
2 |
|
|
3 |
* The cell A1 of an XLSX file is reserved for the specification of the configurator element.
Tip
In case of a data exchange via XLSX files, the braces { } in the displayed name as well as entries in the selection lists of configuration variables should not be used, since the required uniqueness is otherwise not ensured during the import.
Note
During data exchange only the first worksheet of a XLSX workbook is considered.
Example: Configurators and elements
A definition of a configurator with the name
Display in the Project Builder:
The export result of an XLSX file of the configurator element
A | B | |
---|---|---|
1 |
|
|
2 |
|
|
3 |
|
|
4 |
|
|
Tip
The structurally correct XLSX file of a configurator element is most easily generated via the function Export *.xlsx from the Project Builder.
Note
A configuration element only has to be specified during the usage of the silent mode. This is irrelevant during a manual import of an XLSX file in the Project Builder. The contents of cell A1 in the XLSX file are not checked in this use case.
The higher-level configuration variables are specified as of row 2 of the XLSX file. Column A contains the name, and column B the value for a specific configuration variable. The exact designation of the configuration variable must be entered as the name. The value to be defined must be available for selection in the variable and fit the data type. The sequence of the variables is irrelevant.
Example: Basic structure of an XLSX file (without translated displayed names)
A | B | |
---|---|---|
1 |
||
2 |
|
|
3 |
|
|
4 |
|
|
5 |
|
|
6 |
|
|
7 |
|
|
8 |
|
|
9 |
|
|
10 |
|
|
11 |
|
|
Example: Basic structure of an XLSX file (with translated displayed names)
A | B | |
---|---|---|
1 |
||
2 |
|
|
3 |
|
|
4 |
|
|
5 |
|
|
6 |
|
|
7 |
|
|
8 |
|
|
9 |
|
|
10 |
|
|
11 |
|
|
Instances and their configuration variables
Instances are introduced with a Header. The name of the instantiable Typical is contained in column A, followed by the configuration variables in the subsequent columns. The instantiable elements including their values for the configuration variables are contained in the rows below the header. A block of instantiable elements must be completed by a blank line.
A | B | C | |
---|---|---|---|
1 |
|||
2 |
|||
3 |
|
|
|
4 |
|
|
|
5 |
|
|
|
6 |
|||
7 |
|
|
|
8 |
|
|
|
9 |
Note
The introductory header is displayed in bold in the table only for clarification. In general, formatting has no influence on the processing of an XLSX file by the Project Builder.
Example: Structure of an XLSX file for the configuration of instances (without translated displayed names)
A | B | C | |
---|---|---|---|
1 |
|||
2 |
|||
3 |
|
|
|
4 |
|
|
|
5 |
|
|
|
6 |
|
|
|
7 |
|||
8 |
|
||
9 |
|
||
10 |
Export a configuration as an XLSX file
- Click Export *.xlsx.
- Enter the name and a storage location.
- Click Save.
- The configuration made in the Project Builder is exported as an XLSX file.
Tip
Your last executed action is saved. You do not carry out a selection via the dropdown icon again to repeat the action.
Import a configuration as an XLSX file
- Click Import *.xlsx.
- Select a file.
- Click Open.
- The configurator is enriched with the information from the XLSX file.
Note
- The specifications in the XLSX file for designation, type and value of a configuration variable must match the elements in the configurator. If the specifications do not match, you receive a corresponding error message. The import will continue if possible.
- The specifications that were already made in the configurator and are not contained in the file to be imported remain in the input mask of the Project Builder even after the import. During an import only the first worksheet of a XLSX workbook is considered.