Exports can be created and edited via the ITscope platform.
A limit of exportable products applies for each data export.
The export is always carried out upon explicit request, either manually through the export management or via the ITscope API. It is not possible to specify an export schedule.
The export management section of the platform can be opened via the 'Exports' menu item on the navigation bar. All data exports from your company are listed in the export management. A history of all exports that have been carried out is displayed on the right (9). Here you can see status, date, name, API version, file format and the number of products involved in the export. Clicking on one of the exports in the history list will show additional information about the export, such as the Log ID for support purposes.
A new export definition can be created with the button "New Export" in the header area (1). Existing export definitions are displayed in a list depending on selected sort criteria (2). Clicking on a line in the list (3) will open or close the export definition. One of the most important functions of an export definition is to specify the product selection (4).
Exports marked with a warning symbol have been incorrectly defined in some way. This means important information is missing which is preventing correct execution of the export, for example a missing or invalid product selection.
An export definition determines which products are to be exported in which format.
For each export, there is a line (3) in the overview that contains all information identifying the export. In addition, the export can be started manually using the download button (5). The 'Share' button (5) provides a URL link that can be used to retrieve the export via the API. This URL contains the unique identifier of the export, among other things.
The export line (3) can be expanded by with a click. The export definition can then be edited in the expanded area.
An export definition consists of the name, the product selection and the data format. The export ID (8) is used to uniquely identify the export, for example it is contained in the download link for an API call. The person initiating the export is also named for each export. There is also a button for deleting the export definition.
Set product selection
Each export must contain a valid product selection (4). The product selection determines how the products to be exported are chosen out of the whole product range.
In the detailed (expanded) view of the export definition, an existing product selection can be selected, an assigned one edited, a new one created or an existing selection removed.
For a newly created export definition, no product selection has been entered yet. A selection box allows you to choose from a list of previously created product selections. For the very first export, no product selection will have been created yet. Therefore, a new product selection has to be added first by clicking on the button 'Create' to the right of the selection box. If a new product selection is created or an existing one is edited, then the product selection will open in a separate tab within the export management. The process of defining a product selection is described in the section 'Edit product selection'.
If a product selection has been assigned, the name of the product selection is displayed instead of the selection box, and there will be an edit icon to the right. The edit icon will open the definition of the product selection. To remove an existing selection, click on the 'x' next to the name of the product selection. Afterwards the selection box will be visible again, allowing another product selection to be assigned or a new one to be created with the 'Create' button.
Set data format
The API version can be set in the 'Data profile and file format' section (6). Depending on the API version, different data profiles are available. There are differences in the data profiles and export fields between API 1.0 and API 2.0.
The data profiles of the API 2.0 and API 2.1 have not changed, but there are differences in the respective fields contained in the data profiles.
The product export can be delivered in varying data profiles. The available data profiles (Standard, Standard - price/availability update, Developer, Developer - price/availability update) and file formats (JSON, XML, CSV) are offered in selection boxes.
The choice of data format determines which fields appear in the export. Fields cannot be selected individually. The formats are designed to output all fields relevant for the respective case.
Set additional content
The content data (mainly texts) in the export can be exported in different languages (7).
The following six languages are available:
Please note that depending on the data format, the following rules apply:
- standard - only one language selectable at a time
- standardUpdate - only one language selectable at a time
- developerUpdate - only one language selectable at a time
- developer - up to six languages (i.e. all languages) selectable.
The check boxes below the language selection (7) allow further configuration of export contents:
- Include long text: this option is used in the export to fill the htmlSpecs (HTML datasheet) and marketingText (marketing texts) text data fields with content. Since these texts can be very large, it is possible to deselect them separately in order to reduce the file size of the export.
Currently, there are three ways to start an export:
- Directly on the platform in the export definition via the download button, which will download the export directly in the browser. This variant is self-explanatory and mainly serves to check the export.
- The API can retrieve the export via the URL link. This URL link can be accessed by clicking on the 'Share' button in the export definition.
- By programming an API call to automatically initiate an export.