The Export module allows accessing the data that the loyalty program generates. Administrators can generate reports to get an overall view of their data of customers, coupons, or stores – among others – tailored to their actual requirements. The Export module enables them to define the content of the export using several kinds of fields and filters.

This chapter contains descriptions of the different export functions and instructions on how to create and configure exports on the Antavo loyalty platform.

Find the configuration page of the module by typing 'Exports' into the search bar of the Modules menu. The page opens up to a list of existing reports generated by administrators.

This page displays a list of exports created previously including the following information:

• Name
  Name of the export.

• Created at
  The date when the export was requested.

• Created by
  The Backoffice user who requested the export.

• Model
  This refers to the data type that the export contains.

• Status
  The system works with the following statuses:

  • Pending – the setup of the export is saved, but the export process has not started yet

  • Processing – the export process is in progress

  • Finished – the export process has finished, and the export is ready for download

  • Failed – the export process has failed. Please contact the Antavo Service Desk for further information if the issue persists.

• Filesize
  The size of the export compressed file in bytes.

Sorting and searching for exports

Use the search bar on the top to search for specific files in your brand’s export history.

Click the ‘Name’ and 'Create at' column header to sort the exports based on name and create date.

Creating a new export

To start creating a new export, click the ‘Create new export’ button on the left sidebar.

Data model

First, select the data model to export:

• Changes

• Content approval

• Coupons

• Coupon pools

• Customers

• Customer fields

• Events

• Products

• Rewards

• Stores

• Webhook logs

Click the ‘Next’ button to continue with the configuration of the export.

Configuring an export

Localization

• Name
  Set the name of the export. The name of the downloaded file will be inherited from the name you provide here.

• Timezone
  The brand’s timezone and the user’s timezone are highlighted separately.

  

Filters

• Filters
  Different types of filters amend the reports and make the query results more efficient.

  • Attribute – drop-down list
    Select the property to include in the export.

  • Operator – drop-down list
    Select an action to include in the export.

  • Value - Free-text field or drop-down list
    Define the value relating to the action to be performed in the export.
    
    The system allows combining the filters. The following options are available:

    • and – adds a new set of criteria within the same filtering

    • or – adds a new set of criteria in a separate filtering

      

Aggregation

Aggregation enables the export of data to be grouped by basic aggregation operators. The aggregation will be applied to every field which is mandatory to be filled.

• Tick the checkbox to display a calculated or grouped value instead of separate values in the export.
  Add the required fields to the export. 

• Open the dropdown list at the bottom of each field to select the type of aggregation. This is a mandatory field to fill.

This can be set when creating or cloning an export within the Filters section. 

Group
Use this option to define group ID values in the report.
Note: At least one field should be marked as ‘group’, but more than one field can be specified. 

Count
Use this option to retrieve the number of entries in a group in the report.
Note: This counts the number of entries, not the fields. If more than one field is marked as ‘count’, the same count value will be produced in the report. 

Sum
Use this option to retrieve the total amount of numerical values in the report. 

Average
Use this option to retrieve an approximation of numerical values in the report. 

Min
Use this option to retrieve the lowest field value for each group in the report.

Max
Use this option to retrieve the highest field value for each group in the report. 

Field settings

In case you wish to export customers, rewards, stores, etc. with all fields, check the ‘All fields’ box.

Otherwise, use the ➕  icon and select a field from the drop-down list to add new data to the export.

Each field setting automatically appears as a row once you’ve added a new field, making it easier to keep track of them visually. Click the button to go back to editing the field settings.

Each field will populate a separate column in the export file.

File extensions
Choose between .csv and .psv extensions.

File format options

• Delimiter
  Select the character that separates data in the export file.

• Enclosure
  Select the character to group certain values into one data field.

• Newline
  Select an option to determine how to add a new line.

• No header
  Tick the checkbox to exclude the header row from the export file.

Scheduling

This option allows running the exports in a specified time and also set them as recurrent.

By default, the files are exported at the time of the request, however, exporting can be scheduled by selecting the On-date or Repeated values in the dropdown list.

• On-date
  The export will start on a predefined date and time.
  Use the date and time selector to specify the scheduled time by clicking on the icons in the Date and Time fields.
  It is also possible to enter the details manually.

• Repeated
  Select this option to set the data export to be triggered periodically.

  Daily
  Set the time of the day when the export should start.

  

  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.

  

Update Target

Select a file transfer option from the drop-down list to get the export file uploaded to a server directly.

• FTP

• FTP over SSL

• SFTP: SFTP users can create and save multiple exports a day with unique automatically generated file names.

Provide the details in the fields that appear after selecting an option.

Click Create after setting each required field to start the export process. 

Field list

Each data model has a different list of exportable fields. This table contains each field name with the data type, their possible values, whether they are mandatory, and their description.

Downloading an export

After applying the filters and fields, click on the ‘Create’ button to start the export process.

This navigates to the export page to track the status of the export. 

When the status of the export changes to ‘Finished’, the Download hyperlink appears under the summary of the export criteria.

Click on the hyperlink to download the compressed file.

Besides receiving the file in the Downloads folder on your computer, will also get an email with a link to the exported file.

Cloning an export

Cloning allows repeating an existing export without having to create a new configuration from the beginning. This feature is helpful for comparing the latest results with the data of a previous export to see the differences. 

You can also modify the settings by changing the filters and fields. 

Navigate to the Exports module which opens up the list of exports.

Click on Details of the export that you wish to clone.

Click on the Clone button in the upper right corner.

The settings of the export appear.

Click on Create to save the settings and start the export process.