Import from Blackbaud Raiser's Edge NXT - List Gifts

The Import from Blackbaud Raiser's Edge NXT - List Gifts script template pulls in a list of gifts from the Blackbaud SKY API onto a Civis Platform table. This script template uses the “ListGifts” API endpoint from the Blackbaud SKY API.

Blackbaud SKY API Authorization

This script template requires the appropriate Blackbaud credentials. If you haven’t done so already, please follow the steps in Blackbaud SKY API Authorization.

If you already have a Civis Platform custom credential for a Blackbaud refresh token, it is possible that it may have expired (365 days after creation). If you run into import issues due to an expired refresh token, you will need to regenerate the refresh token by re-running your deployed Civis Platform service described in Blackbaud SKY API Authorization; the same Civis Platform custom credential will be overwritten with a new Blackbaud refresh token.

Parameters

• Blackbaud Subscription Key (required): A valid credential containing the appropriate subscription primary access key.
• Blackbaud Application ID and Secret (required): A valid credential containing the appropriate client ID and secret as username and password.
• Blackbaud Refresh Token (required): A valid credential containing the appropriate refresh token as generated by the OAuth report.
• Constituent ID (optional): Comma-separated list of constituent identifiers. Returns gifts if any of the specified constituent identifiers match any of their constituents. For example, 280,232 returns constituents with either "280" or "232" constituent identifiers.
• Post Status (optional): Comma-separated list of post statuses. Returns gifts if their post status matches any specified. For example, DoNotPost,Posted returns gifts that are marked either DoNotPost or Posted.
• Gift Type (optional): Comma-separated list of gift types. Returns gifts if their type matches any specified. For example, MatchingGiftPledge,RecurringGift returns gifts of the type MatchingGiftPledge or RecurringGift. Available options are Donation, GiftInKind, MatchingGiftPledge, MatchingGiftPayment, PlannedGift, Pledge, PledgePayment, RecurringGift, RecurringGiftPayment, Stock, SoldStock, and Other.
• Receipt Status (optional): Comma-separated list of receipt statuses. Returns gifts if any of the specified statuses matches any specified. For example, DoNotReceipt,Receipted returns gifts that are marked either DoNotReceipt or Receipted.
• Acknowledgement Status (optional): Comma-separated list of gift acknowledgement statuses. Returns gifts if their acknowledgement status matches any specified. For example, DoNotAcknowledge,Acknowledged returns gifts that are marked either DoNotAcknowledge or Acknowledged.
• Campaign ID (optional): Comma-separated list of campaign identifiers. Returns gifts if any of the specified campaign identifiers match any of their campaigns. For example, 2801232 returns gifts with either "280" or "1232" campaign identifiers.
• Fund ID (optional): Comma-separated list of fund identifiers. Returns gifts if any of the specified fund identifiers match any of their funds. For example, 280,1232 returns gifts with either "280" or "1232" fund identifiers.
• Appeal ID (optional): Comma-separated list of appeal identifiers. Returns gifts if any of the specified appeal identifiers match any of their appeals. For example, 280,1232 returns gifts with either "280" or "1232" appeal identifiers.
• Start Gift Date (optional): Represents a filter for gifts with a gift date on or after the specified date. If used with end_gift_date, returns gifts with gift dates between both values.
• End Gift Date (optional): Represents a filter for gifts with a gift date on or before the specified date. If used with start_gift_date, returns gifts with gift dates between both values.
• Start Gift Amount (optional): Represents a filter for gifts with an amount greater than or equal to the specified amount. If used with end_gift_amount, returns gifts with amounts between both values.
• End Gift Amount (optional): Represents a filter for gifts with an amount less than or equal to the specified amount. If used with start_gift_amount, returns gifts with amounts between both values.
• List ID (optional): List identifier used to filter the set of gifts to those included in the specified list. If this value is set, other specified filters will be ignored.
• Date Added (optional): Represents a filter for results created on or after the specified date. The filter respects time offsets from UTC per the ISO-8601 format: 2016-05-05T17:59:31.1600745-04:00.
• Days (optional): How many days back to sync results from the last time they were modified. To make sure no data is missed, Days will always go backward from midnight UTC. When specified, this will be used instead of Start Date.
• Start Date (optional): Represents a filter for results modified on or after the specified date. The filter respects time offsets from UTC per the ISO-8601 format: 2016-05-05T17:59:31.1600745-04:00.
• Sort (optional): Comma-separated list of fields to sort the results by. Returns a list that sorts constituents based on the supplied fields. Results are in ascending order by default, and a '-' sign denotes descending order. For example, date_added,-last sorts constituents by the "date_added" field in ascending order and then by the "last" field in descending order.
• Sort Token (optional): Token filter to provide the next stable-sorted list of gifts. This will be provided on the next_link collection response property when last_modified or sort_token filters are specified on the request.
• Destination Database (required): The database in which to write records to.
• Destination Database Credential (required): A valid database credential.
• Schema and Table (required): The schema and table name you would like to import the data into, e.g. “schema.table”.
• Table Exists (optional): The action to take if a table with the requested name already exists.Options are:
  • Fail: The sync job fails if the table exists
  • Append: Records will be appended to the existing table
  • Wipe: Records on the table will be wiped out while maintaining the current columns.
  • Drop: Removes the entire table including column information.
  • Upsert: Update or insert records into the specified table. The upsert mode modifies the table by leveraging the Primary keys as well as Last modified Keys provided to modify existing records or add new ones. Visit Upsert Mode for more information on how it works.
• Max Errors (optional): The maximum number of rows with errors to remove from the Civis Platform table import before failing. Defaults to 0 (i.e., no errors allowed).
• Dist Style (optional): The distribution style for the resulting table. One of 'even', 'all' or 'key'. Defaults to 'key'.
• Dist Key (optional): The column to use as the distkey for the table. Defaults to 'id'. If you import data that doesn’t have a column named ‘id’, please provide the column name for the primary key.
• Sort Key 1 (optional): The column to use as the sortkey for the table.
• Sort Key 2 (optional): The second column in a compound sortkey for the table.
• Primary Keys (optional): Comma separated columns that uniquely identify a record
• Last Modified Keys (optional): Comma separated columns indicating a record has been updated
• Log Level (optional): Log level to output in log. Defaults to INFO.