The Import from Blackbaud Raiser’s Edge NXT script template imports data from a Blackbaud Raiser’s Edge NXT SKY API object from your Raiser’s Edge NXT environment onto Civis Platform. In order to use this script template, your Blackbaud environment must first be configured by performing the SKY authorization workflow steps here. Once the above steps are completed, create a custom script by clicking on the following link and clicking the “New Custom Script” button:
https://platform.civisanalytics.com/spa/#/templates/scripts/286832
Parameters
- Blackbaud Application ID (required): Blackbaud application ID credential created from these steps
- Blackbaud Refresh Token(required): Blackbaud refresh token credential used to request sets of data from Raiser’s Edge NXT. This credential is created automatically by following these steps.
- Blackbaud Subscription Key (required): Custom credential signifying the endpoints that this application can access. Created by these steps.
-
Blackbaud Object (required): The Blackbaud Raiser’s Edge NXT endpoint to import data from. If you do not see the endpoint you would like to import data from, please reach out to support@civisanalytics.com with a request and we will make additions where possible. We currently support the following endpoints under the Raiser’s Edge NXT API umbrella:
- Constituents - List Constituents
- Constituents - List Constituent Codes
- Fundraising - List Funds
- Gifts - List Gifts
- Opportunities - List Opportunities
- Days (optional): The number of days (as an integer) of data to import based on the "date_modified" field. If not specified, all data will be imported. If specified, only data modified in the last N days will be imported. For incremental syncs, specify this parameter together with “Existing Table Rows”, e.g., set “Days” to 1 and “Existing Table Rows” to “upsert” for a scheduled daily run to get updated data from the last day.
- Database (required): The Civis Platform database to which to write records.
- Database Credential (required): A valid database credential for the Civis Platform database. To use the credential associated with the logged-in user, choose from the dropdown the credential that has this user’s Civis Platform username.
- Schema and Tablename (required): The schema and table name you would like to import the data into, e.g., schema.table.
-
Existing Table Rows (optional): The action to take if a table with the requested name already exists. Options are:
- Append: Records will be appended to the existing table
- Fail: The sync job fails if the table exists
- Drop: Removes the entire table including column information.
- Truncate: Records on the table will be wiped out while maintaining the current columns.
- Upsert: For upserts, the primary key column is “id” and the last modified timestamp column is “date_modified”. For incremental syncs, combine this option with the “Days” parameter, e.g., set “Days” to 1 and “Existing Table Rows” to “upsert” for a scheduled daily run to get updated data from the last day.
Raiser’s Edge NXT Object Reference:
Constituents - List Constituents
API Endpoint: https://developer.sky.blackbaud.com/api#api=56b76470069a0509c8f1c5b3&operation=ListConstituents
Entity Reference:
https://developer.blackbaud.com/skyapi/products/renxt/constituent/entities#Constituent
Constituents are the individuals and organizations who support your organization by contributing time, money, and resources. The constituent entity stores information about donors, prospects, volunteers, general supporters, and more.
Constituents - List Constituent Codes
API Endpoint: https://developer.sky.blackbaud.com/api#api=56b76470069a0509c8f1c5b3&operation=ListConstituentCodesAllConstituents
Entity Reference:
https://developer.blackbaud.com/skyapi/products/renxt/constituent/entities#ConstituentCode
Constituent codes define the high-level affiliations between constituents and your organization — such as Board member, Vendor, and Volunteer — to provide context for why constituents are in the database.
Fundraising- List Funds
API Endpoint:
https://developer.sky.blackbaud.com/api#api=58bdd6c8d7dcde06046081d7&operation=ListFunds
Entity Reference:
https://developer.blackbaud.com/skyapi/products/renxt/fundraising/entities#Fund
Funds represent how donors expect you to use their gifts. Funds can designate gifts for specific causes or earmark them for specific financial purposes.
Gifts - List Gifts
API Endpoint:
https://developer.sky.blackbaud.com/api#api=58bdd5edd7dcde06046081d6&operation=ListGifts
Entity Reference:
https://developer.blackbaud.com/skyapi/products/renxt/gift/entities#Gift
Gifts are the primary goal of fundraising efforts. They come in many forms and have a lot of information associated with them to ensure that they are properly allocated and acknowledged.
Opportunities - List Opportunities
API Endpoint:
https://developer.sky.blackbaud.com/api#api=58e3b2597c1af25c58b9c4e3&operation=ListOpportunities
Entity Reference:
https://developer.blackbaud.com/skyapi/products/renxt/opportunity/entities#Opportunity
Opportunities help you plan and track efforts to build relationships with prospects and secure major gifts. They can manage information about fundraising activities and the effectiveness of your efforts.
Resources
Civis Help documentation:
- Raiser’s Edge NXT API Reference: https://developer.blackbaud.com/skyapi/products/renxt
- Blackbaud documentation on authorization: https://developer.blackbaud.com/skyapi/docs/authorization
- Application Scopes: https://developer.blackbaud.com/skyapi/docs/applications/scopes
- Civis Blackbaud SKY Authorization: https://support.civisanalytics.com/hc/en-us/articles/35075205046669-Blackbaud-SKY-API-Authorization
Comments
0 comments
Please sign in to leave a comment.