| Document number | Revision |
|---|---|
| DOCU12218 | 1 |
Export (User Guide)
Export (User Guide)BackgroundIntroductionExport interfaceExport propertiesExport profilesFolder settingsInclude/Exclude subtypes and extensionsSave selection settingsStatic file listItem selectionData columnsFile listProcedureExported items and file content
Background
This article introduces you to the advanced capabilities of exporting item lists, properties and files from Highstage.
Here you will learn:
- How to take advantage of the available settings for exporting items, properties and files.
- How the selection behavior allows for you to select specific items and files for export.
- What is included in an export, and how those files can be accessed.
Introduction
Using the Export feature allows you to export the structure, data, and files from items into folders, ready for external use outside of Highstage.
You can use Export from any item in Highstage by navigating to Options > Advanced > Export (export documentation):
Note! Export* requires one of the following user levels to be accessible: AdvancedUSer SuperUser AdminRead AdminWrite.
Clicking Export will treat the current item as the Parent item and show all referenced items as children items, also available for export:
The list of available items for export is all referenced items to the parent item, from which you clicked Export. This makes it easy to export, for instance, a BOM (Bill Of Materials) of all parts and documents associated with a product.
Export interface
Clicking Export presents you with various settings and the full list of items, files and properties available for export:
Export properties
Export properties provides you with a brief overview of the current Export status.
From here, you are presented with the following export properties:
- Type The subtype of the parent item
- Object The item ID of the parent item
- Item count The total number of selected items for export from the Item selection list.
- Files selected The total number of selected files for export from the File list.
Export profiles
An Export profile allows for you to select a pre-configured export profile. This profile can contribute with the following preconfigured settings:
- Automatic selection of items and files An export profile can be reconfigured to automatically select/deselect items based on it's subtype. Similarly, files from the file list can be automatically selected/deselected based on it's file extension.
- Selection behavior A selection behavior profile can be associated with an Export profile. This configures certain restrictions for selecting items and files for export. The following selection behaviors can be enabled for each Export profile:
| Mode | Description |
|---|---|
| 0 | Select/deselect individual items and individual files for export |
| 1 | Selecting/deselecting a parent item also selects/deselects the associated files and the children item and files. Selecting/deselecting a child item also selects/deselects the parent items and files. |
| 2 | Selecting/deselecting parent items also selects/deselects children items and files. |
| 3 | Selecting/deselecting children items also selects/deselects the parent items and files. |
- Security measures An Export profile can be configured to only be available to users with specific user levels. Thus, a number of profiles might be available or unavailable to you depending on your set Highstage user level.
- Express export An Express Export profile can be configured so that users with a specific user level, or lower, are not allowed to view and select/deselect items and files for export. Export is still available, but no items or files are available for selection. The item and file selection and settings for this export are pre-configured.
Notice!
For more information about your available Export Profiles and it's configuration, please contact your Highstage administrator.
Folder settings
The Folder settings has two available drop down menus:
Folders
Select whether the selected files should be separated into folders that are associated with each item or merged in a single folder.
Zip/Folder Select whether the exported files should be exported only as a Zip folder or exported as a Zip and regular folder.
Include/Exclude subtypes and extensions
These settings makes it possible to easily select and deselect items and files of certain subtypes and extensions.
From these settings, you can:
- Select or deselect items in the list with specific subtypes.
- Select or deselect files in the list with specific file extensions.
All available subtypes and file extensions from the listed items and files are automatically listed here for easy 'bulk' selection.
Save selection settings
A user with a specific user level can access and save an explicit selection of items and files by clicking Save settings. This saves the current selection of items and files for export.
When users with lower user level selects the specific export profile where the selection was saved, these pre-selected items and files are selected by default.
The pre-selection can be reset by clicking Reset Settings*.
Static file list
A static file list, is a list of items and files that has been configured to be part of the available export items for a specific Export Profile. These static files are used as a supplement for the export profile and can consist of any items (parts, documents etc.) which is related to the export profile.
These static files can, for instance, contain instructions or descriptions for external stakeholders regarding the exported selection of items and files.
Notice!
For any information regarding static files for your available export profiles, please contact your Highstage administrator.
Item selection
The Item selection column contains the full list of items available for export. In this column, you can visualize the full 'tree-view' of parent items and referenced child items.
It is in this column that you manually select and deselect items for export.
Notice! Take note that each export profile can have different selection behaviors . Read more about the available selection behaviors here.
Data columns
The data columns provides you with an overview of item properties for the items available for export.
Important!
It is important to note, that the listed item properties are not necessarily the properties that are exported. For any questions regarding which item properties are exported for a specific Export profile, please contact your Highstage administrator.
File list
The file list column contains the full list of files that are associated with each item. Here, you can select or deselect available files associated with an item to be included in the export.
Notice! Take note that each export profile can have different selection behaviors . Read more about the available selection behaviors here.
Procedure
This process describes the procedure of exporting items and files from Highstage.
- Navigate to any item in Highstage:
- Ensure that you have the required user level enabled to gain access to the Advanced options. Export is available for AdvancedUser, SuperUser, AdminRead and AdminWrite level users:
Clicking Advanced>Export (export documentation) opens the Export feature in a new tab in your browser:
- As a standard, the default export profile is selected. Select an appropriate Export profile and files and items from the item list view to be exported:
- Clicking Export in the top right corner, will export the selected items and files.
A confirmation will be prompted. Clicking OK will export the selected items and files. Once completed, a link for download is made available in the export window:
- The files are placed in the folder of the item, from where you accessed the Export feature:
Exported items and file content
Depending on the configuration of the Export Profiles, a number of files are exported:
By default, a folder containing all exported files are outputted.
In addition, a number of additional .html, .pdf and .xlsx files containing the list of items and item properties can be outputted.
From our example, the exported .PDF contains the following item properties:
Similarly, the exported .xlsx contains the following item properties:
Notice ! The item properties, file names and file types of the exported files are all dependent on the configuration of the used Export profile. For any questions regarding the outputted files and their content, please consult your Highstage administrator.
