This section explains the difference between configuring exports at regular intervals for all or selected data of your platform as well as the export functionality integrated in to widgets, such as the “data point table” widget, where the export functionality allows you to export the data from selected data points at the current moment.
The export functionality lets you export specific data to either CSV or Excel files.
ROLES & PERMISSIONS:
With this feature, you can request data for the whole tenant. Additionally, you can choose to filter for specific devices, time ranges or fields. The export data contains information about all specified filters and enabled fields.
To show all exports, click Export in the Configuration menu in the navigator.
In the Export page you will find a list displaying all exports with their names, file type and time range.
Click Add export in the top menu bar.
Enter a name for the export and select the file type (CSV or XLSX) for the report output.
Filters
In the Filter section, you can select filters to request object- or time-specific data.
To filter for a particular object, enter a name or property value into the search field and click the search icon . All matching devices or groups will be displayed below the Value field. Click an object to select it (highlighted in green).
The Time range filter can filter data for a specific time range. Select a time range from the dropdown field. All times assume platform system time (UTC).
Select the Object to export and Time range checkboxes to enable the respective filters.
Fields
Apart from object- and time-specific filtering you may filter data for specific fields:
Use the toggle to enable/disable a field.
When a field is enabled, predefined or empty properties can be added.
Click Add to add empty properties. To enter a label or path, click Column or Path and edit the field. For example, if you enable the Alarms field you could enter “Severity” in column and path to receive data for alarm severities.
Click Add predefined, to add predefined properties. Simply select the desired properties from the list and click Select. Use the search field at the top to search for a specific property.
If you have at least one field that is not originating from the “Add predefined” list but defined as a custom property, then you must set up at least one property for the custom values to appear in the export.
Example:
An export has 4 fields defined: time range, device name, type and c8y_SpeedMeasurement.speed.value. The first 3 are predefined properties, while the last one is a custom property. If any measurement for export does not have a custom property c8y_SpeedMeasurement.speed.value, then it will not appear in the export file.
If your field is a valid.key.with.dot then refer to it as [‘fragment.key.with.dot’] in the path, for example: [‘fragment.key.with.dot’].series.value
In case of measurements enabled, you can also select Add from data point. For details on how to add data points see To add a data point.
JsonPath expressions added from data points will be stored in bracket notation in order to increase the flexibility in fragment and series naming (for example whitespaces will be supported):
To schedule an export to a CSV or XLSX file to any point in time, open the respective export and click Add schedule at the bottom.
In the resulting dialog box provide the following information to receive the scheduled export via email.
1 - Frequency
Select the frequency for sending the export from the dropdown list, that is, every hour, day, week, month or year. Depending on the frequency selected, provide additional timing information. For example, if you have selected “every month”, provide the day of month, hour and minute.
2 - Send email:
Complete the email information.
In the Send to field, provide the email address of the recipient. This field is mandatory. Optionally, you can provide email addresses for recipients of copies (CC) or blind copies (BCC). Use comma as separator to enter multiple recipients.
Optionally, add the email address of the sender for reply.
Specify the subject of the email. This field is pre-filled, but may be modified.
Enter the actual email message. Available placeholders are {host}, {binaryId}. The default value is “File with exported data can be downloaded from {host}/inventory/binaries/{binaryId}”. Note that to create a clickable link in the email, you must add “https://” to the link. For example: “A file with exported data can be downloaded from https://{tenant-domain}/inventory/binaries/{binaryId}.”
Content-Type header.Click Create to create the new export schedule.
The export schedule will be added to the export details.
With version 10.6.2, a new report agent has been implemented to allow scheduled exports. The export schedules functionality based on smart rules has been deprecated.
On opening a report, all scheduled exports based on smart rules are automatically migrated to the new report agent, while displaying a message informing the user about the process.
To export data to a CSV or XLSX file, select the checkbox in front of the respective row in the list and at the left of the top menu bar click Export.
You will receive an email containing links to each export file.
Standard time properties (like time or creationTime in alarms) are exported to the XLSX and CSV files following the date and time format representation defined in ISO-8601.
When the export documents limit is reached and the result is truncated due to its limitations, an additional line with an indicator is added at the end of document.
Sample CSV export with indicator:
Time,Device name,Creation time,Device name,ID,Source,Text,Time,Type 2021-11-25T10:37:06.485Z,Position #1,2021-11-25T10:37:06.485Z,Position #1,1266,1195,Location updated,2021-11-25T10:37:06.485Z,c8y_LocationUpdate 2021-11-25T10:37:01.484Z,Position #1,2021-11-25T10:37:01.484Z,Position #1,1265,1195,Location updated,2021-11-25T10:37:01.484Z,c8y_LocationUpdate […] limit exceeded!,result truncated!,limit exceeded!,result truncated!,limit exceeded!,result truncated!,limit exceeded!,result truncated!,limit exceeded!
Just click the respective row or click the menu icon at the end of the row and then click Edit.
For details on the fields see To add an export.
Click the menu icon at the end of the row and then click Delete.
While the export functionality itself is a standalone feature, you can combine it with other features that allow you to select data points. To use the export functionality in this way, you must integrate it in the respective feature, for example, the Data points table widget.
ROLES & PERMISSIONS:
The following example shows you how the export functionality is integrated with the Data point table widget.
Click the export icon at the top right of your data point table:
You see the Generate export dialog window, which allows you to configure the export further in the following categories:
Click the Download button. The download results depend on your chosen export mode.
The export functionality integrated in a widget offers you a number of export modes:
When you have selected the Full export mode for a data point that contains more than one million records (our processing limit), the download option is disabled. To proceed with the export, you’ll need to reduce the number of records by narrowing the time range. Until the number is reduced, you will see a warning message.
If you select multiple data points for export in the Full mode and one or more individual data points exceed the one million record limit (per data point), narrow the time range to reduce the number. Data points within the limit are not affected.
In this case, you will see a detailed informational message describing how many data points are affected and why. The message is dynamic and may include the following details: