The Raiser’s Edge Decoded A First Look at The Raiser’s Edge API www.zeidman.info 20 th October 2008 David Zeidman – Zeidman Development

What is an API? Application Programming Interface Ability to integrate and extend an application The Raiser’s Edge Blackbaud’s Infinity platform Facebook Google Office – Excel, Outlook, Word

Application Programming Interface

Ability to integrate and extend an application

The Raiser’s Edge

Blackbaud’s Infinity platform

Facebook

Google

Office – Excel, Outlook, Word

What is The Raiser’s Edge API? Term is used in many contexts: The coding interface The optional module RE:API The optional module RE:VBA Some or all of the above

Term is used in many contexts:

The coding interface

The optional module RE:API

The optional module RE:VBA

Some or all of the above

What can the API do? Capture The Raiser’s Edge actions (VBA) Custom forms Integrate The Raiser’s Edge with other applications Plug-Ins Custom stand alone applications Interaction with web applications

Capture The Raiser’s Edge actions (VBA)

Custom forms

Integrate The Raiser’s Edge with other applications

Plug-Ins

Custom stand alone applications

Interaction with web applications

Areas of The Raiser’s Edge Included All records (constituents, gifts, events, etc) Reports Static Queries (not dynamic) Most of Batch Code tables Some security

Included

All records (constituents, gifts, events, etc)

Reports

Static Queries (not dynamic)

Most of Batch

Code tables

Some security

Areas of The Raiser’s Edge Excluded Global Change module Export Security users and groups Merge NetSolutions Queue Default sets

Excluded

Global Change module

Export

Security users and groups

Merge

NetSolutions

Queue

Default sets

VBA – Visual Basic for Applications Microsoft Technology Embedded in Excel, Access, Word and The Raiser’s Edge Captures program events Direct interaction with current tasks Can be installed system wide or on a per workstation basis Requires RE:VBA to use

Microsoft Technology

Embedded in Excel, Access, Word and The Raiser’s Edge

Captures program events

Direct interaction with current tasks

Can be installed system wide or on a per workstation basis

Requires RE:VBA to use

Capturing Raiser’s Edge actions (VBA) Data from the constituent record

Data from the constituent record

Capturing Raiser’s Edge actions (VBA) Save a Gift Gift saved with attribute copy Fetch constituent attribute Add to gift

Capturing Raiser’s Edge actions (VBA) Data added to the gift

Data added to the gift

Custom forms integrating with other applications Integrating with the animal adoption database Form can be shown from a record

Integrating with the animal adoption database

Form can be shown from a record

Custom forms integrating with other applications The constituent record is opened, the macro button pressed

The constituent record is opened, the macro button pressed

Custom forms integrating with other applications The custom form shows the constituents animal adoption details

The custom form shows the constituents animal adoption details

Plug-Ins Isolated applications Requires user interaction Must be installed on each client No extra cost

Isolated applications

Requires user interaction

Must be installed on each client

No extra cost

Plug-Ins

Plug-Ins – Events Integration with Google Calendar Global add of events to Google calendar Add event on save (RE:VBA)

Global add of events to Google calendar

Add event on save (RE:VBA)

Plug-Ins – Events Integration with Google Calendar Set up the integration

Set up the integration

Plug-Ins – Events Integration with Google Calendar Globally add events to Google Calendar

Globally add events to Google Calendar

Plug-Ins – Events Integration with Google Calendar Event added to Google Calendar

Event added to Google Calendar

Custom Application – Newspaper affiliate Specific constituent and action fields required only Ability to add new subscribers / constituents Ability to both read and edit limited constituent and action fields No access to fundraising information

Specific constituent and action fields required only

Ability to add new subscribers / constituents

Ability to both read and edit limited constituent and action fields

No access to fundraising information

Custom Application – Newspaper affiliate Search among limited constituents (due to security by constituency code)

Search among limited constituents (due to security by constituency code)

Custom Application – Newspaper affiliate A specially designed subscriber window

A specially designed subscriber window

Custom Application – Newspaper affiliate All Information corresponds to constituent and action data

All Information corresponds to constituent and action data

Custom Website Integration Three types: Batch – offline update Real time – read and update Combination – read real time, batch update

Three types:

Batch – offline update

Real time – read and update

Combination – read real time, batch update

Custom Website Integration - Batch No direct link to The Raiser’s Edge Often one way flow into The Raiser’s Edge Plug-in to validate data before update RE:API not required Delays cause synchronisation issues “ Safest” option

No direct link to The Raiser’s Edge

Often one way flow into The Raiser’s Edge

Plug-in to validate data before update

RE:API not required

Delays cause synchronisation issues

“ Safest” option

Custom Website Integration – Real time Read and update in real time Direct link to API Strong validation required Risk for bad data The Raiser’s Edge uptime requirement Can be best user experience

Read and update in real time

Direct link to API

Strong validation required

Risk for bad data

The Raiser’s Edge uptime requirement

Can be best user experience

Custom Website Integration – Combination Direct read from API Updates validated by plug-in offline Some synchronisation issues possible Best of both solutions Good user experience

Direct read from API

Updates validated by plug-in offline

Some synchronisation issues possible

Best of both solutions

Good user experience

NetCommunity and the API Already a close interaction Extended through the creation of custom parts

Already a close interaction

Extended through the creation of custom parts

NetCommunity and the API

NetCommunity and the API

NetCommunity and the API

API Links www.zeidman.info – Free plugins and plugin directory www.re-decoded.com – API blog with code examples www.blackbaud.com/support/faqs/re7vbaapi.aspx - Official API FAQ forums.blackbaud.com/forums/20.aspx – Official API forum www.blackbus.org/forum/api-vba/ - Blackbus API forum www.customizingnetcommunity.com – Netcommunity blog www.usna.com – Great NetCommunity Custom parts implementation

www.zeidman.info – Free plugins and plugin directory

www.re-decoded.com – API blog with code examples

www.blackbaud.com/support/faqs/re7vbaapi.aspx - Official API FAQ

forums.blackbaud.com/forums/20.aspx – Official API forum

www.blackbus.org/forum/api-vba/ - Blackbus API forum

www.customizingnetcommunity.com – Netcommunity blog

www.usna.com – Great NetCommunity Custom parts implementation