Skip to main content

Custom export

Customized export allows you to retrieve specific data and send it automatically to a server.

Elsa Fernandes avatar
Written by Elsa Fernandes
Updated over a year ago

SUMMARY

  1. Data that can be retrieved

  2. Setting up a custom export

Step 1: Start custom export

Step 2: Select export data

Step 3: Set parameters for selected fields (optional)

Step 4: Add conditions (optional)

Step 5: Configure export flow

Step 6: Enable GPG data encryption (optional)

Step 7: Automatic export triggers


  1. Data that can be retrieved

You'll find the list of available fields in the custom export settings tab when you start the export. These fields will enable you to retrieve precise data on your participants.

Principal form : In the principal form section, the list of proposed fields corresponds to the fields added to the operation form. This also includes fields from additional forms. This list also includes fields dedicated to the mechanics (Quizzes, Battles...).

  • is_optin = 0,1 or 2 (Identifies optin or double optin participants)

  • contest_entry_hash_id = Unique participant id

  • is_anonymous = 1 or 0 (if 1 = participant has been anonymized)

  • created_at = date of participation

  • Optin or extend checkbox field = 1 or 0

  • Free field and open question = plain text content

  • can_participate = Value 1 or 0 (if 1 = authorized to participate)

Device: In this section, fields are used to retrieve data on the device used.

  • mobile: 1 or 0 (If 1, this means that the participant comes from a mobile)

  • origin url: identifies the url used by the participant to access the operation

  • IP address

  • user_informations.agent_browser : browser used

  • user_informations.agent_platform (System used): windows, mac, or microsoft

  • country

  • width and height fields: size of device used

Operation: The fields in this category provide information about the operation.

  • Chrono: Time in seconds spent on the operation

  • Operation Hash_id: Operation code, e.g. DRrv3d

  • Operation name

*Access code: This part lists a field, the access code, which is useful for finding out the access code used by the participant.

  • Access code: plain text content

External: If the operation is linked to Sogec or 76310, you will find the following fields:

  • PAL: The pal associated with the gift ex:PAL03

  • Participation_sogec_id : example 2000056

  • Sogec last state : The status of the proof of purchase

  • reason not conformity : Reason for refusal

  • rnvp.email : 1 or 0

  • rnvp.email.status : According to the 3 defined statuses, validated, suspect, invalid.

  • rnvp.email.detail: The detail example: MailboxDisabled

  • rnvp.address 1 or 0

  • rnvp.address.status : according to the 3 defined statuses, validated, doubtful, invalid.

  • rnvp.adresse.detail : example : Correct address

  • rnvp.api.count : The number of calls made to the 76310 api per participation.

Gift: Data related to the gift.

  • Contest gift hash_id : The id of the gift issued.

  • Contest gift title : The name of the gift.

  • Contest gift description : The description

  • Contest gift code : The unique code associated with the gift.

Custom : The custom field lets you add a field with a defined value. You can add as many custom fields as you like.

2. Setting up a custom export

Step 1: Start custom export

  • Use the "Create export" button.

  • Enter name.

  • Choose the type of customized export.

  • Select the operation to be associated with this export.

  • Activate export of participants only and/or export of winners only

    By default, export content is based on entries. When selecting an "instant win" operation, you have the option of exporting winners only.

Step 2: Select export data

Your game settings and the fields on your form(s) determine which data can be collected.

  • Click on the data on the right to display it in the area on the left.

  • You can also change the display order by dragging elements across the design area.

Available data ↓ Design zone ↓

Example after construction: The first row corresponds to the first column you'll find in the export.

Step 3: Edit selected fields (optional)

Editing fields allows you to :

  • Rename field title

  • Enter a default value

  • Add a condition on the minimum* and/or maximum size of the number of characters.

  • Values can be transformed during file generation according to the filter associated with the field.

Glossary of options available when editing a field

  • Column name: The title that will be displayed on the column in the export.

  • Default value : Fields belonging to the form (red Form badge) can have a default value when there is no data entered by the participant.

  • Max size: The maximum number of characters for the value entered.

  • Minimum size: The minimum number of characters for the value entered.

The "minimum size" option contains a numerical field which allows you to enter the desired number of characters. When you select a minimum number of characters, you must choose the type of characters that will complete the value if it doesn't reach this number of characters. The choice is between an empty interval (space) or the character 0. You must choose whether to complete the value in front (as a prefix) or behind (as a suffix).

Filter glossary Filters are useful for transforming values into another form.

  • Age as a function of date: Useful for date-of-birth data.

  • Transform string into boolean: data becomes True (Si =1) or Fasle (Si=0). Example: When the user wins a gift with a gift code, the value will be "true".

  • 0 if the string is empty, otherwise 1.Example: When a participant wins a gift, the value will be 1. For other "losing" participants, the value will be 0.

  • Long format civility: Useful for civility data.

  • Civility in short format: Example: Mr. for Mr., Mrs. for Mrs...

  • Country code in long format: Example: Fr for France, Es for Spain...

  • Country code in short format

  • String in lower case.

  • Date in DDMMYYYY format. Example: June 18, 1991 becomes 18081991. Will be empty if it doesn't match.

  • Removes blank spaces when there are extra spaces between words.

  • Returns an uppercase string.

  • Returns a string with the first letter capitalized.

  • Returns the phone field with +33

  • Returns 10-digit phone field (Remove +33 and replace with 0)

  • Returns date and time format YYYY-MM-DD HH:MI:SS

  • Returns date format YYYY-MM-DD

  • Returns date and time format without spaces YYYYMMDD

Step 4: Add conditions (optional)

Conditions allow you to export sorted data. If you wish to collect data only from participants who have shared the operation on Facebook, then you need to set a condition.

To add a condition on a specific field, the field must be added to the "field selected for export" list.

You can add several conditions, which will be added together. For example: Add a condition on winners and optin participants.

Example: If the user wishes to collect data from optin participants only, then he must set up a condition as follows :

Step 5: Configure export workflow

Please note: Export to a CRM is not functional.

File format :

  • CSV: Allows data to be displayed in tabular form. Preferable when there is a lot of data.

  • XML : Displays data in hierarchical form. Useful depending on the system to which the file is sent.

  • JSON: Displays data in structured form.

Note: The "pattern" = the name of the file when exported.

  • TXT: A file whose content represents a sequence of characters only.

Please note that CSV and XML file extensions include fields that must be configured.

The system to configure :

  • Local: Export to the computer from the tool's home page.

  • FTP: File transfer to a defined FTP server. This is an unsecured file transfer method.

The FTPS protocol is a secure version of the FTP protocol. SSL/TLS encryption is added to secure communications between the FTP client and the FTP server.

  • GCS: Stored on Google cloud.

  • S3: Sent and stored on an AWS server.

  • SFTP: This is a secure file transfer method with Secure Shell that establishes a single secure connection providing customers with a high level of security for file transfers.

Step 6: Enable GPG data encryption (optional)

Allows you to protect your data using a system of public-private security key pairs.

Incoming data can be decrypted and outgoing data encrypted.

The command to type (under linux or osx) is "gpg --quick-generate-key" to create a public/private key pair.

Step 7: Automatic export triggers

  • Immediate: the export is sent automatically

  • At operation closure: When the operation is finally closed

  • Weekly recurrence: Every week on a specific day

  • Scheduled: You define the export date and time

  • Daily export: Every day at a specific time.

There are 3 types of configuration for the content of the daily export:

1: Data from the previous day

Only new participants

If the participant returns on the 2nd day, he will not be included in the export content.

2: Daily data only

New participants only

If the participant returns on the 2nd day, he will not be included in the export content.

3: All data

If the participant returns on day 2, his/her data will be updated in the export.

Did this answer your question?