This section describes the fields and available options when exporting to an Excel file. Note that options vary slightly depending on whether you started the export from a dataset, or table Actions menu. Exporting from a dataset allows you to export one, or more tables—each table added to a sheet. Whereas, exporting from a table only creates a single sheet in the exported file.
To avoid issues during export of a large Excel file, please use only the default options and do not activate the Include validation messages, Export related data, or Export permalink for the primary or foreign key options.
After running the export service, you are presented with several pages. Follow the links in the descriptions below for detailed information on each page:
Configuration page—The options here determine basic configuration information.
Table mapping page—This page allows you to map the tables in the dataset to those in the Excel file. You will only see this page when initiating import from a dataset's Actions menu.
Column mapping—This page allows you to map the columns from tables to those in the Excel file.
Results page—This page shows you the export results.
This page allows you to modify behavior of the export. Part of the modification can include specifying Java classes to transform, or validate data. This page contains the options shown in the following table:
Property/Field/List | Definition |
|---|---|
| File name | Name of the exported file. |
| Preference | All table columns will be exported based on configuration and mapping defined by the selected export preference. |
Save as type | Use this option to specify whether the first row of every column in the file being imported is a label (Header), or contains data to import (No header). |
| First row contains header | Use this option to specify whether the first row of every column in the file being imported is a label (Header), or contains data to import (No header). |
| Disable write access lock | Specifies the write access lock on the dataspace while exporting. If 'No': The dataspace is locked and the export is executed inside the read only procedure. If 'Yes': The export is executed outside a procedure and users have write access on the data space while exporting. Default value: 'No'. Note that this property is only visible when enabled through dataspace preferences by an administrator. |
| Export the ignored field as a blank column | Specifies whether the ignored field will be exported as a blank column. This option is only available on Excel export. |
| Include validation messages | Specifies options to include different severity levels of validation messages in the export. |
| Primary key | When set to 'Export label', the exported file will contain an information column with the label of the primary key. When set to 'Permalink', the exported file will contain a permalink for the primary key. |
| Foreign key | When set to 'Export label', the exported file will contain an information column with the label of the foreign key. When set to 'Permalink', the exported file will contain a permalink for the foreign key. |
| Include computed values | Specifies whether computed values must be included in the export. |
| Include the reference sheet | You can add a reference sheet called 'Reference table mapping' at the end of the Excel file. This sheet contains metadata such as the sheet name, the table label and the table path used to detect the mapping between sheets and tables upon import. |
| Choose the tables to export | The selected tables will be exported into multiple sheets in the Excel file. |
| Extensions | Specifies the Java class that is implemented to transform data during import/export processing. |
This page allows you to modify behavior of the export. Part of the modification can include specifying Java classes to transform, or validate data. This page contains the options shown in the following table:
Property/Field/List | Definition |
|---|---|
| File name | Name of the exported file. |
| Export view | Specifies the table's view to export. Only data contained in the view is exported. |
| Preference | All table columns will be exported based on configuration and mapping defined by the selected export preference. |
Save as type | Use this option to specify whether the first row of every column in the file being imported is a label (Header), or contains data to import (No header). |
| First row contains header | Use this option to specify whether the first row of every column in the file being imported is a label (Header), or contains data to import (No header). |
| Disable write access lock | Specifies the write access lock on the data space while exporting. If 'No': The dataspace is locked and the export is executed inside the read only procedure. If 'Yes': The export is executed outside a procedure and users have write access on the data space while exporting. Default value: 'No'. |
| Export the ignored field as a blank column | Specifies whether the ignored field will be exported as a blank column. This option is only available on Excel export. |
| Include validation messages | Specify options to include different severity levels of validation messages in the export. None: The exported file will not include any validation messages. Info: The exported file will include any information messages. Warning: The exported file will include any warning messages. Error:The exported file will include any error messages. |
| Export related data | Specifies whether the export includes related data. The add-on exports a single Excel file. The first sheet in the file contains the source data (where the service was run from). Each additional sheet contains related data from individual tables. When you select:
|
| Primary key | When set to 'Export label', the exported file will contain an information column with the label of the primary key. When set to 'Permalink', the exported file will contain a permalink for the primary key. |
| Foreign key | When set to 'Export label', the exported file will contain an information column with the label of the foreign key. When set to 'Permalink', the exported file will contain a permalink for the foreign key. |
| Export enumerations | This option allows you to determine behavior when exporting enumerations. The Export label option inserts an additional column in the exported file. This column contains the enumeration value labels. The Export static enumerations option exports the normal column, but modifies it to include a drop-down list of enumeration values defined in the data model. If you select both options, both columns will contain a drop-down list of available values. |
| Include computed values | Specifies whether computed values must be included in the export. |
| Extensions | Specifies the Java class that is implemented to transform data during import/export processing. |
| Table template tabs | |
| Title template | These settings determine the title's starting position and text style in the exported Excel file. |
| Subtitle template | These settings determine whether to export with a subtitile and its starting position and text style in the exported Excel file. By default, no subtitle gets exported. |
| Table border | This setting determines whether to use a border for data exported to the Excel file. By default, a border is not included. |
| Column title template | These settings determine the header's starting position and text style in the exported Excel file. |
| Data template | These settings determine the starting position and text style of data exported to the Excel file. |
This page displays when exporting from a dataset and allows you to map the source tables with the target sheets in the Excel file.
The source tables and target sheets display on the left and right, respectively. The icon between the lists allows you to use, or ignore a table during export. All used tables will require a column mapping.
The View dropdown menu allows you to select a view to export. Only data contained in the view is exported.
Below the mapping configuration information, the Save preference group allows you to save the mappings as a reusable preference. Just tic the Create new preference called radio button and enter a name in the field.
This page allows you to map source table columns with columns in the exported Excel file. When starting this export from:
A table: Use the drop-down list next to each table column to specify which source gets mapped to which target. Below the mapping configuration information, the Save preference group allows you to save the mappings as a reusable preference. Just tic the Create new preference called radio button and enter a name in the field.
A dataset: In addition to the options described in the previous bullet, a list of tabs displays that allows you to select and edit mappings for each table.