Campaign data export

You can export campaign data from the Oracle Maxymiser UI so that you can further analyze results or parse the data to third-party tools, such as auditing, reporting, or business intelligence tools. You can export all generations and actions data associated with a user profile. Campaign data export values describes the data that you can export.

Note: You need data exporter permissions to access campaign data export. For more details, contact your Oracle Maxymiser representative.

Campaign data export enables you to do the following:

  • Export data for any campaign that is live, serving, paused, or completed.
  • Choose a location for the Campaign Data Export file. You need to use a secure file transfer protocol (SFTP) location.
  • Run a one off export or schedule a daily or weekly export.
  • Pick and choose which action and generation attributes to export.
  • Export data for one campaign at a time.

Specifying a location for the exported files

  • Click Edit Storage Settings.

  • Enter the SFTP URL where the data export files will be stored, such as sftp://clientdemoserverUS.ftpstream.com

    Note: Make sure you use an SFTP location hosted on standard port 22 and that it is accessible from the internet. For security reasons, Campaign Data Export SFTP requests are not supported on other custom SFTP ports.

  • This is a site wide setting and the location entered is used for all campaign data exports across your site. If you modify this location, all future scheduled and/or one-off data exports for this site will be uploaded to the new location. Existing exported files will not be moved.
  • You must use a Secure-Shell File Transfer Protocol (SFTP) location.
  • For authentication you can either use a Password or a SSH PuTTy Private Key.

    • Note: When using a SSH PuTTy Private Key, ensure you have uploaded your public key to your sFTP server. Then you should upload a .ppk file containing your SSH PuTTy Private Key and this private key should be Passphrase protected.

    Your Passphrase should satisfy the following conditions:

    • Be 8 characters or more
    • Contain at least one numeric character
    • Contain at least one symbol
    • Contain at least one lowercase letter
    • Contain at least one uppercase letter

    This Passphrase is used by Maxymiser to ensure that your key is securely encrypted.

  • When you SAVE the storage settings we send a small file to the location to verify that these settings are correct and ensure that the site is configured correctly to receive exported files from Oracle Maxymiser. The file name is in the format YYYYMMDDHHMMSS-{ID}-OracleMaxymiserSFTPValidationTest.txt - you can remove this file or ignore it.

Including an export details file

You can include a file to your export which includes details about the exported file by enabling the Add details file to every report option in Storage settings.

The details include the number of exported records and the data filename. There are two formats available for the details file:

  • JSON - the details file has the same name as the export file. Click here to download a sample of a JSON details file.
  • CSV - the details file has the same name as the export file with the suffix _summary. Click here to download a sample of a CSV details file.

Both your data file and your details file are uploaded to your SFTP location. The details file can either be sent in the compressed zip folder with the data file or sent separately.

Selecting data to include in the export

You can pick and choose the content to export to the Campaign Data Export file.

  • Click Create Export > Add Content.

  • Select the Actions and Generation columns that you want to include in the export. When you select a column it is shown in the Added Content area at the bottom of the page. You can include / exclude all columns or pick and choose specific columns to include in the exported file:
    StatusDescription
    All columns included. Click to exclude all columns.
    All columns excluded. Click to include all columns
    Specific columns included selected. Click to include all columns
  • You can exclude a column by deselecting a check box or clicking the cross on the item in the Added Content area.
  • Columns are ordered alphabetically in the exported file. You cannot change the order of the columns using the Add Content area at the bottom of the page.

  • When you select a column it is shown in the Added Content area at the bottom of the page.

  • See List of Data Values for a full list of campaign data that can be exported.

Creating a one-off or scheduled export

To run a one off data export or a scheduled data export:

  • Click Create Export > Schedule.
  • One Off - Exports a single file that includes actions and generations data for a specified date range. You can select date from the beginning of campaign up to today's date.
  • Scheduled - The first exported file includes actions and generations data from the start date of the campaign to today's date. Subsequent scheduled exports include actions and generations data for each day/week.

    Note: You can only create one schedule campaign data export for each campaign.

  • To select a date range - select start date first and then select the end date.

Creating a data export for specific actions

Use filers to include or exclude any actions monitored by the campaign. If you do not specify filters ALL actions are included in the data export.

  • Click Create Export > Add Filters.

  • Select the Actions that you want to include in the export.
  • You can include / exclude all columns or pick and choose specific columns to include in the exported file:
    StatusDescription
    All columns included. Click to exclude all columns.
    All columns excluded. Click to include all columns
    Specific columns included selected. Click to include all columns
  • When you select a column it is shown in the Added Filters area at the bottom of the page.
  • You can exclude an action from the file by deselecting a check box or clicking the cross on the item in the Added Filters area.

Reviewing and running the export

Once you have specified the columns to include, the date range and the action filters review you Campaign Data Export:

Note: Click the Add Content, Schedule or Add Filters button once to show/hide the Campaign Data Export Summary.

Image of how to show and hide the Campaign Data Export Summary

  • Click Run in the top right of the page when you are ready to submit the Campaign Data Export (you need to agree to the disclaimer to proceed).
  • The Campaign Data Export is added to a queue with a status of Pending. A notification email is sent to you when the export is complete and ready for download from the SFTP location.
  • View the progress of the data export and manage data exports using the Campaign Data Export list.

Managing campaign data exports

Once a campaign data export is submitted it is shown in the list of all exports for the site. This list is displayed when you first open Campaign Data Export and used to monitor the status and manage exports. The following example shows three one off exports at the top of the page and one scheduled export called CDE Demo 2.

Use the expand / close arrow to view a list of daily scheduled exports:

  • Pending: Export is waiting in the queue.
  • In Progress: Export has started. You cannot cancel an export once it is in progress.
  • Complete: Export is finished and ready for download. Click to view the export file details.

    • Note: Access the SFTP Server directly to download the exported file.

  • Error: If something goes wrong, the export shows an error status. Check that the SFTP URL and sign in credentials have been entered correctly and make sure that there is enough space on the SFTP server. If you still have problems contact Oracle Maxymiser Support.
  • To stop a one off export or a scheduled export, click CANCEL on the relevant row on the Data Export list.

  • You can only cancel a one-off export in Pending state.
  • If you cancel a scheduled export this will stop all future scheduled exports running. Exports that are in progress or completed are not effected.

Campaign data export FAQs

  • File name must be less than 50 characters and not contain the following characters / ? < > \ : * | "
  • Campaign Data Export files use the following naming convention to help identify the time date of the file:
    YYYYMMDDHHMMSS-{Unique ID}-{Export Name}
    Where:
    Export Name - Export file name entered by user
    YYYY is the year, MM is the month, DD the HHSS is the time of the export using the 24 hour clock.
  • Campaign Data Export output files are exported in .csv format and compressed and stored on the SFTP location within a .zip file.
  • Columns and values within the exported file are separated by a tab space.
  • Columns are ordered alphabetically in the exported file.
  • See List of Data Values for a full list of campaign data that can be exported.

Note: UTC times zones are used for all Campaign Data Export schedules. You may need to allow for this if your server does not use UTC as the local time zone.

Oracle Maxymiser only supports Secure File Transfer Protocol (SFTP) for Campaign Data Export files.

Yes. On the Data Export page, click Edit Storage Settings and update the URL for the data storage location.

Note: This is a site wide setting. The location entered is used for all campaign data exports across the site. If you modify this location, all future scheduled and/or one-off data exports for the site will be uploaded to the new location. Existing exported files will not be moved.

If something goes wrong, the export shows an error status. Check that the correct SFTP URL and sign in credentials are entered correctly and make sure that there is enough space on the SFTP server. If you still have problems contact Oracle Maxymiser Support.

Users must have permissions set with data export enabled. These permissions are set up via Admin > Account Administration > Edit > User Permissions. Contact your system administrator for more information.

Columns are always exported in alphabetical order.

No.

You can only set up one scheduled data export for each campaign. Check to see if there is an existing Scheduled data export running for the campaign. If you want to set up a scheduled data export that includes different data, you will need to CANCEL the existing scheduled export and set up a new one.

You just need to change the format of the columns in the Microsoft Excel file to number format. Select Column > Format Cells > Select 'Number' and set Decimal Places to '0'.

A one-off campaign data export is normally available on the specified SFTP server a few minutes after it has been submitted. On rare occasions, when there is a unusual load on the export queue or a large volume of data to be exported, this may take a little longer. You can check the status of the export on the Campaign Data Export list - see 'How to manage campaign data exports'.

When you submit a scheduled campaign data export the export for the current day is added to the queue immediately. The time it takes for the file to be generated is dependent on the volume of data and the load on the queue. If the queue is empty the export is executed almost immediately, if not it is executed when it reaches the top of the queue. Once the export file is generated it is uploaded to the SFTP location immediately, but the time to load this file may differ depending on network bandwidth and file size.

Subsequent scheduled daily exports will be added to the queue for execution at same time each day depending on the volume of data in the queue. So for example, if you submit data export at 9:00 AM your first data export will be available almost immediately, data exports on subsequent days become available a few minutes after 9:00AM on each day. This also applies to the weekly exports for a particular time of day and day of the week.

Note: If you want to receive daily scheduled exports at a specific time of day, make sure you submit/run the scheduled export request at the time of day that you want files to be available. For weekly, make sure you submit your request on the day of the week you want to receive your export.

The campaign data is available for export within 4 to 7 hours of its generation. Daily exports may contain data from earlier days in cases when it was not available at the time when the export was generated - this ensures that you never miss out on any campaign data.

Creating a Secure Shell (SSH) key pair can be done using your preferred tool. Here are some examples of tools that can be used to create SSH key pairs:

  • PuTTyGen on Windows
  • Git Bash
  • OpenSSH on UNIX

Warning: These third party tools are not associated with Oracle Maxymiser. We are not liable for any issues you may encounter while using these tools.

To learn more, see Creating SSH Keys for Use with Oracle Cloud Services.

Your public key should be uploaded to your sFTP server. Then you should upload a .ppk file containing your SSH PuTTy Private Key and this private key should be Passphrase protected.

No. Contact your Oracle Maxymiser representative for more information.