Blackbaud Raiser's Edge NXT Connection Details¶
Introduction¶
Connector Version
This documentation is based on version 23.0.8803 of the connector.
Get Started¶
BlackBaud Raiser's Edge NXT Version Support
The connector leverages the SKY API to enable bidirectional access to BlackBaud Raiser's Edge NXT.
Establish a Connection¶
Authenticate via OAuth Authentication¶
You can connect after setting required connection properties for your user credentials and obtaining required access tokens using a tool such as Postman.
Before establishing a connection, supply the SubscriptionKey
, found in the BlackBaud Raiser's Edge NXT Profile.
See Using OAuth Authentication for details of the OAuth authentication flow.
Create a Custom OAuth Application¶
Create a Custom OAuth Application¶
embeds OAuth Application Credentials with branding that can be used when connecting to BlackBaud Raiser's Edge NXT via a desktop application or a headless machine.
However, you must create a custom OAuth application to connect to BlackBaud Raiser's Edge NXT via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway.
Custom OAuth applications are useful if you want to:
- control branding of the authentication dialog;
- control the redirect URI that the application redirects the user to after the user authenticates; or
- customize the permissions that you are requesting from the user.
The following sections desribe how to create and register a custom OAuth application, and how to connect it to your BlackBaud Raiser's Edge NXT environment.
Create and Register the Custom Application¶
To create an application to obtain the OAuth client credentials, the OAuthClientId
and OAuthClientSecret
:
- Go to BlackBaud Sign Up.
- Set up a developer account and get a subscription key, as described in the BlackBaud Getting Started documentation.
- Log in at
https://app.blackbaud.com/subscriptions
. - To request a subscription to an API, select
SKY API Standard Edition
. - Select
Subscribe
. A confirmation screen appears. - To submit your request, select
Confirm
.
BlackBaud sends an email notification when your request is approved. After it is approved, you can view the subscription key within your developer profile.
To register the custom OAuth application:
- From
My Applications
(seehttps://developer.blackbaud.com/apps
), selectRegister app
. - Enter your application details, including the redirect URI:
- For Desktop applications, use
http://localhost:33333
or another port of your choice. - For Web applications, use a URL where you want users to land after granting access to your custom application.
- For Desktop applications, use
- Click
Save
. Your application details are now available in the Blackbaud Marketplace.
Connect the Custom Application to Your Environment¶
Once the new application is configured and registered in the Blackbaud Marketplace, an environment administrator
must connect it to the environment where it will be used.
They should:
- Navigate to the Blackbaud Marketplace at
https://app.blackbaud.com/marketplace/
. - Visit the
Manage
page. - Select
Connect app
and specify the application ID of the custom OAuth application that was just created. - Select
Connect
.
The new application displays on the Manage
page.
Important Notes¶
Configuration Files and Their Paths¶
- All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.
Advanced Features¶
This section details a selection of advanced features of the BlackBaud Raiser's Edge NXT connector.
User Defined Views
The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
SSL Configuration
Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert
property under "Connection String Options" for more information.
Proxy
To configure the connector using private agent proxy settings, select the Use Proxy Settings
checkbox on the connection configuration screen.
Query Processing
The connector offloads as much of the SELECT statement processing as possible to BlackBaud Raiser's Edge NXT and then processes the rest of the query in memory (client-side).
User Defined Views¶
The Jitterbit Connector for Blackbaud Raisers Edge NXT allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:
- Create a JSON-formatted configuration file defining the views you want.
- DDL statements.
Define Views Using a Configuration File¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Constituents WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Define Views Using DDL Statements¶
The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.
Create a View¶
To create a new view using DDL statements, provide the view name and query as follows:
CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;
If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews
connection property.
Alter a View¶
To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:
ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
The view is then updated in the JSON configuration file.
Drop a View¶
To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.
DROP LOCAL VIEW [MyViewName]
This removes the view from the JSON configuration file. It can no longer be queried.
Schema for User Defined Views¶
User Defined Views are exposed in the UserViews
schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName
property.
Work with User Defined Views¶
For example, a SQL statement with a User Defined View called UserViews.RCustomers
only lists customers in Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
SSL Configuration¶
Customize the SSL Configuration¶
By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert
property for the available formats to do so.
Data Model¶
Overview
This section shows the available API objects and provides more information on executing SQL to BlackBaud Raiser's Edge NXT APIs.
Key Features
- The connector models BlackBaud Raiser's Edge NXT entities like documents, folders, and groups as relational views, allowing you to write SQL to query BlackBaud Raiser's Edge NXT data.
- Stored procedures allow you to execute operations to BlackBaud Raiser's Edge NXT.
- Live connectivity to these objects means any changes to your BlackBaud Raiser's Edge NXT account are immediately reflected when using the connector.
Views
Views describes the available views. Views are statically defined to model Actions, Emails, Events, etc..
Stored Procedures
Stored Procedures are function-like interfaces to BlackBaud Raiser's Edge NXT. Stored procedures allow you to execute operations to BlackBaud Raiser's Edge NXT, including downloading documents and moving envelopes.
Views¶
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Jitterbit Connector for Blackbaud Raisers Edge NXT Views¶
Name | Description |
---|---|
ActionAttachments | Retrieves a list of attachments for an action. |
ActionCustomFields | Retrieves custom fields for an action |
Actions | Retrieves a list of actions for all constituents and for specified constituent and details of the specified action. |
Addresses | Addresses store information about constituent residences and other addresses along with information about where or whether to send mail |
Aliases | Retrieves a list of aliases for a constituent |
AppealAttachments | Returns a list of attachments for an appeal. |
CampaignAttachments | Returns a list of attachments for a campaign. |
Campaigns | Campaigns are your organization's overall fundraising efforts or initiatives, such as operating expenses, new buildings, and endowments |
ConsentCategories | Returns a list of consent categories. |
ConsentChannelCategories | Returns a list of valid consent channel category combinations. |
ConsentChannels | Represents the consent channel entity |
ConsentSources | Represents the consent source entity |
ConstituentAppeals | Returns a list of appeals for a constituent. |
ConstituentAttachments | Returns a list of attachments for a constituent. |
ConstituentCodes | Constituent codes define the high-level affiliations between constituents and your organization - such as Board member, Vendor, and Volunteer - to provide context for why constituents are in the database |
ConstituentConsents | Returns a list of constituent consent records. |
ConstituentFundraiserAssignments | Returns a list of fundraiser assignments for a constituent. |
Constituents | Returns a paginated list of constituents |
ConstituentsCustomFields | Retrieves custom fields for all constituents |
ConstituentSolicitCodes | Returns a list of solicit codes for the specified constituent. |
Countries | Returns the list of available countries. |
Educations | Returns a list of educations for all constituent or a specified constituent |
Emails | Returns a list of email addresses of all constituents or a specified constituent |
EventCategories | Returns a list of active event categories. |
EventFees | Returns a list of fees for an event. |
EventParticipantGuests | The participant's basic summary information |
EventParticipantMemberships | The individual's membership category |
EventParticipantOptions | Returns the participant options for an event. |
EventParticipants | Returns a list of participants for an event. |
Events | Returns a list of events |
FundAttachments | Returns a list of attachments for a fund. |
FundraiserAssignments | Returns a list of assignments for a fundraiser. |
FundraiserGoals | Returns a list of goals for a fundraiser |
FundraisingAppeals | Returns a list of fundraising appeals. |
Funds | Returns a list of funds. |
GiftAcknowledgements | Returns a list of acknowledgements for a gift |
GiftAttachments | Returns a list of attachments for a gift. |
GiftBatches | Returns a list of gift batches. |
GiftPayments | Returns payments for a gift. |
GiftReceipts | Returns receipts for a gift. |
Gifts | Returns a paginated list of gifts |
GiftsCustomFields | Retrieves custom fields for all gifts |
GiftSoftCredits | Returns soft credits for a gift. |
GiftSplits | Returns the splits for a gift. |
Giving | Returns the first, latest or greatest gift recorded for a constituent. |
GivingAppeals | Returns the giving appeals summary for the constituent |
GivingCampaigns | Returns the giving campaigns summary for the constituent |
GivingFunds | Returns the giving funds summary for the constituent |
LifetimeGiving | Returns the lifetime giving information for a constituent. |
Lists | Returns a list of lists for the given list type |
Members | Returns the list of members. |
Memberships | Returns a list of memberships. |
Notes | Returns a list of notes that tracks helpful or important details such as specific interests and special instructions for donations |
OnlinePresences | Returns a paginated list of online presences that store a constituent's social media accounts, websites. |
Opportunities | Retrieves a list of opportunities |
OpportunitiesCustomFields | Retrieves custom fields for an opportunity |
OpportunityAttachments | Returns a list of attachments for an opportunity |
Packages | Returns a list of packages that contains content and other items for the appeals that organizations use to solicit gifts |
ParticipantFeePayments | Returns the fee payments for a participant. |
ParticipantFees | Returns a list of fees for a participant. |
ParticipantLevels | Returns a list of participation levels for all events. |
ParticipantOptions | Returns the participant options for a participant. |
Phones | Returns a list of phones for all constituents or a specific constituent |
RatingCategories | Returns a list of all available rating categories. |
Ratings | Returns a list of ratings for a constituent. |
RatingSources | Returns a list of all available rating sources. |
Relationships | Returns a list of relationships between constituents and other individuals and organizations such as family, friends, and employers |
ActionAttachments¶
Retrieves a list of attachments for an action.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: ActionId is required in order to query ActionAttachments.
ActionId
supports the=
operator.
For example:
SELECT * FROM ActionAttachments WHERE ActionId = '335'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the attachment. | |
ActionId | String | Actions.Id | The immutable system record ID of the action this attachment is associated to. |
ContentType | String | The content type. For physical attachments only. | |
Date | Datetime | The date of the attachment. | |
FileId | String | The identifier of the file. | |
FileName | String | The file name. | |
FileSize | Integer | The file size in bytes. | |
Name | String | The name of the attachment. | |
ParentId | String | The parent object's immutable system record ID. | |
Tags | String | The parent object's immutable system record ID. | |
ThumbnailId | String | The identifier of the thumbnail. | |
ThumbnailUrl | String | The URL for a thumbnail. | |
Type | String | The attachment type. | |
Url | String | The URL for the attachment. |
ActionCustomFields¶
Retrieves custom fields for an action
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id | String | The immutable system record ID of the custom field. | |
ActionId | String | The parent object's immutable system record ID. | |
Value | String | The value of the custom field. | |
Date | Datetime | The date on the custom field. | |
Category | String | The category on the custom field. | |
Commment | String | The date when the custom field was created. | |
Type | String | The type of data that the custom field represents. |
Actions¶
Retrieves a list of actions for all constituents and for specified constituent and details of the specified action.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Id
supports the=
operator.ComputedStatus
supports the=
operator.ConstituentId
supports the=
operator.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.StatusCode
supports the '=,in' operators.
For example:
SELECT * FROM Actions WHERE ConstituentId = '280'
SELECT * FROM Actions WHERE ComputedStatus = 'Completed'
SELECT * FROM Actions WHERE DateAdded >= '2010-06-01 14:03:35'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the action. | |
Category | String | The channel or intent of the constituent interaction. | |
Completed | Boolean | Indicates whether the action is complete. | |
CompletedDate | Datetime | The date when the action was completed. | |
ComputedStatus | String | The computed action status. The allowed values are Open, Completed, PastDue. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with the action. |
Date | Date | The action date. | |
DateAdded | Datetime | The date when the action was created. | |
DateModified | Datetime | The date when the action was last modified. | |
Description | String | The detailed explanation that elaborates on the action summary. | |
Direction | String | The direction of the action. | |
EndTime | String | The end time of the action. | |
Fundraisers | String | The set of immutable constituent system record IDs for the fundraisers associated with the action. | |
Location | String | The location of the action. | |
OpportunityId | String | Opportunities.Id | The immutable system record ID of the opportunity associated with the action. |
Outcome | String | The outcome of the action. Available values are Successful and Unsuccessful. | |
Priority | String | The priority of the action. | |
StartTime | String | The start time of the action. | |
Status | String | The action status. | |
StatusCode | String | The action status code. This property is only returned when the system is configured to use custom action statuses. The allowed values are Closed, Completed, Pending, Not Completed, Open, Sent, Continuous. | |
Summary | String | The short description of the action that appears at the top of the record. | |
Type | String | Additional description of the action to complement the category. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
ListId | String |
Addresses¶
Addresses store information about constituent residences and other addresses along with information about where or whether to send mail
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Id
supports the=
operator.ConstituentId
supports the=
operator.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.IncludeInactive
supports the=
operator.
For example:
SELECT * FROM Addresses WHERE ConstituentId = '280'
SELECT * FROM Addresses WHERE DateModified >= '2010-06-01 14:03:35'
SELECT * FROM Addresses WHERE IncludeInactive = true
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the address. | |
AddressLines | String | The address lines. | |
City | String | The city of the address. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with the address. |
Country | String | The country of the address. | |
County | String | The county of the address. | |
DateAdded | Datetime | The date when the address was created. | |
DateModified | Datetime | The date when the address was last modified. | |
DoNotMail | Boolean | Indicates whether the constituent requests not to be contacted at this address. | |
End | Datetime | The date when the constituent ceased to reside at this address. | |
FormattedAddress | String | The date when the constituent ceased to reside at this address. | |
Inactive | Boolean | This computed field indicates that the address is active if the current date is before any end date. | |
PostalCode | String | The postal code of the address. | |
Preferred | Boolean | Indicates whether this is the constituent's preferred address. | |
SeasonalEndD | Integer | The day of the year ceases to reside at this address. | |
SeasonalEndM | Integer | The month of the year ceases to reside at this address. | |
SeasonalEndY | Integer | The year ceases to reside at this address. | |
SeasonalStartD | Integer | The day of year that the constituent begins residing at this address. | |
SeasonalStartM | Integer | The month of year that the constituent begins residing at this address. | |
SeasonalStartY | Integer | The year that the constituent begins residing at this address. | |
Start | Datetime | The date when the constituent began residing at this address. | |
State | String | The state of the address. | |
Suburb | String | The suburb of the address. | |
Type | String | The address type. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean |
Aliases¶
Retrieves a list of aliases for a constituent
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: ConstituentId is required in order to query Aliases.
ConstituentId
supports the=
operator.
For example:
SELECT * FROM Aliases WHERE ConstituentId = '280'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the alias. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with the alias. |
Name | String | The name to use as the constituent's alias. | |
Type | String | The alias type. |
AppealAttachments¶
Returns a list of attachments for an appeal.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: AppealId is required in order to query AppealAttachments.
AppealId
supports the=
operator.
For example:
SELECT * FROM AppealAttachments WHERE AppealId = '2'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the attachment. | |
AppealId | String | FundraisingAppeals.Id | The immutable system record ID of the appeal. |
ContentType | String | The content type. For physical attachments only. | |
Date | Datetime | The date of the attachment. | |
FileId | String | The identifier of the file. | |
FileName | String | The file name. | |
FileSize | Integer | The file size in bytes. | |
Name | String | The name of the attachment. | |
ParentId | String | The parent object's immutable system record ID. | |
Tags | String | The tags associated with the attachment. | |
ThumbnailId | String | The identifier of the thumbnail. | |
ThumbnailUrl | String | The URL for a thumbnail. | |
Type | String | The attachment type. | |
Url | String | The URL for the attachment. |
CampaignAttachments¶
Returns a list of attachments for a campaign.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: CampaignId is required in order to query CampaignAttachments.
CampaignId
supports the=
operator.
For example:
SELECT * FROM CampaignAttachments WHERE CampaignId = '2'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the attachment. | |
CampaignId | String | Campaigns.Id | The immutable system record ID of the campaign. |
ContentType | String | The content type. For physical attachments only. | |
Date | Datetime | The date of the attachment. | |
FileId | String | The identifier of the file. | |
FileName | String | The file name. | |
FileSize | Integer | The file size in bytes. | |
Name | String | The name of the attachment. | |
ParentId | String | The parent object's immutable system record ID. | |
Tags | String | The tags associated with the attachment. | |
ThumbnailId | String | The identifier of the thumbnail. | |
ThumbnailUrl | String | The URL for a thumbnail. | |
Type | String | The attachment type. | |
Url | String | The URL for the attachment. |
Campaigns¶
Campaigns are your organization's overall fundraising efforts or initiatives, such as operating expenses, new buildings, and endowments
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Id
supports the=
operator.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.IncludeInactive
supports the '=' operators.
For example:
SELECT * FROM Campaigns WHERE DateModified >= '2010-06-01 14:03:35'
SELECT * FROM Campaigns WHERE IncludeInactive = true
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the campaign. | |
Category | String | The category of the campaign. | |
DateAdded | Datetime | The date when the campaign was created. | |
DateModified | Datetime | The date when the campaign was last modified. | |
Description | String | The display name of the campaign. | |
EndDate | Datetime | The end date of the campaign. | |
GoalValue | Double | The monetary goal associated with the campaign. | |
Inactive | Boolean | This computed field indicates that the campaign is active if the current date is after any start_date and before any end_date. | |
LookupId | String | The user-defined identifier for the campaign. | |
StartDate | Datetime | The start date of the campaign. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean |
ConsentCategories¶
Returns a list of consent categories.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
IncludeInactive
supports the=
operator.
For example:
SELECT * FROM ConsentCategories WHERE IncludeInactive = true
Columns¶
Name | Type | References | Description |
---|---|---|---|
Description | String | The name of the consent category. | |
Inactive | Boolean | Indicates whether the consent category is inactive. | |
Sequence | Integer | The placement of the category in the order of category table values, if defined. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean |
ConsentChannelCategories¶
Returns a list of valid consent channel category combinations.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Columns¶
Name | Type | References | Description |
---|---|---|---|
Category | String | The name of the category included in the channel/category combination. | |
Channel | String | The name of the channel included in the channel/category combination. | |
Sequence | Integer | The placement of the channel/category in the order of channel/category table values, if defined. |
ConsentChannels¶
Represents the consent channel entity
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Columns¶
Name | Type | References | Description |
---|---|---|---|
Description | String | The name of the consent channel. |
ConsentSources¶
Represents the consent source entity
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
IncludeInactive
supports the=
operator.
For example:
SELECT * FROM ConsentSources WHERE IncludeInactive = true
Columns¶
Name | Type | References | Description |
---|---|---|---|
Description | String | The name of the consent source. | |
Inactive | Boolean | Indicates whether the consent source is inactive. | |
Sequence | Integer | The placement of the source in the order of source table values, if defined. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean |
ConstituentAppeals¶
Returns a list of appeals for a constituent.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
ConstituentId
supports the=
operator.
For example:
SELECT * FROM ConstituentAppeals WHERE ConstituentId = '280'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID. | |
AppealCategoryDescription | String | The appeal category description. | |
AppealCategoryId | String | The immutable system record ID of the appeal category. | |
AppealCategoryInactive | Boolean | Indicates whether the appeal category is inactive. | |
AppealDescription | String | The appeal description. | |
AppealId | String | The immutable system record ID of the appeal. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent the appeal is associated to. |
Date | Datetime | The date when the appeal was added. | |
PackageDescription | String | The package description. | |
PackageId | String | The package Id. |
ConstituentAttachments¶
Returns a list of attachments for a constituent.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: ConstituentId is required in order to query ConstituentAttachments.
ConstituentId
supports the=
operator.
For example:
SELECT * FROM ConstituentAttachments WHERE ConstituentId = '280'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the attachment. | |
ConstituentId | String | The immutable system record ID of the constituent associated with the attachment. | |
ContentType | String | The content type. | |
Date | Datetime | The date of the attachment. | |
FileId | String | The identifier of the file. | |
FileName | String | The file name. | |
FileSize | Integer | The file size in bytes. | |
Name | String | The name of the attachment. | |
ParentId | String | The parent object's immutable system record ID. | |
Tags | String | The tags associated with the attachment. | |
Type | String | The attachment type. | |
Url | String | The URL for the attachment. |
ConstituentCodes¶
Constituent codes define the high-level affiliations between constituents and your organization - such as Board member, Vendor, and Volunteer - to provide context for why constituents are in the database
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Id
supports the=
operator.ConstituentId
supports the=
operator.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.IncludeInactive
supports the=
operator.
For example:
SELECT * FROM ConstituentCodes WHERE Id = '144'
SELECT * FROM ConstituentCodes WHERE ConstituentId = '280'
SELECT * FROM ConstituentCodes WHERE DateAdded >= '1999-10-26T15:45:27'
SELECT * FROM ConstituentCodes WHERE DateModified >= '1999-10-26T15:45:27'
SELECT * FROM ConstituentCodes WHERE IncludeInactive = true
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the constituent code. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with the constituent code. |
DateAdded | Datetime | The date when the constituent code was created. | |
DateModified | Datetime | The date when the constituent code was last modified. | |
Description | String | The description of the constituent code. | |
Inactive | Boolean | This computed field indicates that the constituent code is active if the current date is after any start date and before any end date. | |
StartD | Integer | The start day of the constituent code. | |
StartM | Integer | The start month of the constituent code. | |
StartY | Integer | The start year of the constituent code. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean |
ConstituentConsents¶
Returns a list of constituent consent records.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: ConstituentId is required in order to query ConstituentConsents.
ConstituentId
supports the=
operator.Category
supports the '=,in' operators.Channel
supports the '=,in' operators.MostRecentOnly
supports the=
operator.
For example:
SELECT * FROM ConstituentConsents WHERE ConstituentId = '280'
SELECT * FROM ConstituentConsents WHERE ConstituentId = '280' AND Channel IN ('Phone', 'Email')
SELECT * FROM ConstituentConsents WHERE ConstituentId = '280' AND Category IN ('Fundraising', 'Newsletter')
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the consent record. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent the consent is associated to. |
Category | String | The category that the consent response applies to. | |
Channel | String | The channel that the consent response applies to. | |
ConsentDate | Datetime | The date the consent response was received. | |
ConsentStatement | String | The statement the constituent responded to when providing consent. | |
ConstituentConsentResponse | String | How the constituent responded to consent for the specified channel/category. | |
DateAdded | Datetime | The date the consent response was added. | |
PrivacyNotice | String | The privacy notice provided to the constituent. | |
Source | String | The source of the consent response from the constituent. | |
UserName | String | The user that added the consent response. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
MostRecentOnly | Boolean |
ConstituentFundraiserAssignments¶
Returns a list of fundraiser assignments for a constituent.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: ConstituentId is required in order to query ConstituentFundraiserAssignments.
ConstituentId
supports the=
operator.IncludeInactive
supports the=
operator.
For example:
SELECT * FROM ConstituentFundraiserAssignments WHERE ConstituentId = '280'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the fundraiser assignment. | |
AmountValue | Double | The goal amount for the fundraiser to solicit from the assigned constituent. | |
AppealId | String | FundraisingAppeals.Id | The immutable system record ID of the appeal the fundraiser should use to request gifts. |
CampaignId | String | Campaigns.Id | The immutable system record ID of the campaign to apply resulting gifts to. |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent to apply resulting gifts to. |
End | Datetime | The fundraiser assignment end date. | |
FundId | String | Funds.Id | The immutable system record ID of the fund any resulting gifts should be applied to. |
FundraiserId | String | The immutable system record ID of the fundraiser. | |
Start | Datetime | The fundraiser assignment start date. | |
Type | String | The type of fundraiser. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean |
Constituents¶
Returns a paginated list of constituents
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Id
supports the '=,in' operators.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.FundraiserStatus
supports the '=,in' operators.ConstituentCode
supports the=
operator.CustomFieldCategory
supports the=
operator.Fields
supports the '=,in' operators.IncludeDeceased
supports the=
operator.ListId
supports the=
operator.IncludeInactive
supports the=
operator.PostalCode
supports the '=,in' operators.
For example:
SELECT * FROM Constituents WHERE Id = '280'
SELECT * FROM Constituents WHERE ListId = '75e71c26-7288-49db-a767-f9305b704fee'
SELECT * FROM Constituents WHERE FundraiserStatus IN ('Active', 'None')
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID for the constituent. | |
AddressLines | String | The address lines. | |
AddressCity | String | The city of the address. | |
AddressConstituentId | String | The immutable system record ID of the constituent associated with the address. | |
AddressCountry | String | The country of the address. | |
AddressCounty | String | The county of the address. | |
AddressDateAdded | Datetime | The date when the address was created. | |
AddressDateModified | Datetime | The date when the address was last modified. | |
AddressDoNotMail | Boolean | Indicates whether the constituent requests not to be contacted at this address. | |
AddressEnd | Datetime | The date when the constituent ceased to reside at this address. | |
AddressFormattedAddress | String | This computed field retrieves the formatted address in the configured format of the country. | |
AddressId | String | The immutable system record ID of the address. | |
AddressInactive | Boolean | This computed field indicates that the address is active if the current date is before any end date. | |
AddressPostalCode | String | The postal code of the address. | |
AddressPreferred | Boolean | Indicates whether this is the constituent's preferred address. | |
AddressSeasonalEndD | Integer | The day of the year ceases to reside at this address. | |
AddressSeasonalEndM | Integer | The month of the year ceases to reside at this address. | |
AddressSeasonalEndY | Integer | The year ceases to reside at this address. | |
AddressSeasonalStartD | Integer | The day of year that the constituent begins residing at this address. | |
AddressSeasonalStartM | Integer | The month of year that the constituent begins residing at this address. | |
AddressSeasonalStarty | Integer | The year that the constituent begins residing at this address. | |
AddressStart | Date | The date when the constituent began residing at this address. | |
AddressState | String | The state of the address. | |
AddressSuburb | String | The suburb of the address. | |
AddressType | String | The address type. | |
Age | Integer | This computed field calculates the constituent's age based on the birth date property. | |
BirthdateD | Integer | The constituent's day of birth. | |
BirthdateM | Integer | The constituent's month of birth. | |
BirthdateY | Integer | The constituent's year of birth. | |
DateAdded | Datetime | The date when the constituent was created. | |
DateModified | Datetime | The date when the constituent was last modified. | |
Deceased | String | Indicates whether the constituent is deceased. | |
DeceasedDateD | Integer | The day of the year when the constituent died. | |
DeceasedDateM | Integer | The month of year when the constituent died. | |
DeceasedDateY | Integer | The year when the constituent died. | |
EmailAddress | String | The email address. | |
EmailConstituentId | String | The immutable system record ID of the constituent associated with the email address. | |
EmailDateAdded | Datetime | The date when the email address was created. | |
EmailDateModified | Datetime | The date when the email address was last modified. | |
EmailDoNotEmail | Boolean | Indicates whether the constituent requests not to be contacted at this email address. | |
EmailId | String | The immutable system record ID of the email address. | |
EmailInactive | Boolean | Indicates whether the email address is inactive. | |
EmailPrimary | Boolean | Indicates whether this is the constituent's primary email address. | |
EmailType | String | The type of email address. Available values are the entries in the Phone Types table. | |
First | String | The constituent's first name. | |
FormerName | String | The constituent's former name. | |
FundraiserStatus | String | Indicates whether the constituent is a fundraiser. | |
Gender | String | The constituent's gender. | |
GivesAnonymously | Boolean | Indicates whether the constituent gives anonymously. | |
Inactive | Boolean | Indicates whether the constituent is inactive. | |
Last | String | The constituent's last name. | |
LookupId | String | The user-defined identifier for the constituent. | |
MaritalStatus | String | The constituent's marital status. | |
Middle | String | The constituent's middle name. | |
Name | String | If the constituent's type is Individual, this is the full name of the constituent. If the type is Organization, this is the organization's name. | |
OnlinePresenceAddress | String | The web address for the online presence. | |
OnlinePresenceConstituentId | String | The immutable system record ID of the constituent associated with the online presence. | |
OnlinePresenceDateAdded | Datetime | The date when the online presence was created. | |
OnlinePresenceDateModified | Datetime | The date when the online presence was last modified. | |
OnlinePresenceId | String | The immutable system record ID of the online presence. | |
OnlinePresenceInactive | Boolean | Indicates whether the online presence is inactive. | |
OnlinePresencePrimary | Boolean | Indicates whether this is the constituent's primary online presence. | |
OnlinePresenceType | String | The online presence type. | |
PhoneConstituentId | String | The immutable system record ID of the constituent associated with the phone. | |
PhoneDateAdded | Datetime | The date when the phone was created. | |
PhoneDateModified | Datetime | The date when the phone was last modified. | |
PhoneDoNotCall | Boolean | Indicates whether the constituent requests not to be contacted at this number. | |
PhoneId | String | The immutable system record ID of the phone. | |
PhoneInactive | Boolean | Indicates whether the phone is inactive. | |
PhoneNumber | String | The phone number. | |
PhonePrimary | Boolean | Indicates whether this is the constituent's primary phone. | |
PhoneType | String | The phone type. | |
PreferredName | String | The constituent's preferred name. | |
SpouseFirst | String | This computed field retrieves information about the constituent's spouse using the constituent's relationships. | |
SpouseId | String | This computed field retrieves information about the constituent's spouse using the constituent's relationships. | |
SpouseLast | String | This computed field retrieves information about the constituent's spouse using the constituent's relationships. | |
Suffix | String | The constituent's primary suffix. | |
Suffix2 | String | The constituent's secondary suffix. | |
Title | String | The constituent's primary title. | |
Title2 | String | The constituent's secondary title. | |
Type | String | The type of constituent. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
ConstituentCode | String | |
CustomFieldCategory | String | |
Fields | String | |
IncludeDeceased | Boolean | |
IncludeInactive | Boolean | |
ListId | String | |
PostalCode | String |
ConstituentsCustomFields¶
Retrieves custom fields for all constituents
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id | String | The immutable system record ID of the custom field. | |
ConstituentId | String | The parent object's immutable system record ID. | |
Name | String | The custom field category. | |
Value | String | The value of the custom field. | |
Comment | String | The comment on the custom field. | |
DateAdded | Datetime | The date when the custom field was created. | |
DateModified | Datetime | The date when the custom field was last modified. | |
Type | String | The type of data that the custom field represents. |
ConstituentSolicitCodes¶
Returns a list of solicit codes for the specified constituent.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: ConstituentId is required in order to query ConstituentSolicitCodes.
ConstituentId
supports the=
operator.
For example:
SELECT * FROM ConstituentSolicitCodes WHERE ConstituentId = '280'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the constituent solicit code. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with the solicit code. |
EndDate | Datetime | The end date of the solicit code. | |
SolicitCode | String | Communication instructions and/or restrictions for a constituent. | |
StartDate | Datetime | The start date of the solicit code. |
Countries¶
Returns the list of available countries.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the country. | |
Abbreviation | String | The user-defined abbreviation for the country. | |
Name | String | The country name. |
Educations¶
Returns a list of educations for all constituent or a specified constituent
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Id
supports the=
operator.ConstituentId
supports the=
operator.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.
For example:
SELECT * FROM Educations WHERE ConstituentId = '280'
SELECT * FROM Educations WHERE DateAdded >= '2010-06-01 14:03:35'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the education. | |
Campus | String | The campus. | |
ClassOf | String | The year the constituent graduated. | |
ClassOfDegree | String | The class of degree. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with the education. |
DateAdded | Datetime | The date when the education was created. | |
DateEnteredD | Integer | The first day of attendance. | |
DateEnteredM | Integer | The first month of attendance. | |
DateEnteredY | Integer | The first year of attendance. | |
DateGraduatedD | Integer | The graduation day. | |
DateGraduatedM | Integer | The graduation month. | |
DateGraduatedY | Integer | The graduation year. | |
DateLeftD | Integer | The last day of attendance. | |
DateLeftM | Integer | The last month of attendance. | |
DateLeftY | Integer | The last year of attendance. | |
DateModified | Datetime | The date when the education was last modified. | |
Degree | String | The degree received. | |
Department | String | The name of the education department. | |
Faculty | String | The name of the faculty. | |
Gpa | Double | The grade point average. | |
KnownName | String | The known name. | |
Majors | String | The major courses of study. | |
Minors | String | The minor courses of study. | |
Primary | Boolean | Indicates whether this is the constituent's primary school association. | |
RegistrationNumber | String | The registration number. | |
School | String | The school name. | |
SocialOrganization | String | The social organization. | |
Status | String | The status of the education. | |
SubjectOfStudy | String | The subject of study. | |
Type | String | The type of education. |
Emails¶
Returns a list of email addresses of all constituents or a specified constituent
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
ConstituentId
supports the '=,in' operators.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.IncludeInactive
supports "=" operator.
For example:
SELECT * FROM Emails WHERE ConstituentId = '280'
SELECT * FROM Emails WHERE DateAdded >= '2010-06-01 14:03:35'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the email address. | |
Address | String | The email address. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with the email address. |
DateAdded | Datetime | The date when the email address was created. | |
DateModified | Datetime | The date when the email address was last modified. | |
DoNotEmail | Boolean | Indicates whether the constituent requests not to be contacted at this email address. | |
Inactive | Boolean | Indicates whether the email address is inactive. | |
Primary | Boolean | Indicates whether this is the constituent's primary email address. | |
Type | String | The type of email address. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean |
EventCategories¶
Returns a list of active event categories.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
IncludeInactive
supports the=
operator.
For example:
SELECT * FROM EventCategories WHERE IncludeInactive = true
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The ID of the event category. | |
Inactive | Boolean | Whether the category is inactive. True if inactive. | |
Name | String | The name of the event category. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean |
EventFees¶
Returns a list of fees for an event.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: EventId is required in order to query EventFees.
EventId
supports the=
operator.
For example:
SELECT * FROM EventFees WHERE EventId = '2'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The ID of the event fee. | |
ContributionAmount | Double | The tax deductible amount for this fee. | |
Cost | Double | The fee's cost. | |
EventId | String | Events.Id | The ID of the event the fee is linked to. |
Name | String | The name of the event fee. | |
NumberSold | Integer | The number of fees sold. |
EventParticipantGuests¶
The participant's basic summary information
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: EventId is required in order to query EventParticipantGuests.
EventId
supports the=
operator.
For example:
SELECT * FROM EventParticipantGuests WHERE EventId = '2'
Columns¶
Name | Type | References | Description |
---|---|---|---|
ContactId | String | The ID of the contact attending the event. | |
EventId | String | Events.Id | The ID of the event which the participant belongs to. |
Name | String | The participant's full name. | |
ParticipantId | String | The ID of the participant. |
EventParticipantMemberships¶
The individual's membership category
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: EventId is required in order to query EventParticipantMemberships.
EventId
supports the=
operator.
For example:
SELECT * FROM EventParticipantMemberships WHERE EventId = '2'
Columns¶
Name | Type | References | Description |
---|---|---|---|
CategoryId | String | The ID of the membership category. | |
CategoryName | String | The name of the membership category. | |
EventId | String | Events.Id | The ID of the event which the participant belongs to. |
EventParticipantOptions¶
Returns the participant options for an event.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: EventId is required in order to query EventParticipantOptions.
EventId
supports the=
operator.
For example:
SELECT * FROM EventParticipantOptions WHERE EventId = '2'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The ID of the event participant option. | |
EventId | String | Events.Id | The ID of the event which the participant belongs to. |
AddedByService | String | The ID of the service who added this option. | |
AddedByUser | String | The ID of the user that added this option. | |
DateAdded | Datetime | The date this option was added. | |
DateUpdated | Datetime | The date this option was updated. | |
InputType | String | The available types of event participant options. | |
ListOptions | String | A event participant option list option. | |
MultiSelect | Boolean | Only valid for List input type, determines if multiple options can be selected. | |
Name | String | The name of the event participant option. | |
ParticipantId | String | The ID of the participant. | |
UpdatedByService | String | The ID of the service who updated this option. | |
UpdatedByUser | String | The ID of the user who updated this option. | |
Version | Integer | The version number of the option. |
EventParticipants¶
Returns a list of participants for an event.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: EventId is required in order to query EventParticipants.
Attended
supports the=
operator.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.EventId
supports the=
operator.InvitationStatus
supports the=
operator.IsConstituent
supports the=
operator.ParticipationLevelName
supports the '=,in' operators.RsvpStatus
supports the '=,in' operators.EmailEligible
supports the=
operator.PhoneCallEligible
supports the=
operator.FeesPaid
supports the=
operator.Fields
supports the=
operator.
For example:
SELECT * FROM EventParticipants WHERE EventId = '2'
SELECT * FROM EventParticipants WHERE EventId = '2' AND DateAdded >= '2010-06-01 14:03:35'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The ID of the participant. | |
Attended | Boolean | Whether the participant attended the event. | |
ClassOf | String | The participant's graduating class. | |
ContactId | String | The ID of the contact attending the event. | |
DateAdded | Datetime | The date the participant was created. | |
DateModified | Datetime | The date when the participant was last modified. | |
DoNotCall | Boolean | The participant's phone call preference. | |
DoNotEmail | Boolean | The participant's email preference. | |
Email | String | The participant's email address. | |
EventId | String | Events.Id | The ID of the event which the participant belongs to. |
FirstName | String | The participant's first name. | |
FormerName | String | The participant's former name. | |
HostContactId | String | The ID of the contact attending the event. | |
HostName | String | The participant's full name. | |
HostParticipantId | String | The ID of the host participant. | |
InvitationStatus | String | The possible states for a constituent's invitation to an event. | |
IsConstituent | Boolean | Indicates whether the participant is a constituent. | |
LastName | String | The participant's last name. | |
LookupId | String | The LookupId of the participant. | |
MiddleName | String | The participant's middle name. | |
Name | String | The participant's full name. | |
NameTag | String | The name tag for the participant. | |
ParticipationLevelId | String | The ID of the participation level. | |
ParticipationLevelIsInactive | Boolean | Whether the participation level is inactive. True if inactive. | |
ParticipationLevelName | String | The name of the participation level. | |
Phone | String | The participant's phone number. | |
PreferredName | String | The participant's preferred name. | |
RsvpDateD | Integer | The day in the fuzzy date. | |
RsvpDateM | Integer | The month in the fuzzy date. | |
RsvpDateY | Integer | The year in the fuzzy date. | |
RsvpStatus | String | The possible states for a participant's RSVP for an event. | |
Seat | String | The seat assignment for the participant. | |
Suffix | String | The participant's suffix. | |
Title | String | The participant's title. | |
TotalPaid | Integer | The sum of the participant's paid gifts with a type of Registration Fees. | |
TotalRegistrationFees | Integer | The sum of the participant's fee amounts. | |
SummaryNote | String | summary Notes. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
EmailEligible | Boolean | |
PhoneCallEligible | Boolean | |
FeesPaid | Boolean | |
Fields | String |
Events¶
Returns a list of events
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Id
supports the=
operator.CategoryName
supports the=
operator.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.Name
supports the=
operator.StartDate
supports the '>=,<=' operators.IncludeInactive
supports the=
operator.Fields
supports the=
operator.
For example:
SELECT * FROM Events WHERE Id = '2'
SELECT * FROM Events WHERE StartDate >= '2000-04-06T05:50:00' AND StartDate <= '2020-04-06T06:50:00'
SELECT * FROM Events WHERE DateAdded >= '2010-06-01 14:03:35'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The ID of the event. | |
AttendedCount | Integer | The number of event attendees. | |
AttendingCount | Integer | The number of event participants who plan to attend. | |
CampaignId | String | The ID of the campaign affiliated with the event. | |
Capacity | Integer | The number of people that can attend the event. | |
CategoryId | String | The ID of the event category. | |
CategoryInactive | Boolean | Whether the category is inactive. | |
CategoryName | String | The name of the event category. | |
DateAdded | Datetime | The date when the event was created. | |
DateModified | Datetime | The date when the event was last modified. | |
EndDate | Datetime | The end date of the event. | |
EndTime | String | The end time of the event. | |
FundId | String | The ID of the fund affiliated with the event. | |
Goal | Double | The monetary goal of the event. | |
Inactive | Boolean | Whether the event is inactive. | |
InvitedCount | Integer | The number of event invitees. | |
LocationName | String | The name of the location. | |
LocationAddressLines | String | The location's address lines. | |
LocationPostalCode | String | The location's postal code. | |
LocationLocalityId | String | The record ID of the locality record. | |
LocationLocalityName | String | The name of the locality. | |
LocationAdministrativeAreaId | String | The record ID of the administrative area. | |
LocationAdministrativeAreaName | String | The name of the administrative area. | |
LocationAdministrativeAreaShortDesc | String | The short description of the administrative area. | |
LocationSubAdministrativeAreaId | String | The ID of the sub administrative area. | |
LocationSubAdministrativeAreaName | String | The name of the sub administrative area. | |
LocationCountryId | String | The ID of the country record. | |
LocationCountryDisplayName | String | The display name of the country. | |
LocationCountryIsoAlpha2Code | String | The ISO 3166-1 alpha-2 code for the country. | |
LocationFormattedAddress | String | The location's formatted address. | |
LookupId | String | The lookup ID of the event. | |
Name | String | The name of the event. | |
StartDate | Date | The start date of the event. | |
StartTime | String | The start time of the event. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Fields | String | |
IncludeInactive | Boolean |
FundAttachments¶
Returns a list of attachments for a fund.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: FundId is required in order to query FundAttachments.
FundId
supports the=
operator.
For example:
SELECT * FROM FundAttachments WHERE FundId = '4'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the attachment. | |
FundId | String | Funds.Id | The immutable system record ID of the fund. |
ContentType | String | The content type. For physical attachments only. | |
Date | Datetime | The date of the attachment. | |
FileId | String | The identifier of the file. | |
FileName | String | The file name. | |
FileSize | Integer | The file size in bytes. | |
Name | String | The name of the attachment. | |
ParentId | String | The parent object's immutable system record ID. | |
Tags | String | The tags associated with the attachment. | |
ThumbnailId | String | The identifier of the thumbnail. | |
ThumbnailUrl | String | The URL for a thumbnail. | |
Type | String | The attachment type. | |
Url | String | The URL for the attachment. |
FundraiserAssignments¶
Returns a list of assignments for a fundraiser.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: FundraiserId is required in order to query FundraiserAssignments.
FundraiserId
supports the=
operator.
For example:
SELECT * FROM FundraiserAssignments WHERE FundraiserId = '4'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id | String | The immutable system record ID of the given assignment. | |
AmountValue | Double | The goal amount for the fundraiser to solicit from the assigned constituent. | |
AppealId | String | FundraisingAppeals.Id | The immutable system record ID of the appeal the fundraiser should use to request gifts. |
CampaignId | String | Campaigns.Id | The immutable system record ID of the campaign to apply resulting gifts to. |
ConstituentId | String | Constituents.Id | The immutable system record ID of the target constituent. |
End | Datetime | The fundraiser end date. | |
FundId | String | Funds.Id | The immutable system record ID of the fund any resulting gifts should be applied to. |
FundraiserId | String | The immutable system record ID of the fundraiser assigned to the constituent. | |
Start | Date | The fundraiser start date. | |
Type | String | The type of fundraiser. |
FundraiserGoals¶
Returns a list of goals for a fundraiser
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: FundraiserId is required in order to query FundraiserGoals.
FundraiserId
supports the=
operator.
For example:
SELECT * FROM FundraiserGoals WHERE FundraiserId = '4'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the fundraiser goal. | |
AmountValue | Double | The fundraiser goal amount. | |
AppealId | String | FundraisingAppeals.Id | The immutable system record ID of the appeal associated with the fundraiser goal. |
CampaignId | String | Campaigns.Id | The immutable system record ID of the campaign associated with the fundraiser goal. |
FundId | String | Funds.Id | The immutable system record ID of the fund associated with the fundraiser goal. |
FundraiserId | String | The immutable system record ID of the fundraiser associated with the fundraiser goal. | |
Type | String | The fundraiser goal type. Available values are Campaign, Fund, UnspecifiedCategory, and Appeal. | |
UnspecifiedCategoryName | String | The unspecified category name for the fundraiser goal. |
FundraisingAppeals¶
Returns a list of fundraising appeals.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Id
supports the '=,in' operators.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.IncludeInactive
supports the=
operator.
For example:
SELECT * FROM FundraisingAppeals WHERE Id = '4'
SELECT * FROM FundraisingAppeals WHERE IncludeInactive = true
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the appeal. | |
Category | String | The category of the appeal. | |
DateAdded | Datetime | The date when the appeal was created. | |
DateModified | Datetime | The date when the appeal was last modified. | |
Description | String | The display name of the appeal. | |
EndDate | Datetime | The end date of the appeal. | |
GoalValue | Double | The monetary goal associated with the appeal. | |
Inactive | Boolean | This computed field indicates that the appeal is active if the current date is after any start_date and before any end_date. | |
LookupId | String | The user-defined identifier for the appeal. | |
StartDate | Datetime | The start date of the appeal. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean |
Funds¶
Returns a list of funds.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Id
supports the '=,in' operators.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.IncludeInactive
supports the=
operator.
For example:
SELECT * FROM Funds WHERE Id = '4'
SELECT * FROM Funds WHERE IncludeInactive = true
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the fund. | |
Category | String | The category of the fund. | |
DateAdded | Datetime | The date when the fund was created. | |
DateModified | Datetime | The date when the fund was last modified. | |
Description | String | The display name of the fund. | |
EndDate | Datetime | The end date of the fund. | |
GoalValue | Double | The monetary goal associated with the fund. | |
Inactive | Boolean | This computed field indicates that the fund is active if the current date is after any start_date and before any end_date. | |
LookupId | String | The user-defined identifier for the fund. | |
StartDate | Datetime | The start date of the fund. | |
Type | String | The type of the fund. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean |
GetPledgeInstallments¶
This gets the installments of an existing pledge gift.
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | ID | |
GiftId | String | Gifts.Id | The immutable system record ID of the gift the attachments are associated to. |
AmountValue | Double | The Amount Value. | |
Date | Datetime | Date | |
Sequence | Integer | Sequence | |
Year | Integer | Year |
GetPledgePayments¶
This gets the payments of an existing pledge gift.
Columns¶
Name | Type | References | Description |
---|---|---|---|
PaymentGiftId [KEY] | String | The Payment Gift Id. | |
InstallmentId | String | The ID for the installment. | |
GiftId | String | Gifts.Id | The immutable system record ID of the gift the attachments are associated to. |
AmountAppliedValue | Double | The amount applied value. |
GiftAcknowledgements¶
Returns a list of acknowledgements for a gift
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: GiftId are required in order to query GiftAcknowledgements.
GiftId
supports the=
operator.
For example:
SELECT * FROM GiftAcknowledgements WHERE GiftId = '476'
Columns¶
Name | Type | References | Description |
---|---|---|---|
GiftId | String | Gifts.Id | The immutable system record ID of the gift associated with the acknowledgement. |
Date | Datetime | The date associated with the acknowledgement. | |
Letter | String | The letter associated with the acknowledgement. | |
Status | String | The status of the acknowledgement. Available values are: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT, and DONOTACKNOWLEDGE. |
GiftAttachments¶
Returns a list of attachments for a gift.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: GiftId are required in order to query GiftAttachments.
GiftId
supports the=
operator.
For example:
SELECT * FROM GiftAttachments WHERE GiftId = '476'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the attachment. | |
GiftId | String | Gifts.Id | The immutable system record ID of the gift the attachments are associated to. |
ContentType | String | The content type. For physical attachments only. | |
Date | Datetime | The date of the attachment. | |
FileId | String | The identifier of the file. | |
FileName | String | The file name. | |
FileSize | Integer | The file size in bytes. | |
Name | String | The name of the attachment. | |
ParentId | String | The parent object's immutable system record ID. | |
Tags | String | The tags associated with the attachment. | |
ThumbnailId | String | The identifier of the thumbnail. | |
ThumbnailUrl | String | The URL for a thumbnail. | |
Type | String | The attachment type. | |
Url | String | The URL for the attachment. |
GiftBatches¶
Returns a list of gift batches.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
BatchNumber
supports the=
operator.CreatedBy
supports the=
operator.HasExceptions
supports the=
operator.IsApproved
supports the=
operator.SearchText
supports the=
operator.
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The batch identifier. | |
ActualAmount | Integer | The actual batch amount. | |
BatchDescription | String | The batch description. | |
BatchNumber | String | The batch number. | |
CreatedBy | String | Created by user name. | |
AddedBy | String | Added by user name. | |
CreatedOn | Datetime | The date the batch was created. | |
DateAdded | Datetime | The date the batch was added. | |
HasExceptions | Boolean | The has exceptions boolean. | |
IsApproved | Boolean | Approved boolean. | |
Approved | Boolean | Approved boolean. | |
NumberOfGifts | Integer | The number of gifts in the batch. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
SearchText | String |
GiftPayments¶
Returns payments for a gift.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: GiftId are required in order to query GiftPayments.
GiftId
supports the=
operator.
For example:
SELECT * FROM GiftPayments WHERE GiftId = '476'
Columns¶
Name | Type | References | Description |
---|---|---|---|
GiftId | String | Gifts.Id | The immutable system record ID of the gift associated with the payment. |
AccountToken | String | The tokenized account information (e.g. credit card) from the external payment provider. Only applies to payment methods of CreditCard and DirectDebit. | |
BbpsConfigurationId | String | The bbps configuration ID. Only applies to payment methods of CreditCard and DirectDebit. | |
BbpsTransactionId | String | The bbps transaction ID. Only applies to payment methods of CreditCard and DirectDebit. | |
CheckDateD | String | The day of the check date. Only applies to payment method of PersonalCheck. | |
CheckDateM | String | The month of the check date. Only applies to payment method of PersonalCheck. | |
CheckDateY | String | The year of the check date. Only applies to payment method of PersonalCheck. | |
CheckNumber | String | The check number. Only applies to payment method of PersonalCheck. | |
CheckoutTransactionId | String | The checkout transaction ID. Only applies to payment methods of CreditCard and DirectDebit. | |
PaymentMethod | String | The payment method. | |
Reference | String | The reference. | |
ReferenceDateD | String | The day of the reference date. | |
ReferenceDateM | String | The month of the reference date. | |
ReferenceDateY | String | The year of the reference date. |
GiftReceipts¶
Returns receipts for a gift.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: GiftId are required in order to query GiftReceipts.
GiftId
supports the=
operator.
For example:
SELECT * FROM GiftReceipts WHERE GiftId = '476'
Columns¶
Name | Type | References | Description |
---|---|---|---|
GiftId | String | Gifts.Id | The immutable system record ID of the gift associated with the receipt. |
AmountValue | Integer | The amount of the receipt. | |
Date | Datetime | The date on the receipt. | |
Number | Integer | The number of the receipt. | |
Status | String | The status of the receipt. Available values are: RECEIPTED, NEEDSRECEIPT, and DONOTRECEIPT. |
Gifts¶
Returns a paginated list of gifts
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Id
supports the=
operator.ConstituentId
supports the '=,in' operators.Date
supports the '>=,<=' operators.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.PostStatus
supports the '=,in' operators.Type
supports the=
operator.ListId
supports the=
operator.AppealId
supports the '=,in' operators.FundId
supports the '=,in' operators.CampaignId
supports the '=,in' operators.AcknowledgmentStatus
supports the '=,in' operators.ReceiptStaus
supports the '=,in' operators.
For example:
SELECT * FROM Gifts WHERE ConstituentId IN ('280', '281')
SELECT * FROM Gifts WHERE PostStatus = 'Posted'
SELECT * FROM Gifts WHERE Type IN ('Pledge', 'GiftInKind')
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the gift. | |
AmountValue | Double | The monetary amount of the gift. | |
BalanceValue | Double | The balance remaining on the gift. | |
BatchNumber | String | The batch number associated with this gift. | |
Constituency | String | The constituency of the gift. | |
ConstituentId | String | The immutable system record ID of the constituent associated with the gift. | |
Date | Date | The gift date. | |
DateAdded | Datetime | The date when the gift was created. | |
DateModified | Datetime | The date when the gift was last modified. | |
GiftAidAmountValue | Double | This computed field calculates the total qualified amount of tax reclaimed from Gift Aid across all gift_splits for this gift. | |
GiftAidQualificationStatus | String | This computed field determines the Gift Aid qualification status based on tax declaration information and the database format. Available values are: Qualified, NotQualified, and PartlyQualified. For the UK only. | |
GiftStatus | String | The status of the gift. Available values are Active, Held, Terminated, Completed, and Cancelled. | |
IsAnonymous | Bool | Indicates whether the gift is anonymous. | |
LinkedGifts | String | The identifiers of other gifts that are linked to this gift. | |
LookupId | String | The user-defined identifier for the gift. | |
Origin | String | The origin of the gift. | |
PostDate | Datetime | The date that the gift was posted to general ledger. | |
PostStatus | String | The general ledger post status of the gift. | |
RecurringGiftStatusDateD | Integer | The date (D) that the gift status was last modified. | |
RecurringGiftStatusDateM | Integer | The date (M) that the gift status was last modified. | |
RecurringGiftStatusDateY | Integer | The date (Y) that the gift status was last modified. | |
Reference | String | Notes to track special details about a gift such as the motivation behind it or a detailed description of a gift-in-kind. | |
Subtype | String | The subtype of the gift. | |
Type | String | The gift type. | |
GiftCode | String | The gift Code. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
ListId | String | |
AppealId | String | |
FundId | String | |
CampaignId | String | |
AcknowledgmentStatus | String | |
ReceiptStaus | String |
GiftsCustomFields¶
Retrieves custom fields for all gifts
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id | String | The immutable system record ID of the custom field. | |
GiftId | String | The parent object's immutable system record ID. | |
Name | String | The custom field category. | |
Value | String | The value of the custom field. | |
Comment | String | The comment on the custom field. | |
DateAdded | Datetime | The date when the custom field was created. | |
DateModified | Datetime | The date when the custom field was last modified. | |
Type | String | The type of data that the custom field represents. |
GiftSoftCredits¶
Returns soft credits for a gift.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: GiftId are required in order to query GiftSoftCredits.
GiftId
supports the=
operator.
For example:
SELECT * FROM GiftSoftCredits WHERE GiftId = '476'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the soft credit. | |
AmountValue | Double | The amount of the soft credit. | |
ConstituentId | String | The immutable system record ID of the constituent associated with the soft credit. | |
GiftId | String | Gifts.Id | The immutable system record ID of the gift associated with the soft credit. |
GiftSplits¶
Returns the splits for a gift.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: GiftId are required in order to query GiftSplits.
GiftId
supports the=
operator.
For example:
SELECT * FROM GiftSplits WHERE GiftId = '476'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the gift split. | |
GiftId | String | Gifts.Id | The immutable system record ID of the gift associated with the gift split. |
AmountValue | Integer | The amount of the gift split. | |
AppealId | String | The immutable system record ID of the appeal associated with the gift split. | |
CampaignId | String | The immutable system record ID of the campaign associated with the gift split. | |
FundId | String | The immutable system record ID of the fund associated with the gift split. | |
GiftAidAmount | String | The amount of tax reclaimed from gift aid for this gift split. For the UK only. | |
GiftAidQualificationStatus | String | The gift aid qualification status of the gift split. Available values are: Qualified, and NotQualified. For the UK only. | |
PackageId | String | The immutable system record ID of the package associated with the gift split. |
Giving¶
Returns the first, latest or greatest gift recorded for a constituent.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: ConstituentId and GivingSummaryType are required in order to query Giving.
ConstituentId
supports the=
operator.GivingSummaryType
supports the=
operator.
For example:
SELECT * FROM Giving WHERE ConstituentId = '280' AND GivingSummaryType = 'greatest'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the gift. | |
AmountValue | Double | The gift amount. | |
Date | Date | The gift date. | |
Type | String | The gift type. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with this giving. |
GivingSummaryType | String | The giving summary type. Available values are First, Latest and Greatest. The allowed values are first, greatest, latest. |
GivingAppeals¶
Returns the giving appeals summary for the constituent
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: ConstituentId and GivingSummaryType are required in order to query GivingAppeals.
ConstituentId
supports the=
operator.GivingSummaryType
supports the=
operator.
For example:
SELECT * FROM GivingAppeals WHERE ConstituentId = '280' AND GivingSummaryType = 'first'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the appeal. | |
Description | String | The description. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with this giving. |
GivingSummaryType | String | The giving summary type. Available values are First, Latest and Greatest. The allowed values are first, greatest, latest. |
GivingCampaigns¶
Returns the giving campaigns summary for the constituent
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: ConstituentId and GivingSummaryType are required in order to query GivingCampaigns.
ConstituentId
supports the=
operator.GivingSummaryType
supports the=
operator.
For example:
SELECT * FROM GivingCampaigns WHERE ConstituentId = '280' AND GivingSummaryType = 'greatest'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the campaign. | |
Description | String | The campaign description. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with this giving. |
GivingSummaryType | String | The giving summary type. Available values are First, Latest and Greatest. The allowed values are first, greatest, latest. |
GivingFunds¶
Returns the giving funds summary for the constituent
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: ConstituentId and GivingSummaryType are required in order to query GivingFunds.
ConstituentId
supports the=
operator.GivingSummaryType
supports the=
operator.
For example:
SELECT * FROM GivingFunds WHERE ConstituentId = '280' AND GivingSummaryType = 'latest'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the fund. | |
Description | String | The fund description. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with this giving. |
GivingSummaryType | String | The giving summary type. Available values are First, Latest and Greatest. The allowed values are first, greatest, latest. |
LifetimeGiving¶
Returns the lifetime giving information for a constituent.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: ConstituentId are required in order to query LifetimeGiving.
ConstituentId
supports the=
operator.
For example:
SELECT * FROM LifetimeGiving WHERE ConstituentId = '280'
Columns¶
Name | Type | References | Description |
---|---|---|---|
ConsecutiveYearsGiven | Integer | This computed field calculates the number of consecutive years the constituent has given. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with the lifetime giving. |
TotalCommittedMatchingGiftsValue | Double | This computed field calculates the total amount of matching gift commitments attributed to the constituent. | |
TotalGivingValue | Double | This computed field calculates the total amount given by the constituent. | |
TotalPledgeBalanceValue | Double | This computed field calculates the unpaid pledge balance for the constituent. | |
TotalReceivedGivingValue | Double | This computed field calculates the total received amount given by the constituent. | |
TotalReceivedMatchingGiftsValue | Double | This computed field calculates the total amount of payments toward matching gift pledges attributed to the constituent. | |
TotalSoftCreditsValue | Double | This computed field calculates the total amount of soft credits applied to the constituent. | |
TotalYearsGiven | Integer | This computed field calculates the total number of years the constituent has given. |
Lists¶
Returns a list of lists for the given list type
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
ListType
supports the=
operator.
For example:
SELECT * FROM Lists WHERE ListType = 'Constituent'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID for the list. | |
DateModified | Datetime | The date this list was last modified. | |
Description | String | The description of the list | |
IsPublic | Boolean | Indicates whether this is a public or private list. | |
LastModifiedByUserId | String | The ID of the user that last modified the list. | |
LastModifiedByUserName | String | The name of the user that last modified the list. | |
Name | String | The name of the list. | |
RecordCount | Integer | The total number of records defined by this list based on the last time this list was saved. | |
ListType | String | Type of the list. The allowed values are Constituent, Gift, Action, Opportunity. |
Members¶
Returns the list of members.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
ConstituentId
supports the=
operator.
For example:
SELECT * FROM Members WHERE ConstituentId = '280'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the member. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with the member. |
Primary | Boolean | Indicates whether this is the primary member on the membership. |
Memberships¶
Returns a list of memberships.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
ConstituentId
supports the=
operator.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.
For example:
SELECT * FROM Memberships WHERE ConstituentId = '280'
SELECT * FROM Memberships WHERE DateAdded >= '2010-06-01 14:03:35'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the membership. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with the membership. |
Category | String | The membership category. | |
DateAdded | Datetime | The date when the membership was created. | |
DateModified | Datetime | The date when the membership was last modified. | |
DuesValue | Integer | The membership dues. | |
Expires | Datetime | The date when the membership expires. | |
Joined | Datetime | The date when the membership becomes active. | |
Program | String | The membership program. | |
Standing | String | The membership status. Available values are New, Active, Lapsed, and Dropped. | |
Subcategory | String | The membership subcategory. |
Notes¶
Returns a list of notes that tracks helpful or important details such as specific interests and special instructions for donations
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Id
supports the=
operator.ConstituentId
supports the=
operator.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.
For example:
SELECT * FROM Notes WHERE ConstituentId = '280'
SELECT * FROM Notes WHERE DateAdded >= '2010-06-01 14:03:35'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the note. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with the note. |
DateD | Integer | The day of note date. | |
DateM | Integer | The month of note date. | |
DateY | Integer | The year of note date. | |
DateAdded | Datetime | The date when the note was created. | |
DateModified | Datetime | The date when the note was last modified. | |
Summary | String | The note summary. | |
Text | String | The note's contents. | |
Type | String | The note type. |
OnlinePresences¶
Returns a paginated list of online presences that store a constituent's social media accounts, websites.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
ConstituentId
supports the=
operator.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.IncludeInactive
supports the=
operator.
For example:
SELECT * FROM OnlinePresences WHERE ConstituentId = '280'
SELECT * FROM OnlinePresences WHERE DateAdded >= '2010-06-01 14:03:35'
SELECT * FROM OnlinePresences WHERE IncludeInactive = true
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the online presence. | |
Address | String | The web address for the online presence. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with the online presence. |
DateAdded | Datetime | The date when the online presence was created. | |
DateModified | Datetime | The date when the online presence was last modified. | |
Inactive | Boolean | Indicates whether the online presence is inactive. | |
Primary | Boolean | Indicates whether this is the constituent's primary online presence. | |
Type | String | The online presence type. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean |
Opportunities¶
Retrieves a list of opportunities
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Id
supports the=
operator.ConstituentId
supports the '=,in' operators.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.IncludeInactive
supports the=
operator.
For example:
SELECT * FROM Opportunities WHERE Id = '4'
SELECT * FROM Opportunities WHERE ConstituentId IN ('255', '266')
SELECT * FROM Opportunities WHERE DateAdded >= '1999-06-01 14:03:35'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the opportunity. | |
AskAmountValue | Double | The monetary amount solicited from the prospect for the opportunity. | |
AskDate | Date | The date when the solicitation was made. | |
CampaignId | String | Campaigns.Id | The immutable system record ID of the campaign associated with the opportunity. The campaign sets the overall objectives for raising money. |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with the opportunity. |
DateAdded | Datetime | The date when the opportunity was created. | |
DateModified | Datetime | The date when the opportunity was last modified. | |
Deadline | Datetime | The goal date for the opportunity to result in a gift. | |
ExpectedAmountValue | Double | The monetary amount that is realistically expected to result from the opportunity. | |
ExpectedDate | Datetime | The date when the prospect is expected to give in response to the opportunity. | |
FundId | String | Funds.Id | The immutable system record ID of the fund associated with the opportunity. |
FundedAmountValue | Double | The monetary amount that the prospect gave in response to the opportunity. | |
FundedDate | Datetime | The date when the prospect gave in response to the opportunity. | |
Fundraisers | String | Fundraiser constituents interact with other constituents and prospects on behalf of your organization to cultivate relationships and advance opportunities to secure major gifts. | |
Inactive | Boolean | Indicates whether the opportunity is inactive. | |
LinkedGifts | String | The immutable system record IDs of the gifts related to the opportunity. | |
Name | String | The name that identifies the opportunity throughout the program, such as in lists or on constituent records. | |
Purpose | String | The intended use for any money raised as a result of the opportunity. | |
Status | String | The status that indicates where the opportunity is in the solicitation process. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean | |
ListId | String |
OpportunitiesCustomFields¶
Retrieves custom fields for an opportunity
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id | String | The immutable system record ID of the custom field. | |
OpportunityId | String | The parent object's immutable system record ID. | |
Name | String | The custom field category. | |
Value | String | The value of the custom field. | |
Date | Datetime | The date when the custom field was created. | |
DateAdded | Datetime | The date when the custom field was added. | |
DateModified | Datetime | The date when the custom field was last modified. | |
Type | String | The type of data that the custom field represents. |
OpportunityAttachments¶
Returns a list of attachments for an opportunity
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: OpportunityId is required in order to query OpportunityAttachments.
OpportunityId
supports the=
operator.
For example:
SELECT * FROM OpportunityAttachments WHERE OpportunityId = '4'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the attachment. | |
OpportunityId | String | Opportunities.Id | The ID of the Opportunity. |
Content_type | String | The content type. For physical attachments only. | |
Date | Datetime | The date of the attachment. | |
FileId | String | The identifier of the file. | |
FileName | String | The file name. For physical attachments only. | |
FileSize | Integer | The file size in bytes. For physical attachments only. | |
Name | String | The name of the attachment. | |
ParentId | String | The parent object's immutable system record ID. | |
Tags | String | The tags associated with the attachment. | |
ThumbnailId | String | The identifier of the thumbnail. For physical attachments that are images only. | |
ThumbnailUrl | String | The URL for a thumbnail. | |
Type | String | The attachment type. Available values are Link and Physical. | |
Url | String | The URL for the attachment. |
Packages¶
Returns a list of packages that contains content and other items for the appeals that organizations use to solicit gifts
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Id
supports the=
operator.AppealId
supports the '=,in' operators.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.IncludeInactive
supports the=
operator.
For example:
SELECT * FROM Packages WHERE Id = '1'
SELECT * FROM Packages WHERE AppealId IN ('17', '18')
SELECT * FROM Packages WHERE DateAdded >= '1999-06-01 14:03:35'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the package. | |
AppealId | String | FundraisingAppeals.Id | The immutable system record ID of the appeal associated with this package. |
Category | String | The category of the package. | |
DateAdded | Datetime | The date when the package was created. | |
DateModified | Datetime | The date when the package was last modified. | |
DefaultGiftAmountValue | Double | The default amount for gifts associated with this package. | |
Description | String | The display name of the package. | |
End | Datetime | The end date of the package. | |
GoalValue | Double | The goal of this package. | |
Inactive | Boolean | This computed field indicates that the package is active if the current date is after any start and before any end. | |
LookupId | String | The user-defined identifier for the package. | |
Notes | String | The notes on the package. | |
RecipientCount | Integer | The amount of recipients of the package. | |
Start | Datetime | The start date of the package. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean |
ParticipantFeePayments¶
Returns the fee payments for a participant.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: ParticipantId is required in order to query ParticipantFeePayments.
ParticipantId
supports the=
operator.
For example:
SELECT * FROM ParticipantFeePayments WHERE ParticipantId = '197'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The ID of the participant fee. | |
ParticipantId | String | EventParticipants.Id | The ID of the participant that the participant fee is linked to. |
AppliedAmount | Integer | The applied amount of the participant fee payment. | |
GiftId | String | The ID of the gift that the participant fee is linked to. |
ParticipantFees¶
Returns a list of fees for a participant.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: ParticipantId is required in order to query ParticipantFees.
ParticipantId
supports the=
operator.
For example:
SELECT * FROM ParticipantFees WHERE ParticipantId = '197'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The ID of the participant fee. | |
ParticipantId | String | EventParticipants.Id | The ID of the record that the participant fee is linked to. |
DateD | Integer | The day in the fuzzy date. | |
DateM | Integer | The month in the fuzzy date. | |
DateY | Integer | The year in the fuzzy date. | |
EventFeeContributionAmount | Integer | The tax deductible amount for this fee. | |
EventFeeCost | Double | The fee's cost. | |
EventFeeEventId | String | The ID of the event the fee is linked to. | |
EventFeeId | String | The ID of the event fee. | |
EventFeeName | String | The name of the event fee. | |
EventFeeNumberSold | Integer | The number of fees sold. | |
FeeAmount | Double | The amount of the participant fee. | |
Quantity | Integer | The quantity purchased. | |
TaxReceiptableAmount | Integer | The tax receiptable amount of the participant fee. |
ParticipantLevels¶
Returns a list of participation levels for all events.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
IncludeInactive
supports the=
operator.
For example:
SELECT * FROM ParticipantLevels WHERE IncludeInactive = true
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The ID of the participation level. | |
IsInactive | Boolean | Whether the participation level is inactive. True if inactive. | |
Name | String | The name of the participation level. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean |
ParticipantOptions¶
Returns the participant options for a participant.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: ParticipantId is required in order to query ParticipantOptions.
ParticipantId
supports the=
operator.
For example:
SELECT * FROM ParticipantOptions WHERE ParticipantId = '197'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The ID of the participant option. | |
ParticipantId | String | EventParticipants.Id | The ID of the participant. |
AddedByService | String | The name of the service that added this participant option. | |
AddedByUser | String | The ID of the user that added the participant option. | |
DateAdded | Datetime | The date the participant option was added. | |
DateUpdated | Datetime | The date the participant option was updated. | |
EventId | String | The ID of the event. | |
EventParticipantOptionId | String | The ID of the event participant option. | |
OptionValue | String | The participant's response to the option. | |
UpdatedByService | String | The name of the service that updated this participant option. | |
UpdatedByUser | String | The ID of the user who updated the participant option. |
Phones¶
Returns a list of phones for all constituents or a specific constituent
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Id
supports the=
operator.ConstituentId
supports the '=,in' operators.DateAdded
supports the '>=' operators.DateModified
supports the '>=' operators.IncludeInactive
supports the '=' operators.
For example:
SELECT * FROM Phones WHERE Id = '1'
SELECT * FROM Phones WHERE ConstituentId IN ('280', '281')
SELECT * FROM Phones WHERE DateAdded >= '2010-06-01 14:03:35'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the phone. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with the phone. |
DateAdded | Datetime | The date when the phone was created. | |
DateModified | Datetime | The date when the phone was last modified. | |
DoNotCall | Boolean | Indicates whether the constituent requests not to be contacted at this number. | |
Inactive | Boolean | Indicates whether the phone is inactive. | |
Number | String | The phone number. | |
Primary | Boolean | Indicates whether this is the constituent's primary phone. | |
Type | String | The phone type. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean |
RatingCategories¶
Returns a list of all available rating categories.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
IncludeInactive
supports the=
operator.SourceName
supports the=
operator.
For example:
SELECT * FROM RatingCategories WHERE SourceName = 'Econometrics'
SELECT * FROM RatingCategories WHERE IncludeInactive = true
Columns¶
Name | Type | References | Description |
---|---|---|---|
Inactive | Boolean | Indicates whether the category is inactive. | |
Name | String | The name of the rating category. | |
SourceName | String | The source of the category. | |
Type | String | The type of the rating category. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean |
Ratings¶
Returns a list of ratings for a constituent.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Note: ConstituentId is required in order to query Ratings.
ConstituentId
supports the=
operator.IncludeInactive
supports the=
operator.MostRecentlyUsed
supports the=
operator.
For example:
SELECT * FROM Ratings WHERE ConstituentId = '280'
SELECT * FROM Ratings WHERE IncludeInactive = true
SELECT * FROM Ratings WHERE MostRecentlyUsed = true
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the rating. | |
Category | String | The category of the rating. | |
Comment | String | A comment about the rating. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with the rating. |
Date | Datetime | The date of the rating. | |
Inactive | Boolean | This computed field indicates that the rating is active if the category is active. | |
Source | String | The source of the rating. | |
Type | String | This computed field indicates the type of data that the rating represents based on the category property. | |
Value | String | The value of the rating. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean | |
MostRecentOnly | Boolean |
RatingSources¶
Returns a list of all available rating sources.
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
IncludeInactive
supports the=
operator.
For example:
SELECT * FROM RatingSources WHERE IncludeInactive = true
Columns¶
Name | Type | References | Description |
---|---|---|---|
Inactive | Boolean | Indicates whether the rating source is inactive. | |
Name | String | The name of the rating source. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
IncludeInactive | Boolean |
Relationships¶
Returns a list of relationships between constituents and other individuals and organizations such as family, friends, and employers
Table Specific Information¶
Select¶
The connector will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the connector.
Id
supports the=
operator.ConstituentId
supports the=
operator.DateAdded
supports the '>=,>' operators.DateModified
supports the '>=,>' operators.
For example:
SELECT * FROM Relationships WHERE Id = '1'
SELECT * FROM Relationships WHERE ConstituentId = '280'
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | String | The immutable system record ID of the relationship. | |
Comment | String | The comment on the relationship. | |
ConstituentId | String | Constituents.Id | The immutable system record ID of the constituent associated with the relationship. |
DateAdded | Datetime | The date when the relationship was created. | |
DateModified | Datetime | The date when the relationship was last modified. | |
EndD | Integer | The end day for the relationship. | |
EndM | Integer | The end month for the relationship. | |
EndY | Integer | The end year for the relationship. | |
IsOrganizationContact | Boolean | Indicates whether the related individual represents the organization as a contact. | |
IsPrimaryBusiness | Boolean | Indicates whether the related organization is the individual's primary business. | |
IsSpouse | Boolean | Indicates whether the related constituent is the constituent's spouse. | |
Name | String | The name of the related constituent. | |
OrganizationContactType | String | Provides context for interactions with the related individual who represents the organization as a contact. | |
Position | String | The individual's position in the organization. | |
ReciprocalRelationshipId | String | The identifier for the reciprocal relationship record. | |
ReciprocalType | String | Describes the constituent's relationship to the related constituent. | |
RelationId | String | The immutable system record ID of the related individual or organization. | |
StartD | Integer | The start day for the relationship. | |
StartM | Integer | The start month for the relationship. | |
StartY | Integer | The start year for the relationship. | |
Type | String | The type of relation that the relationship represents. |
Tributes¶
Returns a list of tributes.
Table Specific Information¶
Select¶
All the filters are executed client side within the connector. For example:
SELECT * FROM Tributes
SELECT * FROM Tributes WHERE Id = 2
Columns¶
Name | Type | References | Description |
---|---|---|---|
Id [KEY] | Integer | The tribute ID. | |
ConstituentRecordId | Integer | The system record ID of the constituent. | |
DefaultFundId | Integer | The default fund ID. | |
Description | String | The tribute description. | |
EndDateD | Integer | The day of the end date. | |
EndDateM | Integer | The month of the end date. | |
EndDateY | Integer | The year of the end date. | |
IsActive | Boolean | The active status of the tribute. | |
Notes | String | The tribute notes. | |
StartDateD | Integer | The day of the start date. | |
StartDateM | Integer | The month of the start date. | |
StartDateY | Integer | The year of the start date. | |
TributeTypeId | Integer | The tribute type code ID. |
Stored Procedures¶
Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with BlackBaud Raiser's Edge NXT.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from BlackBaud Raiser's Edge NXT, along with an indication of whether the procedure succeeded or failed.
Jitterbit Connector for Blackbaud Raisers Edge NXT Stored Procedures¶
Name | Description |
---|---|
AutomateRecurringGift | Converts a manual recurring gift to an automated recurring gift in the web view |
GetOAuthAccessToken | Gets an authentication token from BlackBaudRaiserEdgeNXT. |
GetOAuthAuthorizationURL | Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL. |
RefreshOAuthAccessToken | Refreshes the OAuth access token used for authentication with BlackBaudRaiserEdgeNXT. |
UpdateGiftReceipt | Edits a gift receipt |
UpdateGiftStatus | Edit the status of a recurring gift. |
AutomateRecurringGift¶
Converts a manual recurring gift to an automated recurring gift in the web view
Input¶
Name | Type | Required | Description |
---|---|---|---|
GiftId | String | True | The immutable system record ID of the recurring gift to convert. |
BBPSConfigurationId | String | True | BBPS Configuration ID to put on the gift. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | Execution status of the stored procedure. |
GetOAuthAccessToken¶
Gets an authentication token from BlackBaudRaiserEdgeNXT.
Input¶
Name | Type | Required | Description |
---|---|---|---|
AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app. The allowed values are APP, WEB. The default value is APP. |
Scope | String | False | A comma-separated list of permissions to request from the user. Please check the Backlog API for a list of available permissions. |
CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Backlog app settings. Only needed when the Authmode parameter is Web. |
Verifier | String | False | The verifier returned from RaiserEdgeNxt after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL. |
State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Backlog authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The access token used for communication with BlackBaudRaiserEdgeNXT. |
OAuthRefreshToken | String | The OAuth refresh token. This is the same as the access token in the case of BlackBaudRaiserEdgeNXT. |
ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
GetOAuthAuthorizationURL¶
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.
Input¶
Name | Type | Required | Description |
---|---|---|---|
CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the BlackBaudRaiserEdgeNXT app settings. |
Scope | String | False | A comma-separated list of scopes to request from the user. Please check the BlackBaudRaiserEdgeNXT API documentation for a list of available permissions. |
State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the BlackBaudRaiserEdgeNXT authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
RefreshOAuthAccessToken¶
Refreshes the OAuth access token used for authentication with BlackBaudRaiserEdgeNXT.
Input¶
Name | Type | Required | Description |
---|---|---|---|
OAuthRefreshToken | String | True | Set this to the token value that expired. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The authentication token returned from BlackBaudRaiserEdgeNXT. This can be used in subsequent calls to other operations for this particular service. |
OAuthRefreshToken | String | This is the same as the access token. |
ExpiresIn | String | The remaining lifetime on the access token. |
SellStockGift¶
This updates a stock gift to sold with the given details.
Input¶
Name | Type | Required | Description |
---|---|---|---|
GiftId | String | True | The immutable system record ID of the recurring gift to convert. |
BrokerFee | String | False | The Broker Fee. |
PostDate | String | False | The Post Date. |
PostStatus | String | False | The Post Status. |
StockIssuerIssuer | String | False | StockIssuerIssuer. |
StockIssuerSymbol | String | False | StockIssuerSymbol. |
StockIssuerUnits | String | False | StockIssuerUnits. |
StockIssuerUnitPrice | String | False | StockIssuerUnitPrice. |
Notes | String | False | Notes. |
StockSaleDate | String | False | StockSaleDate. |
StockSaleValue | String | False | StockSaleValue. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | Execution status of the stored procedure. |
UpdateGiftReceipt¶
Edits a gift receipt
Stored Procedures Specific Information¶
Process of Update Gift Receipt¶
BlackBaud Raiser's Edge NXT allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. The available columns for UpdateGiftReceipt are ReceiptId, Amount, Date, Number and Status. For example:
EXECUTE UpdateGiftReceipt ReceiptId = '372', Amount = 0.0, Date = '2018-12-31T00:00:00', Number = 123456, Status = 'Receipted'
Input¶
Name | Type | Required | Description |
---|---|---|---|
ReceiptId | String | True | The immutable system record ID of the gift receipt to edit. It uses the parent gift's ID as its value. |
Amount | Double | True | The amount of the receipt. |
Date | String | True | The date on the receipt |
Number | Integer | True | The number of the receipt. |
Status | String | True | The receipt status of the gift. Available values are: RECEIPTED, NEEDSRECEIPT, and DONOTRECEIPT. When receipt_status is set to NEEDSRECEIPT or DONOTRECEIPT, receipt_date should be null. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | Execution status of the stored procedure |
UpdateGiftStatus¶
Edit the status of a recurring gift.
Stored Procedures Specific Information¶
Process of Update Gift Status¶
BlackBaud Raiser's Edge NXT allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. The available columns for UpdateGiftStatus are GiftId and GiftStatus. For example:
EXECUTE UpdateGiftStatus GiftId = '281', GiftStatus = 'Held'
Input¶
Name | Type | Required | Description |
---|---|---|---|
GiftId | String | True | The immutable system record ID of the recurring gift to update. |
GiftStatus | String | True | The new status of the recurring gift. Available values are Active, Held, Terminated, Completed, and Cancelled. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | Execution status of the stored procedure |
System Tables¶
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
Schema Tables¶
The following tables return database metadata for BlackBaud Raiser's Edge NXT:
- sys_catalogs: Lists the available databases.
- sys_schemas: Lists the available schemas.
- sys_tables: Lists the available tables and views.
- sys_tablecolumns: Describes the columns of the available tables and views.
- sys_procedures: Describes the available stored procedures.
- sys_procedureparameters: Describes stored procedure parameters.
- sys_keycolumns: Describes the primary and foreign keys.
- sys_indexes: Describes the available indexes.
Data Source Tables¶
The following tables return information about how to connect to and query the data source:
- sys_connection_props: Returns information on the available connection properties.
- sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.
Query Information Tables¶
The following table returns query statistics for data modification queries:
- sys_identity: Returns information about batch operations or single updates.
sys_catalogs¶
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
sys_schemas¶
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
sys_tables¶
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
sys_tablecolumns¶
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Constituents table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Constituents'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
IsReadOnly | Boolean | Whether the column is read-only. |
IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
sys_procedures¶
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database containing the stored procedure. |
SchemaName | String | The schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure. |
Description | String | A description of the stored procedure. |
ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
sys_procedureparameters¶
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the UpdateGiftStatus stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='UpdateGiftStatus' AND Direction=1 OR Direction=2
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure containing the parameter. |
ColumnName | String | The name of the stored procedure parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
sys_keycolumns¶
Describes the primary and foreign keys.
The following query retrieves the primary key for the Constituents table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Constituents'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
sys_foreignkeys¶
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
sys_primarykeys¶
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
KeySeq | String | The sequence number of the primary key. |
KeyName | String | The name of the primary key. |
sys_indexes¶
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
sys_connection_props¶
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:raiseredgenxt:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Columns¶
Name | Type | Description |
---|---|---|
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
sys_sqlinfo¶
Describes the SELECT query processing that the connector can offload to the data source.
Discovering the Data Source's SELECT Capabilities¶
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
---|---|---|
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG , COUNT , MAX , MIN , SUM , DISTINCT |
COUNT | Whether COUNT function is supported. | YES , NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | = , > , < , >= , <= , <> , != , LIKE , NOT LIKE , IN , NOT IN , IS NULL , IS NOT NULL , AND , OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO , NO_RELATION , EQUALS_SELECT , SQL_GB_COLLATE |
STRING_FUNCTIONS | Supported string functions. | LENGTH , CHAR , LOCATE , REPLACE , SUBSTRING , RTRIM , LTRIM , RIGHT , LEFT , UCASE , SPACE , SOUNDEX , LCASE , CONCAT , ASCII , REPEAT , OCTET , BIT , POSITION , INSERT , TRIM , UPPER , REGEXP , LOWER , DIFFERENCE , CHARACTER , SUBSTR , STR , REVERSE , PLAN , UUIDTOSTR , TRANSLATE , TRAILING , TO , STUFF , STRTOUUID , STRING , SPLIT , SORTKEY , SIMILAR , REPLICATE , PATINDEX , LPAD , LEN , LEADING , KEY , INSTR , INSERTSTR , HTML , GRAPHICAL , CONVERT , COLLATION , CHARINDEX , BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS , ACOS , ASIN , ATAN , ATAN2 , CEILING , COS , COT , EXP , FLOOR , LOG , MOD , SIGN , SIN , SQRT , TAN , PI , RAND , DEGREES , LOG10 , POWER , RADIANS , ROUND , TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW , CURDATE , DAYOFMONTH , DAYOFWEEK , DAYOFYEAR , MONTH , QUARTER , WEEK , YEAR , CURTIME , HOUR , MINUTE , SECOND , TIMESTAMPADD , TIMESTAMPDIFF , DAYNAME , MONTHNAME , CURRENT_DATE , CURRENT_TIME , CURRENT_TIMESTAMP , EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES , NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES , NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES , NO |
DATASYNCVERSION | The Data Sync version needed to access this driver. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | The Data Sync category of this driver. | Source , Destination , Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE , FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES , NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT , INSERT , DELETE , UPDATE , TRANSACTIONS , ORDERBY , OAUTH , ASSIGNEDID , LIMIT , LIKE , BULKINSERT , COUNT , BULKDELETE , BULKUPDATE , GROUPBY , HAVING , AGGS , OFFSET , REPLICATE , COUNTDISTINCT , JOINS , DROP , CREATE , DISTINCT , INNERJOINS , SUBQUERIES , ALTER , MULTIPLESCHEMAS , GROUPBYNORELATION , OUTERJOINS , UNIONALL , UNION , UPSERT , GETDELETED , CROSSJOINS , GROUPBYCOLLATE , MULTIPLECATS , FULLOUTERJOIN , MERGE , JSONEXTRACT , BULKUPSERT , SUM , SUBQUERIESFULL , MIN , MAX , JOINSFULL , XMLEXTRACT , AVG , MULTISTATEMENTS , FOREIGNKEYS , CASE , LEFTJOINS , COMMAJOINS , WITH , LITERALS , RENAME , NESTEDTABLES , EXECUTE , BATCH , BASIC , INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES , NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE , FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE , FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Columns¶
Name | Type | Description |
---|---|---|
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
sys_identity¶
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Columns¶
Name | Type | Description |
---|---|---|
Id | String | The database-generated ID returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
Advanced Configurations Properties¶
The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
SubscriptionKey | Subscription key which provides access to the API. Found in your Developer Profile. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Property | Description |
---|---|
IncludeCustomFields | Set to true to retrieve custom fields values for Constituents, Actions, Opportunities, and Gifts. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
PageSize | The number of results to return per page of data retrieved from BlackBaud Raiser's Edge NXT. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
OAuth¶
This section provides a complete list of OAuth properties you can configure.
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
SubscriptionKey | Subscription key which provides access to the API. Found in your Developer Profile. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
InitiateOAuth¶
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Possible Values¶
OFF
, GETANDREFRESH
, REFRESH
Data Type¶
string
Default Value¶
OFF
Remarks¶
The following options are available:
OFF
: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.GETANDREFRESH
: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.REFRESH
: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.
OAuthClientId¶
The client ID assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId
value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
OAuthClientSecret¶
The client secret assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret
property.
OAuthAccessToken¶
The access token for connecting using OAuth.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthAccessToken
property is used to connect using OAuth. The OAuthAccessToken
is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
SubscriptionKey¶
Subscription key which provides access to the API. Found in your Developer Profile.
Data Type¶
string
Default Value¶
""
Remarks¶
To obtain a key, follow these steps:
- Request a subscription to an API from the Subscriptions page (https://developer.blackbaud.com/subscriptions/), select
SKY API Standard Edition
. - Select
Subscribe
. A confirmation screen appears. - To submit your request, select
Confirm
. You will get an email notification when your request is approved. - After it is approved, you can view the subscription key within your developer profile.
OAuthSettingsLocation¶
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'
.
Data Type¶
string
Default Value¶
%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt
Remarks¶
When InitiateOAuth is set to GETANDREFRESH
or REFRESH
, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.
Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://'
followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props
system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.
The default location is "%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt" with %APPDATA%
set to the user's configuration directory. The default values are
- Windows: "
register://%DSN
" - Unix: "%AppData%..."
where DSN is the name of the current DSN used in the open connection.
The following table lists the value of %APPDATA%
by OS:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Linux | ~/.config |
CallbackURL¶
The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Data Type¶
string
Default Value¶
""
Remarks¶
During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.
OAuthVerifier¶
The verifier code returned from the OAuth authorization URL.
Data Type¶
string
Default Value¶
""
Remarks¶
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
Authentication on Headless Machines¶
See to obtain the OAuthVerifier
value.
Set OAuthSettingsLocation along with OAuthVerifier
. When you connect, the connector exchanges the OAuthVerifier
for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier
from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
OAuthRefreshToken¶
The OAuth refresh token for the corresponding OAuth access token.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthRefreshToken
property is used to refresh the OAuthAccessToken when using OAuth authentication.
OAuthExpiresIn¶
The lifetime in seconds of the OAuth AccessToken.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
OAuthTokenTimestamp¶
The Unix epoch timestamp in milliseconds when the current Access Token was created.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
SSL¶
This section provides a complete list of SSL properties you can configure.
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SSLServerCert¶
The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type¶
string
Default Value¶
""
Remarks¶
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
---|---|
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Schema¶
This section provides a complete list of schema properties you can configure.
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Location¶
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type¶
string
Default Value¶
%APPDATA%\RaiserEdgeNXT Data Provider\Schema
Remarks¶
The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location
property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\RaiserEdgeNXT Data Provider\Schema" with %APPDATA%
being set to the user's configuration directory:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
BrowsableSchemas¶
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
Tables¶
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Views¶
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Miscellaneous¶
This section provides a complete list of miscellaneous properties you can configure.
Property | Description |
---|---|
IncludeCustomFields | Set to true to retrieve custom fields values for Constituents, Actions, Opportunities, and Gifts. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
PageSize | The number of results to return per page of data retrieved from BlackBaud Raiser's Edge NXT. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
IncludeCustomFields¶
Set to true to retrieve custom fields values for Constituents, Actions, Opportunities, and Gifts.
Data Type¶
bool
Default Value¶
false
Remarks¶
Setting this to true will significantly impact the performance of selecting data from Constituents, Actions, Opportunities, and Gifts. Retrieval of custom fields requires making a lookup per record, making it very expensive to retrieve them.
MaxRows¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Data Type¶
int
Default Value¶
-1
Remarks¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other¶
These hidden properties are used only in specific use cases.
Data Type¶
string
Default Value¶
""
Remarks¶
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
Integration and Formatting¶
Property | Description |
---|---|
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
PageSize¶
The number of results to return per page of data retrieved from BlackBaud Raiser's Edge NXT.
Data Type¶
string
Default Value¶
""
Remarks¶
The pagesize will automatically be determined if you do not manually set it. It is generally not necessary to ever set this value.
PseudoColumns¶
This property indicates whether or not to include pseudo columns as columns to the table.
Data Type¶
string
Default Value¶
""
Remarks¶
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
Timeout¶
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type¶
int
Default Value¶
60
Remarks¶
If Timeout
= 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout
expires and the operation is not yet complete, the connector throws an exception.
UserDefinedViews¶
A filepath pointing to the JSON configuration file containing your custom views.
Data Type¶
string
Default Value¶
""
Remarks¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Constituents WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
Note that the specified path is not embedded in quotation marks.