Developing Custom Parts for NetCommunity
Options
NetCommunity touts itself as an "Open Platform" that users can develop their own custom parts for. This is a great thing and we are glad that they are moving in the direction of other innovative software companies by allowing their customers to tailor the software to individual needs that were not built in to the base product feature set.
When inquiring with support on how get information about the API, I was directed to a site called Blackbaud Labs. This site had a few blog posts describing that you can develop custom parts and gave 2 sample programs.
http://labs.blackbaud.com/NetCommunit...
I was happy about this since I am rather proficient in .NET and was eager to get started building a simple customization that we needed.
As I continued to search around that site, I realized that there was no documentation for this API posted anywhere. There was one page titled "Whats new in version 5.5" which mentioned some useful functions that sounded like exactly what we wanted to use. Unfortunately there were no function names or syntax reference. Despite the fact that BBNC is currently on version 6.5, there is no reference on how to use the API. I don't see how someone can use an API without a reference. We can possibly attempt to guess the function names as we write the code. Any other API that I have ever used had a reference explaining the available functions, the parameters they accept, and the expected output. Here is an example of a very simple one: https://developers.google.com/ad-exch...
I can't believe I am the first person who tried to do this. Does anyone know where I can find the documentation for this BBNC API?
When inquiring with support on how get information about the API, I was directed to a site called Blackbaud Labs. This site had a few blog posts describing that you can develop custom parts and gave 2 sample programs.
http://labs.blackbaud.com/NetCommunit...
I was happy about this since I am rather proficient in .NET and was eager to get started building a simple customization that we needed.
As I continued to search around that site, I realized that there was no documentation for this API posted anywhere. There was one page titled "Whats new in version 5.5" which mentioned some useful functions that sounded like exactly what we wanted to use. Unfortunately there were no function names or syntax reference. Despite the fact that BBNC is currently on version 6.5, there is no reference on how to use the API. I don't see how someone can use an API without a reference. We can possibly attempt to guess the function names as we write the code. Any other API that I have ever used had a reference explaining the available functions, the parameters they accept, and the expected output. Here is an example of a very simple one: https://developers.google.com/ad-exch...
I can't believe I am the first person who tried to do this. Does anyone know where I can find the documentation for this BBNC API?
Tagged:
0
Comments
-
I'm not aware of any other documentation than what you describe. I've developed custom parts by looking at that small amount of sample code on the labs website, but also in other places, like zeidman.info.
The way that I've managed to find out what to do if I can't find it there is to look through the object names in the header files, and also to type an object name and see what the available methods are.
It's not very good I agree. I've put some code snippets on my own blog: many pies.0 -
We're glad that you're looking to take BBNC to the next level through customization via our API! We took similar feedback about Blackbaud Labs and have recently launched an entire library of new technical documentation about Infinity and our internet products. This is located at - https://www.blackbaud.com/files/suppo...
Right now, portions of the content would solely pertain to BBNC's big brother counterpart that integrates with BBCRM instead of RE - Blackbaud Internet Solutions (BBIS). However, several articles are excellent resources for learning about the BBNC API and how custom part development would work for either BBNC or BBIS.
Blackbaud also offers customization training geared just for the developer audience in case you'd like a guided approach to learn about customization either BBIS or BBNC. Below are the 5 most relevant articles for those folks looking to customize BBNC specifically.
API: https://www.blackbaud.com/files/suppo...
Custom Part Basics: https://www.blackbaud.com/files/suppo...
Custom Handlers: https://www.blackbaud.com/files/suppo...
User Imports: https://www.blackbaud.com/files/suppo...
Example: https://www.blackbaud.com/files/suppo... (note: some Infinity specs here wouldn't apply in BBNC)0
Categories
- All Categories
- Shannon parent
- shannon 2
- shannon 1
- 21 Advocacy DC Users Group
- 14 BBCRM PAG Discussions
- 89 High Education Program Advisory Group (HE PAG)
- 28 Luminate CRM DC Users Group
- 8 DC Luminate CRM Users Group
- Luminate PAG
- 5.9K Blackbaud Altru®
- 58 Blackbaud Award Management™ and Blackbaud Stewardship Management™
- 409 bbcon®
- 2.1K Blackbaud CRM™ and Blackbaud Internet Solutions™
- donorCentrics®
- 1.1K Blackbaud eTapestry®
- 2.8K Blackbaud Financial Edge NXT®
- 1.1K Blackbaud Grantmaking™
- 527 Education Management Solutions for Higher Education
- 1 JustGiving® from Blackbaud®
- 4.6K Education Management Solutions for K-12 Schools
- Blackbaud Luminate Online & Blackbaud TeamRaiser
- 16.4K Blackbaud Raiser's Edge NXT®
- 4.1K SKY Developer
- 547 ResearchPoint™
- 151 Blackbaud Tuition Management™
- 1 YourCause® from Blackbaud®
- 61 everydayhero
- 3 Campaign Ideas
- 58 General Discussion
- 115 Blackbaud ID
- 87 K-12 Blackbaud ID
- 6 Admin Console
- 949 Organizational Best Practices
- 353 The Tap (Just for Fun)
- 235 Blackbaud Community Feedback Forum
- 55 Admissions Event Management EAP
- 18 MobilePay Terminal + BBID Canada EAP
- 36 EAP for New Email Campaigns Experience in Blackbaud Luminate Online®
- 109 EAP for 360 Student Profile in Blackbaud Student Information System
- 41 EAP for Assessment Builder in Blackbaud Learning Management System™
- 9 Technical Preview for SKY API for Blackbaud CRM™ and Blackbaud Altru®
- 55 Community Advisory Group
- 46 Blackbaud Community Ideas
- 26 Blackbaud Community Challenges
- 7 Security Testing Forum
- 1.1K ARCHIVED FORUMS | Inactive and/or Completed EAPs
- 3 Blackbaud Staff Discussions
- 7.7K ARCHIVED FORUM CATEGORY [ID 304]
- 1 Blackbaud Partners Discussions
- 1 Blackbaud Giving Search™
- 35 EAP Student Assignment Details and Assignment Center
- 39 EAP Core - Roles and Tasks
- 59 Blackbaud Community All-Stars Discussions
- 20 Blackbaud Raiser's Edge NXT® Online Giving EAP
- Diocesan Blackbaud Raiser’s Edge NXT® User’s Group
- 2 Blackbaud Consultant’s Community
- 43 End of Term Grade Entry EAP
- 92 EAP for Query in Blackbaud Raiser's Edge NXT®
- 38 Standard Reports for Blackbaud Raiser's Edge NXT® EAP
- 12 Payments Assistant for Blackbaud Financial Edge NXT® EAP
- 6 Ask an All Star (Austen Brown)
- 8 Ask an All-Star Alex Wong (Blackbaud Raiser's Edge NXT®)
- 1 Ask an All-Star Alex Wong (Blackbaud Financial Edge NXT®)
- 6 Ask an All-Star (Christine Robertson)
- 21 Ask an Expert (Anthony Gallo)
- Blackbaud Francophone Group
- 22 Ask an Expert (David Springer)
- 4 Raiser's Edge NXT PowerUp Challenge #1 (Query)
- 6 Ask an All-Star Sunshine Reinken Watson and Carlene Johnson
- 4 Raiser's Edge NXT PowerUp Challenge: Events
- 14 Ask an All-Star (Elizabeth Johnson)
- 7 Ask an Expert (Stephen Churchill)
- 2025 ARCHIVED FORUM POSTS
- 322 ARCHIVED | Financial Edge® Tips and Tricks
- 164 ARCHIVED | Raiser's Edge® Blog
- 300 ARCHIVED | Raiser's Edge® Blog
- 441 ARCHIVED | Blackbaud Altru® Tips and Tricks
- 66 ARCHIVED | Blackbaud NetCommunity™ Blog
- 211 ARCHIVED | Blackbaud Target Analytics® Tips and Tricks
- 47 Blackbaud CRM Higher Ed Product Advisory Group (HE PAG)
- Luminate CRM DC Users Group
- 225 ARCHIVED | Blackbaud eTapestry® Tips and Tricks
- 1 Blackbaud eTapestry® Know How Blog
- 19 Blackbaud CRM Product Advisory Group (BBCRM PAG)
- 1 Blackbaud K-12 Education Solutions™ Blog
- 280 ARCHIVED | Mixed Community Announcements
- 3 ARCHIVED | Blackbaud Corporations™ & Blackbaud Foundations™ Hosting Status
- 1 npEngage
- 24 ARCHIVED | K-12 Announcements
- 15 ARCHIVED | FIMS Host*Net Hosting Status
- 23 ARCHIVED | Blackbaud Outcomes & Online Applications (IGAM) Hosting Status
- 22 ARCHIVED | Blackbaud DonorCentral Hosting Status
- 14 ARCHIVED | Blackbaud Grantmaking™ UK Hosting Status
- 117 ARCHIVED | Blackbaud CRM™ and Blackbaud Internet Solutions™ Announcements
- 50 Blackbaud NetCommunity™ Blog
- 169 ARCHIVED | Blackbaud Grantmaking™ Tips and Tricks
- Advocacy DC Users Group
- 718 Community News
- Blackbaud Altru® Hosting Status
- 104 ARCHIVED | Member Spotlight
- 145 ARCHIVED | Hosting Blog
- 149 JustGiving® from Blackbaud® Blog
- 97 ARCHIVED | bbcon® Blogs
- 19 ARCHIVED | Blackbaud Luminate CRM™ Announcements
- 161 Luminate Advocacy News
- 187 Organizational Best Practices Blog
- 67 everydayhero Blog
- 52 Blackbaud SKY® Reporting Announcements
- 17 ARCHIVED | Blackbaud SKY® Reporting for K-12 Announcements
- 3 Luminate Online Product Advisory Group (LO PAG)
- 81 ARCHIVED | JustGiving® from Blackbaud® Tips and Tricks
- 1 ARCHIVED | K-12 Conference Blog
- Blackbaud Church Management™ Announcements
- ARCHIVED | Blackbaud Award Management™ and Blackbaud Stewardship Management™ Announcements
- 1 Blackbaud Peer-to-Peer Fundraising™, Powered by JustGiving® Blogs
- 39 Tips, Tricks, and Timesavers!
- 56 Blackbaud Church Management™ Resources
- 154 Blackbaud Church Management™ Announcements
- 1 ARCHIVED | Blackbaud Church Management™ Tips and Tricks
- 11 ARCHIVED | Blackbaud Higher Education Solutions™ Announcements
- 7 ARCHIVED | Blackbaud Guided Fundraising™ Blog
- 2 Blackbaud Fundraiser Performance Management™ Blog
- 9 Foundations Events and Content
- 14 ARCHIVED | Blog Posts
- 2 ARCHIVED | Blackbaud FIMS™ Announcement and Tips
- 59 Blackbaud Partner Announcements
- 10 ARCHIVED | Blackbaud Impact Edge™ EAP Blogs
- 1 Community Help Blogs
- Diocesan Blackbaud Raiser’s Edge NXT® Users' Group
- Blackbaud Consultant’s Community
- Blackbaud Francophone Group
- 1 BLOG ARCHIVE CATEGORY
- Blackbaud Community™ Discussions
- 8.3K Blackbaud Luminate Online® & Blackbaud TeamRaiser® Discussions
- 5.7K Jobs Board