The Import from Blackbaud Financial Edge NXT script template imports data from a Blackbaud Financial Edge NXT SKY API object from your Financial 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/288781
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 Financial 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 Financial 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 Financial Edge NXT API umbrella:
- General Ledger - Account Details
- General Ledger - Transaction Distributions
- 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 “account_id” (for “General Ledger - Account Details”) or “transaction_id” (for “General Ledger - Transaction Distributions”), 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.
Financial Edge NXT Object Reference:
General Ledger - Account Details
API Endpoint:
https://developer.sky.blackbaud.com/api#api=56eb17a0a9db9516c46bff6f&operation=SearchAccounts
Entity Reference:
https://developer.blackbaud.com/skyapi/products/fenxt/general-ledger/entities#AccountDetail
General Ledger - Transaction Distributions
API Endpoint:
Entity Reference:
Resources
Civis Help documentation:
- Financial Edge NXT API Reference: https://developer.blackbaud.com/skyapi/products/fenxt
- 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.