Templates

Understanding how Exports templates work

The Templates section of Exports lets you view and create templates for generating data files. Each existing template is displayed in a table as a row, with five properties related to the file.

  • ID: the unique ID assigned to the template.
  • Name: the name you assigned to the template. Note that template names and file names are separate properties.
  • Type: the type of records represented in the template. These export types are described below in the section on creating new templates.
  • Frequency: the interval at which the template generates a file.
  • Created: the creation timestamp for the template.

In the table view, each template also includes controls for downloading a data file for the template. After clicking the download symbol, a date picker appears in which you can select the time period for records to include in the export.

Creating a template

A template is created by selecting the New template button in the Templates view of the Exports feature. The configuration settings for templates are described below.

General settings

When you create a new export template, the first General settings tab allows you to configure the key parameters of the template.

  • Template name: the internal name you want to use for the template, e.g. “New monthly recurring plans” or “Failed crypto donations”.
  • File name: a dynamic text input that enables you to implement a custom naming structure for files generated by the template, e.g. “Failed recurring plans from Start Date to End Date.” These two dynamic merge tags — Start Date and End Date — can be included in the file name. These merge tags refer to the period of time for which records will be exported. These dates are set either by the template’s Export schedule or in the date picker when you download a file from the Templates view.

    When the dynamic date merge tags are used, they will insert date and time values. For example, for a file that includes data for December 3-4, 2023, the dates will be inserted as 2023_12-03 and 2023_12-04, and the times will be inserted as 00_00 and 23_59, representing the full 24-hour period for which records are reported.

  • Export type: defines the type of records that will be included in the template.
    • New donations: all new donations, including one-time and recurring donations, created during the specified period. By default this includes all donations of all statuses.
    • Successful donations: all new donations, including one-time and recurring donations, that were successfully processed in the chosen time period. This export type excludes any donation with a status other than Success.
    • Refunded donations: all donations for which the status was set to Refunded during the specified time period.
    • Failed donations: all donations for which the status was set to Failed during the specified time period.
    • New recurring plans: all recurring plans created during the specified time period.
    • Cancelled recurring plans: all recurring plans for which the status was set to Cancelled during the specified period.
    • Failed recurring plans: all recurring plans for which the status was set to Failed during the specified period.
    • Shared tributes: all donations for which the supporter included a dedication and went on to select a tribute type.
    • New P2P Fundraisers: all fundraisers created during the specified period.
    • New P2P Team Members: all fundraisers to which a member was added during the specified period.
    • Campaigns: all your organization's existing campaigns, regardless of status, at the moment of export.
    • Abandoned donations: incomplete donations created during the specified period.
    The default columns shown in the File columns section are based on the export type selected here.
  • Export test donations: when selected, this option includes records created when the platform was in test mode.
  • Include subaccounts: if subaccounts are enabled and this option is selected, records for the primary account’s subaccounts will be included in files generated by the template.
  • Payment method: filters records based on the payment method used for a donation. By default, the template will include records for all payment types.
  • Frequency: enables you to select between including all donation frequencies or filtering by one-time or recurring frequencies. By default, the template will include records for all frequencies.
  • Campaigns: enables you to select the campaigns that should be represented in data files created by the template. By default, the template will include records from all campaigns.
  • Sources: enables you to select which source or sources donations should originate from to be included in the template. For instance, you can include only P2P donations, or only donations that came through the Checkout modal and Campaign Pages.
Some configuration options are hidden or shown based on the Export type chosen.

File columns

In the File Columns view, you can select which properties you want to include in data files created by the template. You can include virtually any property, including custom questions and designations.

Presets

For your convenience, we include presets for popular platforms. These presets include the necessary or helpful properties that are ordered and named based on the platform that will the exported files will be used with.

Fields for export

You can include virtually any property in an exports template. Properties are displayed in a searchable list and are dragged and dropped into the template file builder. Properties can be rearranged by selected the left-hand grab handle displayed in each property row and dragging the property to a new location.

Column names

Column names, represented by default by a property name, can be customized. To do this, hover over the field name in the CSV column and click the pencil icon. Changing column names is useful when you want to match column names to property names in other apps. This can help resolve mapping errors when you import a data file from Fundraise Up into an other platform.

Format

For some properties, you can select which format you want the data to appear in. Examples of these property types and possible formats are shown in the table below.

Property Available formats
Donation Amount Full — $100 USD Short — $100 Amount only — 100
Supporter Language ISO-code — fr-CA Name — French (Canada) Simple Name — French
Donation Date ISO 8601 — 2024-03-26T17:03:00.791-04:00) YYY-MM-DD — 2024-04-23 24-hour time — 18:00 12-hour time — 6:00 PM

A property in the Fields for export area can be removed from the template by hovering over its row and selecting the trash can icon. All rows can be removed from the template by selecting the Clear all option.

Export schedule

Export templates can be configured to automatically generate data files on a set schedule from the Export schedule view. By default, the Create files on a schedule option is unselected.

When you enable creating files on a schedule, you can select from four frequencies:

  • hourly
  • daily
  • weekly
  • monthly

Enabling an export schedule also enables the option to automatically transmit data files one or more destinations. By default, this option is unselected.

When enabling the option to send files, you can select from destinations you have already created, or select the Add destination option to create new destinations. As needed, you can select multiple options to send files to several destinations. Learn more →

Related articles
Dashboard •
Files
Dashboard •
Deliveries
Dashboard •
Destinations

 

In this article