Overview
The Lyftron Provider for Blackbaud FE NXT offers the most natural way to access Blackbaud FE NXT data from Lyftron with ease and also enables to connect with BI, MDM & ML tools, Data warehouses, Databases and other SAAS based applications with zero code and zero infrastructure requirements. The provider wraps the complexity of accessing Blackbaud FE NXT data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s Blackbaud FE NXT data provider and automatically build your data migration pipelines in minutes, not months
The provider hides the complexity of accessing data and provides additional powerful security features, smart caching, batching, socket management, and more.
Key Features
- Comprehensive Delta load mechanism.
- Real-time access to Blackbaud FE NXT.
- Comprehensive full support of ANSI Sql to query data with ease.
- Collaborative query processing.
Prerequisites
The user must have credentials for Blackbaud FE NXT, Lyftron and your destination data warehouse, lake or database to perform the data pipeline operation with Lyftron
Establishing a Connection with Lyftron's Quickstart Steps
Create your Blackbaud FE NXT connection with Lyftron by following the 5 easy steps show below:
Step1. Add your connection
Click on Connect section on the left panel → Click on Add Connection button
Step2. Select your connector
In the connector selection panel, search and click Blackbaud FE NXT for your connection
Step3. Enter your connection details
In the Connection String section enter the values of the below parameters. The following connection string is required to establish Blackbaud FE NXT connection with Lyftron.
"InitiateOAuth=GETANDREFRESH;SubscriptionKey=MySubscriptionKey;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;"Key | Value | Field |
Connection Name | Enter your connection details | Required |
InitiateOAuth | GETANDREFRESH | Required |
SubscriptionKey | Your Blackbaud FE NXT SubscriptionKey | Required |
OAuthClientId | Your Blackbaud FE NXT OAuthClientId | Required |
OAuthClientSecret | Your Blackbaud FE NXT OAuthClientSecret | Required |
CallbackURL | http://localhost:33333 | Required |
Logfile** | Use the logfile option to debug your job and provide your connection name to generate the log file. [ConnectionConfigurationPath]\Connection_name_log.tx | Optional |
Verbosity** | Choose verbosity 1-5 based on the severity of debugging | Optional |
** For more information, check the Lyftron logging and debugging section.
If you want more detailed information about how to establish a connection with Lyftron, click on Lyftron Connection Quick Start guide.
Step4. Test your connection
Once you are done entering your connection details, simply click on the Test Connection button to test the connectivity. In case your connection fails, add Logfile and Verbosity parameters and check the Lyftron logging and debugging section, to debug the error.
Step5. Save your connection
Hurray! Now you have successfully connected with the Lyftron Blackbaud FE NXT connector and can utilize the connector to Extract, Warehouse, Analyze, Visualize and Share your data.
Data Model
The Lyftron Provider for Blackbaud Financial Edge NXT 2019 models Blackbaud Financial Edge NXT objects as relational views. A Blackbaud Financial Edge NXT object has relationships to other objects; in the views, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to Blackbaud Financial Edge NXT APIs.
Schemas for most database objects are defined in simple, text-based configuration files. For the views that may have custom fields, the columns are being listed dynamically. When the authenticated user changes custom fields for some objects, they will be reflected in the respective views.
The provider offloads as much of the SELECT statement processing as possible to the Blackbaud Financial Edge NXT APIs and then processes the rest of the query in memory.
Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.
Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.
Name | Type | Description |
AccountCashflows | Views | Returns the list of available cashflow values |
AccountCodes | Views | Returns the account codes. |
AccountFundRequirements | Views | Returns the requirements for the account funds. |
AccountFunds | Views | Returns the account funds. |
Accounts | Views | Retrieve and query accounts. |
AccountSegments | Views | Returns the specified account segment value. |
AccountStructures | Views | Returns a list of account structures. |
AccountWorkingCapitals | Views | Returns the list of available working capital values |
BatchValidations | Views | Returns the results of batch validation. |
BudgetAccounts | Views | Returns details for every fiscal period and account in scenario. |
BudgetDetails | Views | Returns the specified budget details. |
BudgetFiscalPeriods | Views | Returns details for every fiscal period in a budget scenario. |
BudgetGrants | Views | Returns details for every fiscal period and grant in scenario. |
BudgetLines | Views | Returns the specified budget lines. |
BudgetProjects | Views | Returns details for every fiscal period and project in scenario. |
Budgets | Views | Returns a top level overview of every budget scenario. |
BudgetScenarios | Views | Returns details for every scenario ID. |
CashManagementDistributionSetLineItemProjects | Views | The project distribution for the line items in the cash management distribution sets . |
CashManagementDistributionSets | Views | Returns the list of cash management distribution sets and their line items. |
Classes | Views | The list of classes |
ClientNames | Views | Returns the client type names. |
FiscalYears | Views | Returns the list of fiscal year details. |
GrantCustomFields | Views | Returns the list of grant custom field options. |
GrantStatuses | Views | Returns the list of grant statuses. |
GrantTypes | Views | Returns the list of grant types. |
JournalCodes | Views | Returns the list of all available journal codes. |
JournalEntries | Views | Retrieve and query journal entries. |
JournalEntryBatches | Views | Returns the list of journal entry batches. |
LedgerSummaries | Views | Lists general ledger summaries for the specified fiscal year and criteria. Note that summary records only exist for closed, optimized fiscal years. If any activity occurs in a fiscal period that has not since been closed and optimized, it will not be included in the GL summary record(s). |
MediaTypes | Views | Returns a list of media type options. |
PeriodSummaries | Views | Once the summarization process is complete, this is how you get data returned. |
PeriodSummariesProcessingInfo | Views | This endpoint reports on the current status of the summarize request, whether it is completed, still running, or failed. |
ProjectContactMethods | Views | Address information of contacts for projects. |
ProjectContacts | Views | The contacts for a project. |
ProjectDepartments | Views | Returns the list of project departments. |
ProjectDivisions | Views | Returns the list of project divisions. |
ProjectLocations | Views | Returns the list of project locations. |
Projects | Views | Retrieve and query projects. |
ProjectStatuses | Views | Returns the list of project statuses. |
ProjectTypes | Views | Returns the list of project types. |
TransactionCodes | Views | Returns the list of all available transaction codes. |
TransactionCodeValues | Views | Returns the list of all values for the specified transaction code. |
TransactionDistributions | Views | Returns a list of transactions matching the search criteria |
TransactionDistributionSets | Views | Returns the list of transaction distribution sets. |
Advanced Settings
To view a detailed advanced settings options, go to Blackbaud FE NXT Advanced Settings. Complete list of the parameters you can configure in the connection string can be found by clicking Connection String Parameters.