This article explains set up and mappings for Qgiv’s Virtuous integration.

Click here to download a spreadsheet of information we send to Virtuous by default during export, when applicable. 

Click here to download a spreadsheet of additional fields in Qgiv you can map to Virtuous. 

Please note: Online, Qgiv offline, and peer-to-peer offline verified transactions are exported. Refunds, voids, and chargebacks are not exported.

Contents:

• Getting Started
• General Settings
• Export Settings
• Contact Types
• Default Values
• Extra Info
• Optional Mappings
• Custom Mappings
• Running an Export and Export History
• Backing Up, Re-Authenticating, or Deleting the Integration
• Enabling the Service Integrations Notification

 

Getting Started

To set up the integration, click the Integrations icon along the left side of your screen.

Locate the Virtuous tile in the CRM section and click Connect.

Enter your Virtuous API Key and then click Connect again.

 

General Settings

You'll be taken to a screen where you can configure your settings.

Settings are organized into tabs along the left side of the page. You'll be prompted to Save after you make changes on a tab.

On the General tab, use the calendar to choose the Export Data Starting On date. If you'd like to export data from a date prior to the current date, you can set your calendar accordingly so historical transaction data will be exported. 

IMPORTANT: The date you set aligns with the transaction dates you'll be exporting. If you set the date to today, only transactions from today and future dates will be exported.

The Export Data Ending On field lets users input a date to end exports from the integration. Leave this field blank if you want the integration to export indefinitely.

In the Frequency drop-down, choose Manual, Hourly, Daily, or Every 15 Minutes exports. 

If you choose Daily exports, you’ll also be able to choose the time (Eastern) for the export to occur.

Beneath the Frequency drop-down is the Maximum Transactions field. This required field specifies the maximum number of transactions Qgiv will export to the integration at a single time. The default setting is to export a maximum of 100 transactions. You can adjust this number higher or lower, but the number field cannot be blank.

Also note that smaller limits provide a safer export, reducing the likelihood of export issues due to a service interruption.
 

Please note: The Maximum Transactions limit for Virtuous cannot be higher than 500.

 

Export Settings

The next tab houses the Export settings.

Exclude Offline & Matching Donations, when toggled on, excludes offline and matching donations from exports.

IMPORTANT: If you choose to export offline and matching donations, only verified transactions will be included.

The Exclude Facebook Donations toggle excludes donations made through Facebook.

The Export GiftAssist as Separate Line Item toggle makes it possible to export GiftAssist as a separate line item from the donation itself.

This is particularly useful when exporting transactions that have multiple line items, such as an event registration with an additional donation. If Export GiftAssist as Separate Line Item is enabled, the GiftAssist amount will appear as a separate part of the transaction. If Export GiftAssist as Separate Line Item is not enabled, GiftAssist will be divided evenly among each of the transaction's line items.

The Override Anonymous toggle overrides the anonymity settings on the Qgiv form and marks transactions (Gifts) as not Private. If the toggle is turned off, each transaction's anonymous field will be respected.

Export Transactions With Finalized Settlement Date pertains to Worldpay users. When toggled on, this will prevent transactions from exporting to Virtuous until each transaction has a settlement date.

The Enable Recurring Gift and Pledge Support toggle marks recurring gifts and pledges differently than regular donations in the integration.

Troubleshooting Recurring Support

Virtuous only supports certain frequencies for recurring and pledge gifts. For Standard (open-ended) Recurring gifts, the supported frequencies are Weekly, Every Other Week, Monthly, Quarterly, Semiannually, and Annually. For Pledges (recurring with an end date), the supported frequencies are Monthly, Quarterly, Semiannually, and Annually.

With Enable Recurring Gift and Pledge Support enabled, the Virtuous importer will create a new recurring donation or pledge on the first occurrence of that gift or pledge. Additional occurrences of existing recurring/pledge donations are sent to Virtuous as standard gift records, and Virtuous should match that gift to an existing recurring/pledge record.

If you choose to designate a Project for mapping, the Project in Qgiv must match the Project in Virtuous in order to ensure that recurring gifts map correctly. If you decide to change the Project for an existing recurring donation or pledge, you’ll want to make sure you update the recurring record in Virtuous as well.

If the integration does not automatically match the gift to an existing record, you may need to manually match the gift after import.

The Enable Peer-to-Peer Influenced Gifts toggle creates a credit for peer-to-peer donations made to a fundraiser. In order for peer-to-peer influenced gifts to be classified as such in Virtuous, the Qgiv Peer-to-Peer Event must be mapped to a Virtuous Event and the Virtuous Event must have a Campaign Communication assigned.

Please note: In order to assign credit to a fundraiser, the integration will attach a Marketing Segment to the transaction, which may override a Marketing Segment you've separately mapped for the form.

The Enable Tributes toggle enables mapping to tributes. Tributes are equivalent to dedications in the Qgiv system.

 

Contact Types

On the Content Types tab, you can configure settings for Household Contact Type and Organization Contact Type.

The Household Contact Type and Organization Contact Type drop-downs determine how individual and company donors are categorized in Virtuous.

 

Default Values

On the Default Values tab, choose a Marketing Segment, Project, and Premium from the drop-down menus. The selections you make here will be your default mapping locations for transactions that cannot be mapped elsewhere.

You can select Unmapped if you do not want any value to be used, but if you choose to designate a Project for mapping, the Project in Qgiv must match the Project in Virtuous in order to ensure that recurring gifts map correctly. If you decide to change the Project for an existing recurring donation or pledge, you’ll want to make sure you update the recurring record in Virtuous as well.

Please note: To populate the drop-down fields, just begin typing the name of the Marketing Segment or Project you intend to use. Options will appear once you've entered at least three characters.

 

Extra Info

If there’s any extra information you’d like to add to the Notes in Virtuous upon export, you can choose from the options in the drop-down menu on the Extra Info tab.

You can read more about what those extra info fields mean here.

You can make multiple selections. They’ll appear one at a time below the drop-down menu as you select them.

Not all information is available for each transaction type (e.g., Participant Name will only show up for peer-to-peer registrations).

 

Optional Mappings

Once you’ve saved, click the Mappings tab to display your Optional Mappings options. This is where you’ll configure mappings if you’d like specific data sets mapped to something other than the default values in the settings area.

Mappings can be grouped by Mapping Type or by Form using the Group by drop-down menu.

You can also filter your mappings to display only specific Mapping Types or only certain Forms and Events.

To add a new mapping, click the Add New Mapping button and then select the Mapping Type from the drop-down.

For example, if you’d like to export data for a specific form, select Standard Qgiv Form > Form from the drop-down menu. Then, use the Form drop-down to select the form.

If you’d like to exclude the Qgiv data from your exports, check the box labeled Exclude from Export.

Excluding can be useful for something like a $0 category for a peer-to-peer campaign. 

 

If you’d like to export the data to Virtuous, do not check the box, and then select the Marketing Segment, Project, and Premium values.

If you choose to designate a Project for mapping, the Project in Qgiv must match the Project in Virtuous in order to ensure that recurring gifts map correctly. If you decide to change the Project for an existing recurring donation or pledge, you’ll want to make sure you update the recurring record in Virtuous as well.

To populate the drop-down fields, just begin typing the name of the Marketing Segment, Project, or Premium you intend to use. Options will appear once you've entered at least three characters.

Please note: Premiums can be mapped for auction items and peer-to-peer store item purchases, as well as auction and standard event packages that include a non-zero Fair Market Value.

When you’ve configured your mapping, click Add Mapping.

You can Edit or Delete a mapping by clicking the three dots at the right side of the mappings table.

If you’d like to delete multiple mappings, check the box next to the mapping’s names, and then click Delete Mappings at the top of the table.

The process is similar for each data set shown in the Optional Mappings area. There may be some slight variations in how many choices you have in each drop-down. 

For example, if you’re mapping restrictions, you’ll see another drop-down menu, and still another if you’ve set up sub-restrictions. 

When mapping events, you’ll be given the option to drill all the way down to event packages, if desired.

You can also map text campaigns:

Peer-to-peer events just require a form selection and export destination.

You can choose to export other peer-to-peer data, as well.

Peer-to-Peer Classifications

Peer-to-Peer Categories

Peer-to-Peer Restrictions

Peer-to-Peer Store Purchases

You can also map auction transactions.

Auction

Auction Restriction

Auction Package

Auction Item

Please note: With the current version of the integration, auction purchases in Qgiv will sync to Virtuous as tax-deductible gifts. Therefore, until the integration is updated, it's recommended to use Qgiv to configure receipts to show the tax-deductible portions.

 

Custom Mappings

You can also add Custom Mappings. You may already have similar mapping set up through the Extra Info fields. If you don't want this information to appear in both places, be sure to delete the Extra Info mappings once you set up your custom mappings.

Custom mappings allow you to dictate which target objects and fields you want data to go into in the integration. Custom fields must be active in the destination before you can map to them from Qgiv. There are three custom mapping types: static, custom field, and standard field. For each type, you can map to a target object + field using the data from that custom type. See the attached standard field mappings spreadsheet for details.

 

Static

With static field mappings, you can add static values in Qgiv to target records in the integration service.

 

Custom Field

With custom field mappings, you can map custom field answers in Qgiv to target fields based on unique custom field reporting labels. For example, you can track custom fields for your fundraising events, such as gathering meal choices.

 

Standard Field

With standard field mappings, you can map standard field values to a target field. 

Some values will be specific to a transaction line item (e.g. restriction name), while others will be for the entire transaction (e.g. transaction ID).  

Click here to download a spreadsheet that details all Service Integration Standard Field mappings.

 

Please note: If you try to map to the same target object + field (regardless of the type), we will only save the most recent mapping.

Don't forget to save your work!

 

Running an Export and Export History

When you’re ready to run an export, click Export, which is located in the upper-right corner of your settings window. This is only necessary if you chose the Manual export option.  

Otherwise, Hourly exports are scheduled to run once per hour at 15 minutes past the hour, but they are not guaranteed to run at exactly 15 minutes past. Actual run times depend on the server load. Daily exports will run at the time you chose. 

IMPORTANT: If you're exporting for the first time or have a large number of transactions to bring over, we'd recommend setting your export start and end dates to export one week at a time to avoid hitting API limits.

You’ll receive a message in a pop-up alerting you that your export was completed. If successful, you’ll see the following:

Clicking View Export History will open the Export History Report, but will display only the records associated with this export.

If there were any issues during the export, you’ll see a message similar to the following:

At the top of your integration management screen, you’ll see an Export History tab. Here, you’ll see some basic information about your past exports, including the Export ID, Date and Time, Status, and Total Transactions.

Clicking the Export ID will take you to the more detailed Export History report, filtered by the transactions that were exported in that batch.

To view the full Export History report, click View All Export History.

When you do so, you’ll open the Export History Report, which includes a table which details all exported records across your service integrations.

In the Export History Report you may notice an icon that looks like the outline of a person with a plus sign. This means a new record was created as the result of a new donor or registrant.

Additionally, you may notice an additional alert icon in the Export Status column. Hover over the icon to see more details. The message will also display in the Export History Report.

Follow the link to learn more about the Export History Report.

Backing Up, Re-Authenticating, or Deleting the Integration

If you have a lot of optional mappings, you may want to back them up to a CSV file. This is useful if you need to deactivate a service or adjust your connection and want to make sure your mappings are safe.

Click the Mappings Backup link to access the Mappings Backup & Recovery settings.

From here, you can download your mappings as a CSV file, as well as upload a previously downloaded backup file.

The Re-authenticate link lets users reconfirm their integration credentials or enter credentials for a different account.

When you click Re-authenticate, you'll be prompted to Activate the integration or Cancel the reauthentication process. Clicking cancel keeps the integration set up the way it was before clicking Re-authenticate.

If this service integration is no longer needed, it can be deleted by clicking Delete Integration in the left-hand navigation.

You'll be prompted to confirm your choice to delete the integration by typing the word DELETE.

After deleting the service integration, if you need to re-enable it you can reconnect just like when you originally set up the service integration. 

To save you time and prevent you from accidentally creating duplicate records, you'll be prompted to Restore export history when you establish your integration again. Note that this will not import any past integration settings. If you would rather start with a clean slate, select Start from scratch instead.

 

Enabling the Service Integrations Notification

To be notified via email when a service integration becomes inactive, the integration is locked for an extended period, or a transaction fails to export, you can turn on the Service Integrations notification.  

To manage notifications, navigate to the Notifications area of your org-level control panel.  

Click Manage for each user you’d like to receive the notification.  

Then, search for Service Integrations at the top of the screen, or scroll down to Service Integrations in the System Notifications section.  

Check the box next to the notification to activate it. 

Scroll to the bottom of the screen and click Save Settings to save your changes. 

To read more about Notifications, check out this article.