Create and change exports via the ITscope platform.
For each data export is a limit of exportable products available
The export describes what is exported. The export is always executed explicitly, either manually in the export management or via the API. There is no place on the platform where a schedule for exporting can be specified.
In the main menu "Products" the entry "Exports" opens the export management. In the export management, all exports of the company are listed on the left-hand side. A history of all exported exports is displayed on the right (9). Here you see the status, date, name, API version, file format and the number of products of the export. Clicking on the border will show it.
In the header area, the button is used to create a new export definition (1). Existing export definitions are displayed in a list according to the selectable sort criterion (2). Clicking on a line (3) opens the export definition. The most important specifications of the export definition are the selection of the product selection (4).
Exports with a cloud symbol are defined in some way incorrectly. Important information is missing, which prevents correct execution, 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 to identify the export. In addition, the export can be started manually using the download button (5). The share button (5) also provides a URL that can be used to retrieve the export via the API. This URL contains, among other things, the unique identifier of the export that is required for retrieval.
The export line can be expanded. The export definition can be changed in the expanded detail area.
An export definition consists of the name, the product selection and the data format. The export ID (8) is used to identify the export, for example, it is specified in the download link for the API call. The producer is also named for each export. This also contains the button for deleting the export definition.
Define product selection
Each export must contain a valid product selection (4). The product selection determines how the products to be exported are determined from the total quantity of all products.
In the detail area of the export definition, you can select an existing product selection, edit an assigned one, create a new one, or remove an existing assignment.
A product selection has not yet been entered for a newly created export definition. A selection box allows you to select one from a product selection already made. At the very first export, there is no product selection, so a new one must be created at the right of the selection box. If a new product selection is created or an existing product is edited, the product selection opens in a separate tab within the export management.
How to define a product selection is described in following article: "edit product selection".
If a product selection has been assigned, its name is displayed instead of the selection box and the icon to the right changes to an editing icon. The edit icon opens the definition of the product selection. To remove an existing selection, click on the 'x' next to the name of the product selection. The selection box is then again visible, with the aid of which a different product selection can be assigned or a new one can be created via the new installation symbol.
Set the data format
The products to be exported can in different formats are supplied (6). The available data formats are offered in a selection box.
The selection of the data format also determines which fields appear in the export. Fields can not be selected individually. The formats are designed to output all relevant fields for the respective case.
Currently, there are three ways to start exporting:
- Directly on the platform in the export definition via download button to download the export in the browser. This variant is self-explanatory and mainly serves to check the export.
- The browser displays the API via the URL. You can find the link URL by clicking gap can be in the export definition per share button display.
- Programmatically via API call set an automate export trigger.