Export Settings

The Export Settings area of the Behavioral Engagement Platform™️ is what you will see when configuring the file contents and delivery timing of your Exports.

The three primary areas that you will focus on when configuring these settings are as follows:

When configuring your Export, it is strongly recommended to understand the special circumstances in which exported data will be surrounded with quotation marks. Please read the Quotations section of this article for more information.

If you would like an overview of the settings, you can view the Export Settings Screen section of this article.

For usage, see the Tutorials section of this article.

Export settings can not be modified if it is currently Active


Table of Contents


Motivation

Every organization will have different needs, information, and integrations utilizing Exports. To facilitate this, Exports are configurable, and that configuration is accessed through your Export Settings.


Quotations

In some situations, special characters may appear that will inhibit viewing your Export in a program similar to Excel or even break an automated system that is processing your Export.

As an example:

  1. Assume that you are exporting the contents of an SMS message you have sent to a customer and this,is,the,message,contents.

  2. Also, assume that you have chosen a file delimiter of a comma.

  3. Then when reading the contents of your SMS message, a file reader would interpret each part of that message as a different piece of data, instead of as a whole message.

Therefore our system will wrap each piece of data in quotations so that they may be properly processed. In the above example, the output for the SMS message contents would be "this,is,the,message,contents".

If the following conditions are met for either a column header or a piece of data within that column, then it will be wrapped in quotations:

  • It contains a line break

  • It contains the same character as your delimiter, for more information on delimiters read the File Settings section of this article

If those conditions are not met, then it will not be wrapped in quotations.


Export Settings Screen

Once you have clicked on an Export that you have created, or when creating a brand new Export, you will be presented with something similar to the following screen:

1. The button to take you back to your Exports list
2. Your Export's name and edit button, this is not your exported file name, see the File Settings section for your file name
3. The button to change the status of Active or Inactive of this Export
4. An overview of your export schedule, see the Schedule Settings section for more information
5. An overview of your file settings, see the File Settings section for more information
6. The summary of your delivery method, this is configured by your File Transfer Settings 
7. A button for reordering of the properties contained in this export, depending on your method of extracting information from the export file, and if file headers are disabled, this may have a significant impact
8. A button to add a customer attribute to your Export, such as including their email along with the exported Events
9. A button to add Event Sources, adding an Event will automatically include it in your export

Adding the Event will also include all Event Properties, which can be later removed if all Event Properties are not desired

10. The index, or order of the columns, for your exported file
11. The source name of the property, whether it be a customer attribute or event property
12. The name of your column in the file

Column names can not be duplicated, each must be unique

13. Your property's data type, which can be either a Boolean, DateTime, Guid, Number, or String
14. A button to delete the column from this Export, this does not delete the property from the system, just this Export
15. The ability to see which events populate the column, assuming that it is an Event Property, unlike index 1 in this example


Schedule Settings

For each Export, you can configure a schedule regarding how frequently it will be generated on Symend's SFTP server, or how often it will be pushed to your SFTP server.

See the File Transfer Settings article for more information on push versus pull Export deliveries.

The following settings are available for different scheduling:

Frequency

Settings

Frequency

Settings

Every 15 minutes

  • An Export will be generated at HH:00, HH:15, HH:30, and HH:45 for every hour

  • Note: If you have not set a Time format in your File Settings, then files that occur on the same day will have the same name, and therefore be overwritten. You must retrieve and handle them before the subsequent files are generated to avoid data loss

Once an hour

  • You must configure this option to occur on a particular minute, such as 19, and the file will be generated every hour, on HH:19 in this example

  • You must select your desired Timezone

  • Note: If you have not set a Time format in your File Settings, then files that occur on the same day will have the same name, and therefore be overwritten. You must retrieve and handle them before the subsequent files are generated to avoid data loss

Once a day

  • You must select a particular time of day that the Export will occur, then the daily Export will occur at the specified time, such as 12:00 AM

  • You must select your desired Timezone

Once a week

  • You must select the day of the week, such as Monday, upon which the Export will occur

  • You must select the time of day, the same way as you would with Once a day

  • You must select your desired Timezone

Once a month

  • You must select the day of the month, such as 23, upon which the Export will occur

  • You must select the time of day, the same way as you would with Once a day

  • You must select your desired Timezone


File Settings

For each Export, there are a number of settings that you can configure, such as the file name, which is comprised of the Label, Date format, and Time format. There are plenty more settings, however for those three settings, you will be presented with an example of the file name based on what you have configured.

You can see the file name preview in the following image:

The following table will provide a description and all possible File settings:

Setting

Description

Available Values

Setting

Description

Available Values

Label
(File name pattern)

The pre-fixed name of your exported file

  • Alpha-numeric characters, underscores, and dashes

Date format
(File name pattern)

The pattern of the date in the file name

  • ddMMyyyy

  • yyyyMMdd

  • MMddyyyy

  • MMddyy

Time format
(File name pattern)

The pattern of the time in the file name, if present, as this is an optional inclusion

  • Not Included

  • HHmmss

  • HHmm

Separator
(File name pattern)

The character that will separate the pieces of your file name, for example in exampleLabel-ddMMyyyy-HHmmss.csv the hyphen is the separator

  • Hyphen

  • Period

  • Underscore

File extension
(File contents)

The extension of the file, although it has little bearing on the contained information, it may effect how you choose to process the file

  • .csv

  • .txt

Delimiter
(File contents)

The character that separates your cells and columns in a file, as an example MyFirstValue|MySecondValue would be a Pipe delimiter

  • Comma

  • Semicolon

  • Tab

  • Pipe

Date format

(File contents)

The format of your dates contained within the file, not to be confused with the Date format for the File name pattern

  • ddMMyyyy

  • yyyyMMdd

  • MMddyyyy

  • dd-MM-yyyy

  • yyyy-MM-dd

  • MM-dd-yyyy

  • dd/MM/yyyy

  • yyyy/MM/dd

  • MM/dd/yyyy

Time format

(File contents)

The format of your times contained within the file, not be confused with Time format for the File name pattern

  • Not set

  • HH:mm

  • HH:mm:ss

  • HH:mm:ss.fff

Timezone

(File contents)

The time zone of your dates and times, this pertains to values contained within the file, not to be confused with the Time format for the File name pattern

  • Omitted due to the large quantity of available time zones, view in-app for the complete list of values

File contains columns headers

Whether or not the first row of the file will utilize the names of your value in Export column heading

  • True

  • False


Event Sources

Event Sources are the occurrences that are necessary to generate an Export, which reports every instance of a particular Event during a given time period. It’s important to note that Exports are not the same as a database export, as they monitor over your scheduling period to provide information on what occurred during that timeframe.

Where confusion may occur, is that you are able to add customer attributes, also called properties, which are linked to your Events.

As an example:

Assume that we have added the Event for Account Created

The Account Created Event has properties of: Account Snapshot Id, DateTime, Event Category, and Event Name

This does not include a customers email, which we can then add from their attributes to be included in the Export


Required Roles

Role

Capability

Role

Capability

Data Designer

All capabilities covered in this article


Tutorials