Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →
How to use SQLAlchemy ORM to access Blackbaud FE NXT Data in Python
Create Python applications and scripts that use SQLAlchemy Object-Relational Mappings of Blackbaud FE NXT data.
The rich ecosystem of Python modules lets you get to work quickly and integrate your systems effectively. With the CData Python Connector for Blackbaud FE NXT and the SQLAlchemy toolkit, you can build Blackbaud FE NXT-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to Blackbaud FE NXT data to query, update, delete, and insert Blackbaud FE NXT data.
With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Blackbaud FE NXT data in Python. When you issue complex SQL queries from Blackbaud FE NXT, the CData Connector pushes supported SQL operations, like filters and aggregations, directly to Blackbaud FE NXT and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).
Connecting to Blackbaud FE NXT Data
Connecting to Blackbaud FE NXT data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.
Blackbaud Financial Edge NXT uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.
See the Getting Started guide in the CData driver documentation for more information.
Follow the procedure below to install SQLAlchemy and start accessing Blackbaud FE NXT through Python objects.
Install Required Modules
Use the pip utility to install the SQLAlchemy toolkit and SQLAlchemy ORM package:
pip install sqlalchemy
pip install sqlalchemy.orm
Be sure to import the appropriate modules:
from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker
Model Blackbaud FE NXT Data in Python
You can now connect with a connection string. Use the create_engine function to create an Engine for working with Blackbaud FE NXT data.
NOTE: Users should URL encode the any connection string properties that include special characters. For more information, refer to the SQL Alchemy documentation.
engine = create_engine("financialedgenxt:///?SubscriptionKey=MySubscriptionKey&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
Declare a Mapping Class for Blackbaud FE NXT Data
After establishing the connection, declare a mapping class for the table you wish to model in the ORM (in this article, we will model the Accounts table). Use the sqlalchemy.ext.declarative.declarative_base function and create a new class with some or all of the fields (columns) defined.
base = declarative_base()
class Accounts(base):
__tablename__ = "Accounts"
AccountId = Column(String,primary_key=True)
AccountNumber = Column(String)
...
Query Blackbaud FE NXT Data
With the mapping class prepared, you can use a session object to query the data source. After binding the Engine to the session, provide the mapping class to the session query method.
Using the query Method
engine = create_engine("financialedgenxt:///?SubscriptionKey=MySubscriptionKey&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Accounts).filter_by(ModifiedBy="System"):
print("AccountId: ", instance.AccountId)
print("AccountNumber: ", instance.AccountNumber)
print("---------")
Alternatively, you can use the execute method with the appropriate table object. The code below works with an active session.
Using the execute Method
Accounts_table = Accounts.metadata.tables["Accounts"]
for instance in session.execute(Accounts_table.select().where(Accounts_table.c.ModifiedBy == "System")):
print("AccountId: ", instance.AccountId)
print("AccountNumber: ", instance.AccountNumber)
print("---------")
For examples of more complex querying, including JOINs, aggregations, limits, and more, refer to the Help documentation for the extension.
Insert Blackbaud FE NXT Data
To insert Blackbaud FE NXT data, define an instance of the mapped class and add it to the active session. Call the commit function on the session to push all added instances to Blackbaud FE NXT.
new_rec = Accounts(AccountId="placeholder", ModifiedBy="System")
session.add(new_rec)
session.commit()
Update Blackbaud FE NXT Data
To update Blackbaud FE NXT data, fetch the desired record(s) with a filter query. Then, modify the values of the fields and call the commit function on the session to push the modified record to Blackbaud FE NXT.
updated_rec = session.query(Accounts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.ModifiedBy = "System"
session.commit()
Delete Blackbaud FE NXT Data
To delete Blackbaud FE NXT data, fetch the desired record(s) with a filter query. Then delete the record with the active session and call the commit function on the session to perform the delete operation on the provided records (rows).
deleted_rec = session.query(Accounts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()
Free Trial & More Information
Download a free, 30-day trial of the CData Python Connector for Blackbaud FE NXT to start building Python apps and scripts with connectivity to Blackbaud FE NXT data. Reach out to our Support Team if you have any questions.
Ready to get started?
Download a free trial of the Blackbaud FE NXT Connector to get started:
Download NowLearn more:
Blackbaud FE NXT Python Connector
Python Connector Libraries for Blackbaud Financial Edge NXT Data Connectivity. Integrate Blackbaud Financial Edge NXT with popular Python tools like Pandas, SQLAlchemy, Dash & petl.
Data Connectors
ETL/ ELT Solutions
Cloud & API Connectivity
OEM & Custom Drivers