The Export module allows accessing the data that the loyalty program generates. Administrators is stored in Antavo’s database. Backoffice administrators can generate reports to get an overall view of their the 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.

current needs. When creating the export file, the module configuration interface provides options to add data fields and apply filters.

Find the configuration page of the module by typing 'Exports' into the search bar of by opening the Modules menu and searching for the ‘Export’ module in the list. The page opens up to a list of existing reports generated by administrators.previously created exports with the following information:

...

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 created the export linked to their profile page.

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

• Target
  File transfer option selected when the export was created (FTP, FTP over SSL, or SFTP). If no target is defined, the export file is only accessible through the Backoffice.

• 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

...

• .

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

Creating a new export

...

• Click the ‘Create new export’ button on the left sidebar

...

Data model

First, select the data model to export. The following models are available:

• Challenges

• Changes

• Content approval

• Coupons

• Coupon pools

• Customers

• Customer fields

• Events

• Products

• Rewards

• Stores

• Webhook logs

...

• Image Added

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

...

Configuring an export

...

• .

Localization

• Name
  Set the name of the export.
  The downloadable export file inherits 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 separatelythe export.

• Select the timezone
  Time-related settings will be handled based on the selected timezone.
  The timezones of the brand and the current Backoffice user are highlighted at the top of the dropdown list.

  

Filters

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

• Attribute – drop-down listDefine the filters to be applied (mandatory)

  • Attribute
    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

  • You can use any built-in and custom attributes that are listed at the bottom of the editor page.

  • Operator
    Select the logical operator of the filter. The list of available operators depends on the type of attribute selected.

  • Value
    Define the filter value. Depending on the type of the attribute field, the input field can be:

    • free-text field - 'date:' expressions can be used and capital letters should be considered when using the ‘Equals’ operator

    • dropdown list

    • date selector(s).

The editor lets you combine the filters. The following options are available:

• and

  AND – adds

  a

  new criteria within the same set of filter criteria
  All filter criteria within

  the same filteringor

  one set have to be true to have the item added to the export file.

• OR – adds a new set of criteria

  in a separate filteringImage Removed

Aggregation

...

• 
  Any of the added sets of criteria have to be true to have the item added to the export file.

...

Aggregation

Tick the ‘Aggregation’ checkbox to display a calculated or grouped value of the data in the export file instead of separate values in the export.

Field settings

In case you wish to export customers, rewards, stores, etc. with all fields, check a separate value for each item. The specific aggregation mechanism is to be set up in the next step under Field configuration.

...

Field settings

If you’d like to add all the fields of the data model to the export file, tick the ‘All fields’ box.

Otherwise, use the ➕  icon and select a field from the drop-down list to add new data to the exportselect one of the available fields to be added to the export through the ‘Field’ dropdown list and click the  icon.

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 arrow down-button to go back to editing the field settings.

...

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

Field configuration

• 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.

Aggregation type

If you have checked the Aggregation checkbox in the Filters section, you will see a dropdown list at the bottom of each field to select the type of aggregation. This is a mandatory field to fill.

...

The aggregation types are the following:

Group
Use this option to define group ID values in the report.

...

• 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 (eg. if the customer ID is added, the data in the export will be aggregated per each individual customer).

  • Count
    Use this option to retrieve the number of individual entries in

...

• • the report.

...

• • 
    Please note that 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

...

• • accumulated number of all numeric values of the data fields.

  • Average
    Use this option to retrieve

...

• • the average value calculated from all the values of the items in the report.

...

• • Min
    Use this option to retrieve the lowest

...

• • value of all the attribute values in the report.

  • Max
    Use this option to retrieve the highest

...

• • value of all the attributes value in the report.

...

...

File extensions

Choose You can select between .csv and .psv file extensions.

For challenge exports, only the .json file format is available.

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.

...

* not applicable to .psv and .json files

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 the export can be scheduled based on UTC timezone by selecting the On‘On-date date’ or Repeated values ‘Repeated values’ in the dropdown list.

• On-date
  The export will start on a predefined date and time.
  Use It is possible to enter 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.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

  start

  • be created.

  Image Removed
  • Image Added

  • Weekly
    Select the day(s) of the week and set the time of the day.

  Image Removed
  • Image Added

  • 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.

  Image Removed
  • Image Added

Update Target

...

Upload target

You have the option to download the export file from the Backoffice or to select a transfer option to get the export file uploaded to a server directly.

Use the ‘Type’ field to decide how you’d like to access the file.

• None
  By choosing Select this option , you will be able to download your export file directly from the Backoffice through your browser.

• FTP

• FTP over Secure Sockets Layer (SSL)

• SFTP
  Users can create and save multiple exports a day with unique automatically generated file names.
  Antavo currently only Please note that currently, Antavo supports password-based authentication for its SFTP export functionalityonly.

After selecting an option, fill out the details in the fields that appear.

The export process for all terminal server types requires the following information: host, port, username, password and path (containing the filename).

...

Lastly, you one of thefile transfer options, you need to populate the following fields:

• Host

• Port

• Username

• Password

• Path (contains the file name)
  You create and save multiple exports a day with automatically generated unique file names.

• 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. 

...

Fields

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.

...

...

Export page

After applying the filters and fields, click on the ‘Create’ button to start the export process.This navigates the export has been created, you are automatically navigated to the export page to track the status of the export . 

...

When which is visible in the upper right corner. You can reach this page anytime from the Exports list by clicking the ‘Details’ button of the export.

Fields

The ‘Fields' section displays the fields included in the export with the ‘From’, ‘To’, 'Default’ (if any) values of the fields.

...

Download exports

If you have selected the download option ('None') under the Upload target section of the configuration page, you can download the file on the Export page when the status of the export changes to ‘Finished’, the Download hyperlink .
The ‘Download’hyperlink appears under the summary of the export criteria. Click on the hyperlink this link to download the compressed file to your device.

...

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

...

You will receive an automatic email as well with the link to download the export file.

...

Clone an export

Cloning allows repeating an existing export without having to create a new configuration from the beginningscratch. 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. identify differences.

• Navigate to the Exports

...

• page to open the list of exports

...

• Click

...

• the ‘Details’ button of the export that you wish to clone

...

...

• Click

...

• the 

...

• 'Clone' button in the upper right corner

...

The settings of the export appear.

...

• Click the ‘Create’ button to start the new export process
  If necessary, you can modify any setting of the export before clicking ‘Create’.

Sorting and searching for exports

Use the search bar on the top of the Exports page 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 the export name or creation date.