...
...
...
...
The User Manual has moved! For the most up-to-date information, please visit our new site at docs.antavo.com.
We're committed to providing you with the best resources, and our new site offers an enhanced experience with the latest documentation. Thank you for your understanding and continued support.
The Exports module allows accessing the data that is stored in Antavo’s database. Backoffice administrators can generate reports to get an overall view of the data of customers, coupons, or stores – among others – tailored to their current needs. When creating the export file, the module configuration interface provides options to add data fields and apply filters.
...
Tick the ‘Aggregation’ checkbox to display a calculated or grouped value of the data in the export file instead of a separate value for each item. The specific aggregation mechanism is to be set up in the next step under Field configuration.
| Expand | ||
|---|---|---|
| ||
|
...
Field settings
If you’d like to add all the fields of the data model to the export file, tick the ‘All fields’ box.
...
Each field added to the export populated populates a separate column in the export file.
...
From
The ‘From’ value is automatically populated from the ID of the field selected and cannot be modified.To
The name of the field in the column header of the export file.
If no ‘To’ value is added, the export will add the field to the header with the same name as it is in Antavo.Default
This value will be added to data cells where the field value of the individual entity is empty.Replace values
You can decide to overwrite certain data values that are stored in the database with a new value in the export file (eg. replace all ‘female’ values in the Gender customer field with ‘ladies' or replace ‘14’ values in the Age customer field with ‘underage’).
Use the ‘Value to replace’ and ‘New value’ fields to define which value should be replaced and the target value added to the export.
To map more than one value, click the ‘Add new field’ button.Aggregation
This mandatory setting is available if the ‘Aggregation’ option has been enabled in the previous step.
Please note that computed fields cannot be aggregated. If you’re unsure if the field is a computed field, check the editor interface of the field (Events, Customers) or consult the Antavo Service Desk.
Use the dropdown field to select one of the available aggregation methods:Group
At least one field has to be marked as ‘group’, which defines the field that will serve as the base of aggregation. Please note the ‘group’ option cannot be selected for identifier fields (eg. customer ID).Count
Use this option to retrieve the number of individual entries in the report. This method counts the number of entries, not the fields.
Please make sure you add only one field with ‘count’ aggregation option.Sum
Use this option to retrieve the accumulated number of all numeric values of the data fields.
Please note that this aggregation type is not applicable to non-numeric fields.Average
Use this option to retrieve the average value calculated from all the values of the items in the report.
Please note that this aggregation type is not applicable to non-numeric fields.Min
Use this option to retrieve the lowest value of all the attribute values in the report.
The Min value of string-type fields is calculated based on alphabetical order. If there’s an empty field, it is always considered the Min aggregated value.Max
Use this option to retrieve the highest value of all the attributes value in the report.
The Max value of string-type fields is calculated based on alphabetical order.
...
You can select between .csv and .psv file extensions.
For challenge exports, only the .json file format is available.
...
On-date
The export will start on a predefined date and time.
It is possible to enter the date and time schedule manually, but you can also use the date and time selectors by clicking the
and icons.Repeated
Select this option to set the data export to be triggered periodically. Each time the new export will be added to the list on the Exports page.Daily
Set the time of the day when the export should be created.
You can define multiple values in both fields by using a comma (,) to separate the values (eg. configuring the ‘Hour’ field with ‘1,13’ value would run the job twice a day, at 1 am and 1 pm).Adding * will trigger the execution of the job at every minute/hour.
Weekly
Select the day(s) of the week and set the time of the day.
Monthly
Select the day(s) of the month and set the time of the day.
You can use the ‘Last’ value to make sure the export is started on the last day of the month, regardless of the number of days in a given month.
| Info |
|---|
Scheduling of previously configured exports may be modifiable after being created, please find detailed information below. |
...
Host
Port
Username
Password
Path (contains the file name)
You create and save multiple exports a day with automatically generated unique file names.can have multiple export files generated with unique file names by using placeholder values. Find the placeholder values that you can use listed under the configuration field.
eg. If you add/upload/exports/Antavo_EventCounts_%Y%m%dpath name, the '%Y%m%d' placeholder is replaced with the current date, generating file names according to the date when the export runs (eg. Antavo_EventCounts_20230623.csv or Antavo_EventCounts_20230714.csv).Create archive
You have the option to request a compressed archive of the output file by ticking the ‘Create archive’ checkbox.
...
Don’t forget to click ‘Create’ after setting each required field to start the export process. Also, you are automatically navigated to the View tab after clicking the ‘Create’ button when adding a new export.
Fields
HOL VAN The list of exportable fields varies for each data model. The following table provides the name of each field, along with its data type, possible values, whether it is mandatory, and a brief description.
...