CData Cloud offers access to BlackBaud Raiser's Edge NXT across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to BlackBaud Raiser's Edge NXT through CData Cloud.
CData Cloud allows you to standardize and configure connections to BlackBaud Raiser's Edge NXT as though it were any other OData endpoint, or standard SQL Server/MySQL database.
This page provides a guide to Establishing a Connection to BlackBaud Raiser's Edge NXT in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to BlackBaud Raiser's Edge NXT and configure any necessary connection properties to create a database in CData Cloud
Accessing data from BlackBaud Raiser's Edge NXT through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to BlackBaud Raiser's Edge NXT by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
Before establishing a connection, supply the SubscriptionKey, found in the BlackBaud Raiser's Edge NXT Profile.
BlackBaud Raiser's Edge NXT uses the OAuth authentication standard. You can connect to BlackBaud Raiser's Edge NXT without setting any connection properties using the Embedded Credentials.
Alternatively, you can authenticate by Creating a Custom OAuth App to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties.
See Using OAuth Authentication for an authentication guide.
OAuth requires the authenticating user to interact with BlackBaud Raiser's Edge NXT using the browser. The Cloud facilitates this in various ways as described below.
You will need to register an app to obtain the OAuthClientId and OAuthClientSecret.
See Creating a Custom OAuth App for a procedure.
You can connect without setting any OAuth connection properties for your user credentials. After setting the following connection properties, you are ready to connect:
After setting the following, you are ready to connect:
To create BlackBaud Raiser's Edge NXT data sources on headless servers or other machines on which the Cloud cannot open a browser, you need to authenticate from another machine. Authentication is a two-step process.
Create a Custom OAuth App
See Creating a Custom OAuth App for a procedure. You can then follow the procedures below to authenticate and connect to data.
Obtain a Verifier Code
Set the following properties on the headless machine:
You can then follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property.
On the headless machine, set the following connection properties to obtain the OAuth authentication values:
Connect to Data
After the OAuth settings file is generated, set the following properties to connect to data:
Transfer OAuth Settings
Follow the steps below to install the Cloud on another machine, authenticate, and then transfer the resulting OAuth values.
On a second machine, install the Cloud and connect with the following properties set:
Test the connection to authenticate. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation. Once you have successfully tested the connection, copy the OAuth settings file to your headless machine. On the headless machine, set the following connection properties to connect to data:
For more information about the first two steps, please see the getting started guide on Blackbaud here.
Create an app to obtain the OAuth client credentials, the OAuthClientId and OAuthClientSecret. Follow these steps:
To do so, go to: https://developer.sky.blackbaud.com/signup/
Create an app to obtain the OAuth client credentials, the OAuthClientId and OAuthClientSecret. Follow these steps:
| Date | Build Number | Change Type | Description |
| 08/17/2022 | 8264 | General | Changed
|
| 02/11/2022 | 8077 | BlackBaud Raiser's Edge NXT | Added
|
| 12/21/2021 | 8025 | BlackBaud Raiser's Edge NXT | Added
|
| 11/12/2021 | 7986 | BlackBaud Raiser's Edge NXT | Added
|
| 11/05/2021 | 7979 | BlackBaud Raiser's Edge NXT | Added
|
| 09/02/2021 | 7915 | General | Added
|
| 08/07/2021 | 7889 | General | Changed
|
| 08/06/2021 | 7888 | General | Changed
|
| 07/23/2021 | 7874 | General | Changed
|
| 07/08/2021 | 7859 | General | Added
|
| 04/23/2021 | 7785 | General | Added
|
| 04/23/2021 | 7783 | General | Changed
|
| 04/16/2021 | 7776 | General | Added
Changed
|
| 04/15 /2021 | 7775 | General | Changed
|
This section details a selection of advanced features of the BlackBaud Raiser's Edge NXT Cloud.
The Cloud 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.
Use SSL Configuration to adjust how Cloud handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.
Configure the Cloud for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
The Cloud 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).
See Query Processing for more information.
See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.
The CData Cloud 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 a tool. 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:
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 Cloud.
This User Defined View configuration file is formatted as follows:
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"
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.
By default, the Cloud 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.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
For sources that do not support SQL-92, the Cloud offloads as much of SQL statement processing as possible to BlackBaud Raiser's Edge NXT and then processes the rest of the query in memory (client-side). This results in optimal performance.
For data sources with limited query capabilities, the Cloud handles transformations of the SQL query to make it simpler for the Cloud. The goal is to make smart decisions based on the query capabilities of the data source to push down as much of the computation as possible. The BlackBaud Raiser's Edge NXT Query Evaluation component examines SQL queries and returns information indicating what parts of the query the Cloud is not capable of executing natively.
The BlackBaud Raiser's Edge NXT Query Slicer component is used in more specific cases to separate a single query into multiple independent queries. The client-side Query Engine makes decisions about simplifying queries, breaking queries into multiple queries, and pushing down or computing aggregations on the client-side while minimizing the size of the result set.
There's a significant trade-off in evaluating queries, even partially, client-side. There are always queries that are impossible to execute efficiently in this model, and some can be particularly expensive to compute in this manner. CData always pushes down as much of the query as is feasible for the data source to generate the most efficient query possible and provide the most flexible query capabilities.
Capturing Cloud logging can be very helpful when diagnosing error messages or other unexpected behavior.
You will simply need to set two connection properties to begin capturing Cloud logging.
Once this property is set, the Cloud will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are described in the following list:
| 1 | Setting Verbosity to 1 will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors. |
| 2 | Setting Verbosity to 2 will log everything included in Verbosity 1 and additional information about the request. |
| 3 | Setting Verbosity to 3 will additionally log HTTP headers, as well as the body of the request and the response. |
| 4 | Setting Verbosity to 4 will additionally log transport-level communication with the data source. This includes SSL negotiation. |
| 5 | Setting Verbosity to 5 will additionally log communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands. |
The Verbosity should not be set to greater than 1 for normal operation. Substantial amounts of data can be logged at higher verbosities, which can delay execution times.
To refine the logged content further by showing/hiding specific categories of information, see LogModules.
Best Practices for Data Security
Although we mask sensitive values, such as passwords, in the connection string and any request in the log, it is always best practice to review the logs for any sensitive information before sharing outside your organization.
You may want to refine the exact information that is recorded to the log file. This can be accomplished using the LogModules property.
This property allows you to filter the logging using a semicolon-separated list of logging modules.
All modules are four characters long. Please note that modules containing three letters have a required trailing blank space. The available modules are:
LogModules=INFO;EXEC;SSL ;SQL ;META;
Note that these modules refine the information as it is pulled after taking the Verbosity into account.
The CData Cloud supports several operations on data, including querying, deleting, modifying, and inserting.
See SELECT Statements for a syntax reference and examples.
See Data Model for information on the capabilities of the BlackBaud Raiser's Edge NXT API.
Use EXECUTE or EXEC statements to execute stored procedures. See EXECUTE Statements for a syntax reference and examples.
A SELECT statement can consist of the following basic clauses.
The following syntax diagram outlines the syntax supported by the SQL engine of the Cloud:
SELECT {
[ TOP <numeric_literal> | DISTINCT ]
{
*
| {
<expression> [ [ AS ] <column_reference> ]
| { <table_name> | <correlation_name> } .*
} [ , ... ]
}
[ INTO csv:// [ filename= ] <file_path> [ ;delimiter=tab ] ]
{
FROM <table_reference> [ [ AS ] <identifier> ]
} [ , ... ]
[ [
INNER | { { LEFT | RIGHT | FULL } [ OUTER ] }
] JOIN <table_reference> [ ON <search_condition> ] [ [ AS ] <identifier> ]
] [ ... ]
[ WHERE <search_condition> ]
[ GROUP BY <column_reference> [ , ... ]
[ HAVING <search_condition> ]
[ UNION [ ALL ] <select_statement> ]
[
ORDER BY
<column_reference> [ ASC | DESC ] [ NULLS FIRST | NULLS LAST ]
]
[
LIMIT <expression>
[
{ OFFSET | , }
<expression>
]
]
} | SCOPE_IDENTITY()
<expression> ::=
| <column_reference>
| @ <parameter>
| ?
| COUNT( * | { [ DISTINCT ] <expression> } )
| { AVG | MAX | MIN | SUM | COUNT } ( <expression> )
| NULLIF ( <expression> , <expression> )
| COALESCE ( <expression> , ... )
| CASE <expression>
WHEN { <expression> | <search_condition> } THEN { <expression> | NULL } [ ... ]
[ ELSE { <expression> | NULL } ]
END
| <literal>
| <sql_function>
<search_condition> ::=
{
<expression> { = | > | < | >= | <= | <> | != | LIKE | NOT LIKE | IN | NOT IN | IS NULL | IS NOT NULL | AND | OR | CONTAINS | BETWEEN } [ <expression> ]
} [ { AND | OR } ... ]
SELECT * FROM Constituents
SELECT [AddressLines] AS MY_AddressLines FROM Constituents
SELECT CAST(AnnualRevenue AS VARCHAR) AS Str_AnnualRevenue FROM Constituents
SELECT * FROM Constituents WHERE Type = 'Home'
SELECT COUNT(*) AS MyCount FROM Constituents
SELECT COUNT(DISTINCT AddressLines) FROM Constituents
SELECT DISTINCT AddressLines FROM Constituents
SELECT AddressLines, MAX(AnnualRevenue) FROM Constituents GROUP BY AddressLinesSee Aggregate Functions for details.
SELECT c.Category, c.Fundraisers, c.Summary, o.Name, o.PhoneDoNotCall FROM Actions c INNER JOIN Constituents o ON c.ConstituentId = o.IdSee JOIN Queries for details.
SELECT Id, AddressLines FROM Constituents ORDER BY AddressLines ASC
SELECT Id, AddressLines FROM Constituents LIMIT 10
SELECT * FROM Constituents WHERE Type = @param
Some input-only fields are available in SELECT statements. These fields, called pseudo columns, do not
appear as regular columns in the results, yet may be specified as part of the WHERE clause. You can use pseudo columns to access additional features from BlackBaud Raiser's Edge NXT.
SELECT * FROM Constituents WHERE IncludeInactive = 'false'
Returns the number of rows matching the query criteria.
SELECT COUNT(*) FROM Constituents WHERE Type = 'Home'
Returns the number of distinct, non-null field values matching the query criteria.
SELECT COUNT(DISTINCT Id) AS DistinctValues FROM Constituents WHERE Type = 'Home'
Returns the average of the column values.
SELECT AddressLines, AVG(AnnualRevenue) FROM Constituents WHERE Type = 'Home' GROUP BY AddressLines
Returns the minimum column value.
SELECT MIN(AnnualRevenue), AddressLines FROM Constituents WHERE Type = 'Home' GROUP BY AddressLines
Returns the maximum column value.
SELECT AddressLines, MAX(AnnualRevenue) FROM Constituents WHERE Type = 'Home' GROUP BY AddressLines
Returns the total sum of the column values.
SELECT SUM(AnnualRevenue) FROM Constituents WHERE Type = 'Home'
The CData Cloud supports standard SQL joins like the following examples.
An inner join selects only rows from both tables that match the join condition:
SELECT c.Category, c.Fundraisers, c.Summary, o.Name, o.PhoneDoNotCall FROM Actions c INNER JOIN Constituents o ON c.ConstituentId = o.Id
A left join selects all rows in the FROM table and only matching rows in the JOIN table:
SELECT c.GiftStatus, o.CheckNumber, o.CheckoutTransactionId, o.PaymentMethod FROM Gifts c LEFT JOIN GiftPayments o ON c.Id = o.GiftsId
The following date literal functions can be used to filter date fields using relative intervals. Note that while the <, >, and = operators are supported for these functions, <= and >= are not.
The current day.
SELECT * FROM MyTable WHERE MyDateField = L_TODAY()
The previous day.
SELECT * FROM MyTable WHERE MyDateField = L_YESTERDAY()
The following day.
SELECT * FROM MyTable WHERE MyDateField = L_TOMORROW()
Every day in the preceding week.
SELECT * FROM MyTable WHERE MyDateField = L_LAST_WEEK()
Every day in the current week.
SELECT * FROM MyTable WHERE MyDateField = L_THIS_WEEK()
Every day in the following week.
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_WEEK()Also available:
The previous n days, excluding the current day.
SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_DAYS(3)
The following n days, including the current day.
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_DAYS(3)Also available:
Every day in every week, starting n weeks before current week, and ending in the previous week.
SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_WEEKS(3)
Every day in every week, starting the following week, and ending n weeks in the future.
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_WEEKS(3)Also available:
You can use the SELECT INTO statement to export formatted data to a file.
The following query exports data into a file formatted in comma-separated values (CSV):
SELECT Id, AddressLines INTO [csv://Constituents.txt] FROM [Constituents] WHERE Type = 'Home'You can specify other formats in the file URI. The possible delimiters are tab, semicolon, and comma with the default being a comma. The following example exports tab-separated values:
SELECT Id, AddressLines INTO [csv://Constituents.txt;delimiter=tab] FROM [Constituents] WHERE Type = 'Home'You can specify other file formats in the URI. The following example exports tab-separated values:
The Cloud provides functions that are similar to those that are available with most standard databases. These functions are implemented in the CData provider engine and thus are available across all data sources with the same consistent API. Three categories of functions are available: string, date, and math.
The Cloud interprets all SQL function inputs as either strings or column identifiers, so you need to escape all literals as strings, with single quotes. For example, contrast the SQL Server syntax and Cloud syntax for the DATENAME function:
SELECT DATENAME(yy,GETDATE())
SELECT DATENAME('yy',GETDATE())
These functions perform string manipulations and return a string value. See STRING Functions for more details.
SELECT CONCAT(firstname, space(4), lastname) FROM Constituents WHERE Type = 'Home'
These functions perform date and date time manipulations. See DATE Functions for more details.
SELECT CURRENT_TIMESTAMP() FROM Constituents
These functions provide mathematical operations. See MATH Functions for more details.
SELECT RAND() FROM Constituents
SELECT CONCAT('Mr.', SPACE(2), firstname, SPACE(4), lastname) FROM Constituents
Returns the ASCII code value of the left-most character of the character expression.
SELECT ASCII('0');
-- Result: 48
Converts the integer ASCII code to the corresponding character.
SELECT CHAR(48);
-- Result: '0'
Returns the starting position of the specified expression in the character string.
SELECT CHARINDEX('456', '0123456');
-- Result: 4
SELECT CHARINDEX('456', '0123456', 5);
-- Result: -1
Returns the number of UTF-8 characters present in the expression.
SELECT CHAR_LENGTH('sample text') FROM Account LIMIT 1
-- Result: 11
Returns the string that is the concatenation of two or more string values.
SELECT CONCAT('Hello, ', 'world!');
-- Result: 'Hello, world!'
Returns 1 if expressionToFind is found within expressionToSearch; otherwise, 0.
SELECT CONTAINS('0123456', '456');
-- Result: 1
SELECT CONTAINS('0123456', 'Not a number');
-- Result: 0
Returns 1 if character_expression ends with character_suffix; otherwise, 0.
SELECT ENDSWITH('0123456', '456');
-- Result: 1
SELECT ENDSWITH('0123456', '012');
-- Result: 0
Returns the number of bytes present in the file at the specified file path.
SELECT FILESIZE('C:/Users/User1/Desktop/myfile.txt');
-- Result: 23684
Returns the value formatted with the specified format.
SELECT FORMAT(12.34, '#');
-- Result: 12
SELECT FORMAT(12.34, '#.###');
-- Result: 12.34
SELECT FORMAT(1234, '0.000E0');
-- Result: 1.234E3
SELECT FORMAT('2019/01/01', 'yyyy-MM-dd');
-- Result: 2019-01-01
SELECT FORMAT('20190101', 'yyyyMMdd', 'yyyy-MM-dd');
-- Result: '2019-01-01'
Returns a representation of the unix_timestamp argument as a value in YYYY-MM-DD HH:MM:SS expressed in the current time zone.
SELECT FROM_UNIXTIME(1540495231, 1);
-- Result: 2018-10-25 19:20:31
SELECT FROM_UNIXTIME(1540495357385, 0);
-- Result: 2018-10-25 19:22:37
Returns the hash of the input value as a byte array using the given algorithm. The supported algorithms are MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, and SHA3_512.
SELECT HASHBYTES('MD5', 'Test');
-- Result (byte array): 0x0CBC6611F5540BD0809A388DC95A615B
Returns the starting position of the specified expression in the character string.
SELECT INDEXOF('0123456', '456');
-- Result: 4
SELECT INDEXOF('0123456', '456', 5);
-- Result: -1
Replaces null with the specified replacement value.
SELECT ISNULL(42, 'Was NULL');
-- Result: 42
SELECT ISNULL(NULL, 'Was NULL');
-- Result: 'Was NULL'
Computes the average value of a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.
SELECT JSON_AVG('[1,2,3,4,5]', '$[x]');
-- Result: 3
SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 3
SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
-- Result: 4.5
Returns the number of elements in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.
SELECT JSON_COUNT('[1,2,3,4,5]', '$[x]');
-- Result: 5
SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 5
SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
-- Result: 2
Selects any value in a JSON array or object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.
SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test');
-- Result: '{"data":1}'
SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test.data');
-- Result: 1
SELECT JSON_EXTRACT('{"test": {"data": [1, 2, 3]}}', '$.test.data[1]');
-- Result: 2
Gets the maximum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.
SELECT JSON_MAX('[1,2,3,4,5]', '$[x]');
-- Result: 5
SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 5
SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[..3]');
-- Result: 4
Gets the minimum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or null.
SELECT JSON_MIN('[1,2,3,4,5]', '$[x]');
-- Result: 1
SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 1
SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
-- Result: 4
Computes the summary value in JSON according to the JSONPath expression. Return value is numeric or null.
SELECT JSON_SUM('[1,2,3,4,5]', '$[x]');
-- Result: 15
SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]');
-- Result: 15
SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]');
-- Result: 9
Returns the specified number of characters counting from the left of the specified string.
SELECT LEFT('1234567890', 3);
-- Result: '123'
Returns the number of characters of the specified string expression.
SELECT LEN('12345');
-- Result: 5
Returns an integer representing how many characters into the string the substring appears.
SELECT LOCATE('sample','XXXXXsampleXXXXX');
-- Result: 6
Returns the character expression with the uppercase character data converted to lowercase.
SELECT LOWER('MIXED case');
-- Result: 'mixed case'
Returns the character expression with leading blanks removed.
SELECT LTRIM(' trimmed');
-- Result: 'trimmed'
Replaces the characters between start_index and end_index with the mask_character within the string.
SELECT MASK('1234567890','*',);
-- Result: '**********'
SELECT MASK('1234567890','*', 4);
-- Result: '1234******'
SELECT MASK('1234567890','*', 4, 2);
-- Result: '1234****90'
Returns the Unicode character with the specified integer code as defined by the Unicode standard.
Returns the number of bytes present in the expression.
SELECT OCTET_LENGTH('text') FROM Account LIMIT 1
-- Result: 4
Returns the starting position of the first occurrence of the pattern in the expression. Returns 0 if the pattern is not found.
SELECT PATINDEX('123%', '1234567890');
-- Result: 1
SELECT PATINDEX('%890', '1234567890');
-- Result: 8
SELECT PATINDEX('%456%', '1234567890');
-- Result: 4
Returns the starting position of the specified expression in the character string.
SELECT POSITION('456' IN '123456');
-- Result: 4
SELECT POSITION('x' IN '123456');
-- Result: 0
Returns a valid SQL Server-delimited identifier by adding the necessary delimiters to the specified Unicode string.
SELECT QUOTENAME('table_name');
-- Result: '[table_name]'
SELECT QUOTENAME('table_name', '"');
-- Result: '"table_name"'
SELECT QUOTENAME('table_name', '[');
-- Result: '[table_name]'
Replaces all occurrences of a string with another string.
SELECT REPLACE('1234567890', '456', '|');
-- Result: '123|7890'
SELECT REPLACE('123123123', '123', '.');
-- Result: '...'
SELECT REPLACE('1234567890', 'a', 'b');
-- Result: '1234567890'
Repeats the string value the specified number of times.
SELECT REPLACE('x', 5);
-- Result: 'xxxxx'
Returns the reverse order of the string expression.
SELECT REVERSE('1234567890');
-- Result: '0987654321'
Returns the right part of the string with the specified number of characters.
SELECT RIGHT('1234567890', 3);
-- Result: '890'
Returns the character expression after it removes trailing blanks.
SELECT RTRIM('trimmed ');
-- Result: 'trimmed'
Returns the four-character Soundex code, based on how the string sounds when spoken.
SELECT SOUNDEX('smith');
-- Result: 'S530'
Returns the string that consists of repeated spaces.
SELECT SPACE(5);
-- Result: ' '
Returns a section of the string between to delimiters.
SELECT SPLIT('a/b/c/d', '/', 1);
-- Result: 'a'
SELECT SPLIT('a/b/c/d', '/', -2);
-- Result: 'c'
Returns 1 if character_expression starts with character_prefix; otherwise, 0.
SELECT STARTSWITH('0123456', '012');
-- Result: 1
SELECT STARTSWITH('0123456', '456');
-- Result: 0
Returns the character data converted from the numeric data. For example, STR(123.45, 6, 1) returns 123.5.
SELECT STR('123.456');
-- Result: '123'
SELECT STR('123.456', 2);
-- Result: '**'
SELECT STR('123.456', 10, 2);
-- Result: '123.46'
Inserts a string into another string. It deletes the specified length of characters in the first string at the start position and then inserts the second string into the first string at the start position.
SELECT STUFF('1234567890', 3, 2, 'xx');
-- Result: '12xx567890'
Returns the part of the string with the specified length; starts at the specified index.
SELECT SUBSTRING('1234567890' FROM 3 FOR 2);
-- Result: '34'
SELECT SUBSTRING('1234567890' FROM 3);
-- Result: '34567890'
Converts the value of this instance to its equivalent string representation.
SELECT TOSTRING(123);
-- Result: '123'
SELECT TOSTRING(123.456);
-- Result: '123.456'
SELECT TOSTRING(null);
-- Result: ''
Returns the character expression with leading and/or trailing blanks removed.
SELECT TRIM(' trimmed ');
-- Result: 'trimmed'
SELECT TRIM(LEADING FROM ' trimmed ');
-- Result: 'trimmed '
SELECT TRIM('-' FROM '-----trimmed-----');
-- Result: 'trimmed'
SELECT TRIM(BOTH '-' FROM '-----trimmed-----');
-- Result: 'trimmed'
SELECT TRIM(TRAILING '-' FROM '-----trimmed-----');
-- Result: '-----trimmed'
Returns the integer value defined by the Unicode standard of the first character of the input expression.
Returns the character expression with lowercase character data converted to uppercase.
SELECT UPPER('MIXED case');
-- Result: 'MIXED CASE'
Extracts an XML document using the specified XPath to flatten the XML. A comma is used to separate the outputs by default, but this can be changed by specifying the third parameter.
SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch');
-- Result: 'a,e,i,o,u'
SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch', ';');
-- Result: 'a;e;i;o;u'
Returns the current date value.
SELECT CURRENT_DATE();
-- Result: 2018-02-01
Returns the current time stamp of the database system as a datetime value. This value is equal to GETDATE and SYSDATETIME, and is always in the local timezone.
SELECT CURRENT_TIMESTAMP();
-- Result: 2018-02-01 03:04:05
Returns the datetime value that results from adding the specified number (a signed integer) to the specified date part of the date.
SELECT DATEADD('d', 5, '2018-02-01');
-- Result: 2018-02-06
SELECT DATEADD('hh', 5, '2018-02-01 00:00:00');
-- Result: 2018-02-01 05:00:00
Returns the difference (a signed integer) of the specified time interval between the specified start date and end date.
SELECT DATEDIFF('d', '2018-02-01', '2018-02-10');
-- Result: 9
SELECT DATEDIFF('hh', '2018-02-01 00:00:00', '2018-02-01 12:00:00');
-- Result: 12
Returns the datetime value for the specified year, month, and day.
SELECT DATEFROMPARTS(2018, 2, 1);
-- Result: 2018-02-01
Returns the character string that represents the specified date part of the specified date.
SELECT DATENAME('yy', '2018-02-01');
-- Result: '2018'
SELECT DATENAME('dw', '2018-02-01');
-- Result: 'Thursday'
Returns a character string that represents the specified date part of the specified date.
SELECT DATEPART('yy', '2018-02-01');
-- Result: 2018
SELECT DATEPART('dw', '2018-02-01');
-- Result: 5
Returns the datetime value for the specified date parts.
SELECT DATETIME2FROMPARTS(2018, 2, 1, 1, 2, 3, 456, 3);
-- Result: 2018-02-01 01:02:03.456
Returns the datetime value for the specified date parts.
SELECT DATETIMEFROMPARTS(2018, 2, 1, 1, 2, 3, 456);
-- Result: 2018-02-01 01:02:03.456
Truncates the date to the precision of the given date part. Modeled after the Oracle TRUNC function.
SELECT DATE_TRUNC('05-04-2005', 'YY');
-- Result: '1/1/2005'
SELECT DATE_TRUNC('05-04-2005', 'MM');
-- Result: '5/1/2005'
Truncates the date to the precision of the given date part. Modeled after the PostgreSQL date_trunc function.
SELECT DATE_TRUNC2('year', '2020-02-04');
-- Result: '2020-01-01'
SELECT DATE_TRUNC2('week', '2020-02-04', 'monday');
-- Result: '2020-02-02', which is the previous Monday
Returns the integer that specifies the day component of the specified date.
SELECT DAY('2018-02-01');
-- Result: 1
SELECT DAYOFMONTH('04/15/2000');
-- Result: 15
SELECT DAYOFWEEK('04/15/2000');
-- Result: 7
SELECT DAYOFYEAR('04/15/2000');
-- Result: 106
Returns the last day of the month that contains the specified date with an optional offset.
SELECT EOMONTH('2018-02-01');
-- Result: 2018-02-28
SELECT LAST_DAY('2018-02-01');
-- Result: 2018-02-28
SELECT EOMONTH('2018-02-01', 2);
-- Result: 2018-04-30
SELECT FDWEEK('02-08-2018');
-- Result: 2/4/2018
SELECT FDMONTH('02-08-2018');
-- Result: 2/1/2018
SELECT FDQUARTER('05-08-2018');
-- Result: 4/1/2018
Returns the time stamp associated with the Date Modified of the relevant file.
SELECT FILEMODIFIEDTIME('C:/Documents/myfile.txt');
-- Result: 6/25/2019 10:06:58 AM
Returns a date derived from the number of days after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL FROM_DAYS function.
SELECT FROM_DAYS(736000); -- Result: 2/6/2015
Returns the current time stamp of the database system as a datetime value. This value is equal to CURRENT_TIMESTAMP and SYSDATETIME, and is always in the local timezone.
SELECT GETDATE();
-- Result: 2018-02-01 03:04:05
Returns the current time stamp of the database system formatted as a UTC datetime value. This value is equal to SYSUTCDATETIME.
SELECT GETUTCDATE();
-- For example, if the local timezone is Eastern European Time (GMT+2)
-- Result: 2018-02-01 05:04:05
Returns the hour component from the provided datetime.
SELECT HOUR('02-02-2020 11:30:00');
-- Result: 11
Returns 1 if the value is a valid date, time, or datetime value; otherwise, 0.
SELECT ISDATE('2018-02-01', 'yyyy-MM-dd');
-- Result: 1
SELECT ISDATE('Not a date');
-- Result: 0
Returns a time stamp equivalent to exactly one week before the current date.
SELECT LAST_WEEK(); //Assume the date is 3/17/2020 -- Result: 3/10/2020
Returns a time stamp equivalent to exactly one month before the current date.
SELECT LAST_MONTH(); //Assume the date is 3/17/2020 -- Result: 2/17/2020
Returns a time stamp equivalent to exactly one year before the current date.
SELECT LAST_YEAR(); //Assume the date is 3/17/2020 -- Result: 3/10/2019
Returns the last day of the provided week.
SELECT LDWEEK('02-02-2020');
-- Result: 2/8/2020
Returns the last day of the provided month.
SELECT LDMONTH('02-02-2020');
-- Result: 2/29/2020
Returns the last day of the provided quarter.
SELECT LDQUARTER('02-02-2020');
-- Result: 3/31/2020
Returns a date value from a year and a number of days.
SELECT MAKEDATE(2020, 1);
-- Result: 2020-01-01
Returns the minute component from the provided datetime.
SELECT MINUTE('02-02-2020 11:15:00');
-- Result: 15
Returns the month component from the provided datetime.
SELECT MONTH('02-02-2020');
-- Result: 2
Returns the quarter associated with the provided datetime.
SELECT QUARTER('02-02-2020');
-- Result: 1
Returns the second component from the provided datetime.
SELECT SECOND('02-02-2020 11:15:23');
-- Result: 23
Returns the datetime value for the specified date and time.
SELECT SMALLDATETIMEFROMPARTS(2018, 2, 1, 1, 2);
-- Result: 2018-02-01 01:02:00
Parses the provided string value and returns the corresponding datetime.
SELECT STRTODATE('03*04*2020','dd*MM*yyyy');
-- Result: 4/3/2020
Returns the current time stamp as a datetime value of the database system. It is equal to GETDATE and CURRENT_TIMESTAMP, and is always in the local timezone.
SELECT SYSDATETIME();
-- Result: 2018-02-01 03:04:05
Returns the current system date and time as a UTC datetime value. It is equal to GETUTCDATE.
SELECT SYSUTCDATETIME();
-- For example, if the local timezone is Eastern European Time (GMT+2)
-- Result: 2018-02-01 05:04:05
Returns the time value for the specified time and with the specified precision.
SELECT TIMEFROMPARTS(1, 2, 3, 456, 3);
-- Result: 01:02:03.456
Returns the number of days since 0000-00-01. This will only return a value for dates on or after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL TO_DAYS function.
SELECT TO_DAYS('02-06-2015');
-- Result: 736000
Returns the week (of the year) associated with the provided datetime.
SELECT WEEK('02-17-2020 11:15:23');
-- Result: 8
Returns the integer that specifies the year of the specified date.
SELECT YEAR('2018-02-01');
-- Result: 2018
Returns the absolute (positive) value of the specified numeric expression.
SELECT ABS(15);
-- Result: 15
SELECT ABS(-15);
-- Result: 15
Returns the arc cosine, the angle in radians whose cosine is the specified float expression.
SELECT ACOS(0.5);
-- Result: 1.0471975511966
Returns the arc sine, the angle in radians whose sine is the specified float expression.
SELECT ASIN(0.5);
-- Result: 0.523598775598299
Returns the arc tangent, the angle in radians whose tangent is the specified float expression.
SELECT ATAN(10);
-- Result: 1.47112767430373
Returns the angle in radians between the positive x-axis and the ray from the origin to the point (y, x) where x and y are the values of the two specified float expressions.
SELECT ATN2(1, 1);
-- Result: 0.785398163397448
Returns the smallest integer greater than or equal to the specified numeric expression.
SELECT CEILING(1.3);
-- Result: 2
SELECT CEILING(1.5);
-- Result: 2
SELECT CEILING(1.7);
-- Result: 2
Returns the trigonometric cosine of the specified angle in radians in the specified expression.
SELECT COS(1);
-- Result: 0.54030230586814
Returns the trigonometric cotangent of the angle in radians specified by float_expression.
SELECT COT(1);
-- Result: 0.642092615934331
Returns the angle in degrees for the angle specified in radians.
SELECT DEGREES(3.1415926);
-- Result: 179.999996929531
Returns the exponential value of the specified float expression. For example, EXP(LOG(20)) is 20.
SELECT EXP(2);
-- Result: 7.38905609893065
Evaluates the expression.
SELECT EXPR('1 + 2 * 3');
-- Result: 7
SELECT EXPR('1 + 2 * 3 == 7');
-- Result: true
Returns the largest integer less than or equal to the numeric expression.
SELECT FLOOR(1.3);
-- Result: 1
SELECT FLOOR(1.5);
-- Result: 1
SELECT FLOOR(1.7);
-- Result: 1
Returns the greatest of the supplied integers.
SELECT GREATEST(3,5,8,10,1) -- Result: 10
Returns a the equivalent hex for the input value.
SELECT HEX(866849198);
-- Result: 33AB11AE
SELECT HEX('Sample Text');
-- Result: 53616D706C652054657874
Returns the least of the supplied integers.
SELECT LEAST(3,5,8,10,1) -- Result: 1
Returns the natural logarithm of the specified float expression.
SELECT LOG(7.3890560);
-- Result: 1.99999998661119
Returns the base-10 logarithm of the specified float expression.
SELECT LOG10(10000);
-- Result: 4
Returns the integer value associated with the remainder when dividing the dividend by the divisor.
SELECT MOD(10,3); -- Result: 1
Returns the opposite to the real number input.
SELECT NEGATE(10); -- Result: -10 SELECT NEGATE(-12.4) --Result: 12.4
Returns the constant value of pi.
SELECT PI()
-- Result: 3.14159265358979
Returns the value of the specified expression raised to the specified power.
SELECT POWER(2, 10);
-- Result: 1024
SELECT POWER(2, -2);
-- Result: 0.25
Returns the angle in radians of the angle in degrees.
SELECT RADIANS(180);
-- Result: 3.14159265358979
Returns a pseudorandom float value from 0 through 1, exclusive.
SELECT RAND();
-- This result may be different, since the seed is randomized
-- Result: 0.873159630165044
SELECT RAND(1);
-- This result will always be the same, since the seed is constant
-- Result: 0.248668584157093
Returns the numeric value rounded to the specified length or precision.
SELECT ROUND(1.3, 0);
-- Result: 1
SELECT ROUND(1.55, 1);
-- Result: 1.6
SELECT ROUND(1.7, 0, 0);
-- Result: 2
SELECT ROUND(1.7, 0, 1);
-- Result: 1
SELECT ROUND (1.24);
-- Result: 1.0
Returns the positive sign (1), 0, or negative sign (-1) of the specified expression.
SELECT SIGN(0);
-- Result: 0
SELECT SIGN(10);
-- Result: 1
SELECT SIGN(-10);
-- Result: -1
Returns the trigonometric sine of the angle in radians.
SELECT SIN(1);
-- Result: 0.841470984807897
Returns the square root of the specified float value.
SELECT SQRT(100);
-- Result: 10
Returns the square of the specified float value.
SELECT SQUARE(10);
-- Result: 100
SELECT SQUARE(-10);
-- Result: 100
Returns the tangent of the input expression.
SELECT TAN(1);
-- Result: 1.5574077246549
Returns the supplied decimal number truncated to have the supplied decimal precision.
SELECT TRUNC(10.3423,2); -- Result: 10.34
To execute stored procedures, you can use EXECUTE or EXEC statements.
EXEC and EXECUTE assign stored procedure inputs, referenced by name, to values or parameter names.
To execute a stored procedure as an SQL statement, use the following syntax:
{ EXECUTE | EXEC } <stored_proc_name>
{
[ @ ] <input_name> = <expression>
} [ , ... ]
<expression> ::=
| @ <parameter>
| ?
| <literal>
Reference stored procedure inputs by name:
EXECUTE my_proc @second = 2, @first = 1, @third = 3;
Execute a parameterized stored procedure statement:
EXECUTE my_proc second = @p1, first = @p2, third = @p3;
PIVOT and UNPIVOT can be used to change a table-valued expression into another table.
"SELECT 'AverageCost' AS Cost_Sorted_By_Production_Days, [0], [1], [2], [3], [4]
FROM
(
SELECT DaysToManufacture, StandardCost
FROM Production.Product
) AS SourceTable
PIVOT
(
AVG(StandardCost)
FOR DaysToManufacture IN ([0], [1], [2], [3], [4])
) AS PivotTable;"
"SELECT VendorID, Employee, Orders
FROM
(SELECT VendorID, Emp1, Emp2, Emp3, Emp4, Emp5
FROM pvt) p
UNPIVOT
(Orders FOR Employee IN
(Emp1, Emp2, Emp3, Emp4, Emp5)
)AS unpvt;"
For further information on PIVOT and UNPIVOT, see FROM clause plus JOIN, APPLY, PIVOT (Transact-SQL)
This section shows the available API objects and provides more information on executing SQL to BlackBaud Raiser's Edge NXT APIs.
Views describes the available views. Views are statically defined to model Actions, Emails, Events, etc..
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 are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.
Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.
Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.
| 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 |
Retrieves a list of attachments for an action.
The Cloud 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 Cloud.
Note: ActionId is required in order to query ActionAttachments.
SELECT * FROM ActionAttachments WHERE ActionId = '335'
| 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. |
Retrieves custom fields for an action
| 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. |
Retrieves a list of actions for all constituents and for specified constituent and details of the specified action.
The Cloud 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 Cloud.
SELECT * FROM Actions WHERE ConstituentId = '280' SELECT * FROM Actions WHERE ComputedStatus = 'Completed' SELECT * FROM Actions WHERE DateAdded >= '2010-06-01 14:03:35'
| 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 | 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 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 | Defines a list identifier used to filter the set of actions to those included in the specified list. If this value is set, other specified filters will be ignored. |
Addresses store information about constituent residences and other addresses along with information about where or whether to send mail
The Cloud 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 Cloud.
SELECT * FROM Addresses WHERE ConstituentId = '280' SELECT * FROM Addresses WHERE DateModified >= '2010-06-01 14:03:35' SELECT * FROM Addresses WHERE IncludeInactive = true
| 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 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 | If set to true, includes inactive addresses in the result. |
Retrieves a list of aliases for a constituent
The Cloud 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 Cloud.
Note: ConstituentId is required in order to query Aliases.
SELECT * FROM Aliases WHERE ConstituentId = '280'
| 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. |
Returns a list of attachments for an appeal.
The Cloud 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 Cloud.
Note: AppealId is required in order to query AppealAttachments.
SELECT * FROM AppealAttachments WHERE AppealId = '2'
| Name | Type | References | Description |
| Id [KEY] | String | The immutable system record ID of the attachment. | |
| AppealId | String | 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. |
Returns a list of attachments for a campaign.
The Cloud 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 Cloud.
Note: CampaignId is required in order to query CampaignAttachments.
SELECT * FROM CampaignAttachments WHERE CampaignId = '2'
| 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 are your organization's overall fundraising efforts or initiatives, such as operating expenses, new buildings, and endowments
The Cloud 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 Cloud.
SELECT * FROM Campaigns WHERE DateModified >= '2010-06-01 14:03:35' SELECT * FROM Campaigns WHERE IncludeInactive=true
| 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 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 | If set to true, includes inactive campaigns in the result. |
Returns a list of consent categories.
The Cloud 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 Cloud.
SELECT * FROM ConsentCategories WHERE IncludeInactive = true
| 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 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 | If set to true, includes inactive consent categories in the result. |
Returns a list of valid consent channel category combinations.
The Cloud 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 Cloud.
| 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. |
Represents the consent channel entity
The Cloud 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 Cloud.
| Name | Type | References | Description |
| Description | String | The name of the consent channel. |
Represents the consent source entity
The Cloud 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 Cloud.
SELECT * FROM ConsentSources WHERE IncludeInactive=true
| 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 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 | If set to true, includes inactive consent sources in the result. |
Returns a list of appeals for a constituent.
The Cloud 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 Cloud.
SELECT * FROM ConstituentAppeals WHERE ConstituentId='280'
| 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. |
Returns a list of attachments for a constituent.
The Cloud 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 Cloud.
Note: ConstituentId is required in order to query ConstituentAttachments.
SELECT * FROM ConstituentAttachments WHERE ConstituentId = '280'
| 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. |
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
The Cloud 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 Cloud.
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
| 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 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 | This computed field indicates that the constituent code is active if the current date is after any start date and before any end date. |
Returns a list of constituent consent records.
The Cloud 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 Cloud.
Note: ConstituentId is required in order to query ConstituentConsents.
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')
| 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 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 | If set to true, includes inactive constituent consents in the result. |
Returns a list of fundraiser assignments for a constituent.
The Cloud 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 Cloud.
Note: ConstituentId is required in order to query ConstituentFundraiserAssignments.
SELECT * FROM ConstituentFundraiserAssignments WHERE ConstituentId = '280'
| 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 | 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 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 | If set to true, includes inactive assignments in the result. |
Returns a paginated list of constituents
The Cloud 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 Cloud.
SELECT * FROM Constituents WHERE Id = '280'
SELECT * FROM Constituents WHERE ListId = '75e71c26-7288-49db-a767-f9305b704fee'
SELECT * FROM Constituents WHERE FundraiserStatus IN ('Active', 'None')
| 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 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 | Represents a list of constituent codes. Returns constituents if any of the specified constituent codes match any of their active constituent codes. | |
| CustomFieldCategory | String | Represents a list of custom field categories. Returns constituents if any of the specified custom field categories match any of their active custom fields. | |
| Fields | String | Represents the fields to include on the returned records. | |
| IncludeDeceased | Boolean | Set this parameter to true to include deceased constituents in the response. | |
| IncludeInactive | Boolean | Set this parameter to true to include inactive constituents in the response. | |
| ListId | String | Defines a list identifier used to filter the set of constituents to those included in the specified list. If this value is set, other specified filters will be ignored. | |
| PostalCode | String | Represents a comma-separated list of postal codes. Returns constituents if any of the specified postal codes match the postal code for their preferred address. |
Retrieves custom fields for all constituents
The Cloud 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 Cloud.
| 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. |
Returns a list of solicit codes for the specified constituent.
The Cloud 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 Cloud.
Note: ConstituentId is required in order to query ConstituentSolicitCodes.
SELECT * FROM ConstituentSolicitCodes WHERE ConstituentId = '280'
| 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. |
Returns the list of available countries.
The Cloud 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 Cloud.
| 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. |
Returns a list of educations for all constituent or a specified constituent
The Cloud 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 Cloud.
SELECT * FROM Educations WHERE ConstituentId = '280' SELECT * FROM Educations WHERE DateAdded >= '2010-06-01 14:03:35'
| 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. |
Returns a list of email addresses of all constituents or a specified constituent
The Cloud 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 Cloud.
SELECT * FROM Emails WHERE ConstituentId = '280' SELECT * FROM Emails WHERE DateAdded >= '2010-06-01 14:03:35'
| 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 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 | If set to true, includes inactive email addresses in the result. |
Returns a list of active event categories.
The Cloud 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 Cloud.
SELECT * FROM EventCategories WHERE IncludeInactive = true
| 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 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 | If set to true, includes inactive campaigns in the result. |
Returns a list of fees for an event.
The Cloud 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 Cloud.
Note: EventId is required in order to query EventFees.
SELECT * FROM EventFees WHERE EventId = '2'
| 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. |
The participant's basic summary information
The Cloud 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 Cloud.
Note: EventId is required in order to query EventParticipantGuests.
SELECT * FROM EventParticipantGuests WHERE EventId = '2'
| 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. |
The individual's membership category
The Cloud 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 Cloud.
Note: EventId is required in order to query EventParticipantMemberships.
SELECT * FROM EventParticipantMemberships WHERE EventId = '2'
| 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. |
Returns the participant options for an event.
The Cloud 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 Cloud.
Note: EventId is required in order to query EventParticipantOptions.
SELECT * FROM EventParticipantOptions WHERE EventId = '2'
| 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. |
Returns a list of participants for an event.
The Cloud 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 Cloud.
Note: EventId is required in order to query EventParticipants.
SELECT * FROM EventParticipants WHERE EventId = '2' SELECT * FROM EventParticipants WHERE EventId = '2' AND DateAdded >= '2010-06-01 14:03:35'
| 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. | |
| 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 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 | A filter to include or exclude participants based on whether they have a primary email address that's not marked Do not email. | |
| PhoneCallEligible | Boolean | A filter to include or exclude participants based on whether they have a primary phone number that's not marked Do not call. | |
| FeesPaid | Boolean | A filter to include or exclude participants that have paid or not paid their fees. | |
| Fields | String | Represents a list of fields to include on the returned records. |
Returns a list of events
The Cloud 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 Cloud.
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'
| 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 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 | Represents a list of fields to include on the returned records | |
| IncludeInactive | Boolean | If set to true, includes inactive phones in the result. |
Returns a list of attachments for a fund.
The Cloud 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 Cloud.
Note: FundId is required in order to query FundAttachments.
SELECT * FROM FundAttachments WHERE FundId = '4'
| 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. |
Returns a list of assignments for a fundraiser.
The Cloud 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 Cloud.
Note: FundraiserId is required in order to query FundraiserAssignments.
SELECT * FROM FundraiserAssignments WHERE FundraiserId = '4'
| 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 | 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. |
Returns a list of goals for a fundraiser
The Cloud 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 Cloud.
Note: FundraiserId is required in order to query FundraiserGoals.
SELECT * FROM FundraiserGoals WHERE FundraiserId = '4'
| Name | Type | References | Description |
| Id [KEY] | String | The immutable system record ID of the fundraiser goal. | |
| AmountValue | Double | The fundraiser goal amount. | |
| AppealId | String | 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. |
Returns a list of fundraising appeals.
The Cloud 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 Cloud.
SELECT * FROM FundraisingAppeals WHERE Id = '4' SELECT * FROM FundraisingAppeals WHERE IncludeInactive = true
| 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 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 | If set to true, includes inactive appeals in the result. |
Returns a list of funds.
The Cloud 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 Cloud.
SELECT * FROM Funds WHERE Id = '4' SELECT * FROM Funds WHERE IncludeInactive = true
| 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 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 | If set to true, includes inactive funds in the result. |
Returns a list of acknowledgements for a gift
The Cloud 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 Cloud.
Note: GiftId are required in order to query GiftAcknowledgements.
SELECT * FROM GiftAcknowledgements WHERE GiftId = '476'
| 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. |
Returns a list of attachments for a gift.
The Cloud 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 Cloud.
Note: GiftId are required in order to query GiftAttachments.
SELECT * FROM GiftAttachments WHERE GiftId = '476'
| 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. |
Returns a list of gift batches.
The Cloud 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 Cloud.
| 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 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 | If set to true, includes inactive gift batches in the result. |
Returns payments for a gift.
The Cloud 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 Cloud.
Note: GiftId are required in order to query GiftPayments.
SELECT * FROM GiftPayments WHERE GiftId = '476'
| 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. |
Returns receipts for a gift.
The Cloud 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 Cloud.
Note: GiftId are required in order to query GiftReceipts.
SELECT * FROM GiftReceipts WHERE GiftId = '476'
| 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. |
Returns a paginated list of gifts
The Cloud 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 Cloud.
SELECT * FROM Gifts WHERE ConstituentId IN ('280', '281')
SELECT * FROM Gifts WHERE PostStatus = 'Posted'
SELECT * FROM Gifts WHERE Type IN ('Pledge', 'GiftInKind')
| 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 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 | Defines a list identifier used to filter the set of gifts to those included in the specified list. If this value is set, other specified filters will be ignored. | |
| AppealId | String | Returns gifts if any of the specified appeal identifiers match any of their appeals. | |
| FundId | String | Returns gifts if any of the specified fund identifiers match any of their funds. | |
| CampaignId | String | Returns gifts if any of the specified campaign identifiers match any of their campaigns. | |
| AcknowledgmentStatus | String | Returns gifts if their acknowledgement status matches any specified. | |
| ReceiptStaus | String | Returns gifts if their receipt status matches any specified. |
Retrieves custom fields for all gifts
The Cloud 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 Cloud.
| 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. |
Returns soft credits for a gift.
The Cloud 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 Cloud.
Note: GiftId are required in order to query GiftSoftCredits.
SELECT * FROM GiftSoftCredits WHERE GiftId = '476'
| 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. |
Returns the splits for a gift.
The Cloud 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 Cloud.
Note: GiftId are required in order to query GiftSplits.
SELECT * FROM GiftSplits WHERE GiftId = '476'
| 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. |
Returns the first, latest or greatest gift recorded for a constituent.
The Cloud 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 Cloud.
Note: ConstituentId and GivingSummaryType are required in order to query Giving.
SELECT * FROM Giving WHERE ConstituentId = '280' AND GivingSummaryType = 'greatest'
| 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. |
Returns the giving appeals summary for the constituent
The Cloud 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 Cloud.
Note: ConstituentId and GivingSummaryType are required in order to query GivingAppeals.
SELECT * FROM GivingAppeals WHERE ConstituentId = '280' AND GivingSummaryType = 'first'
| 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. |
Returns the giving campaigns summary for the constituent
The Cloud 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 Cloud.
Note: ConstituentId and GivingSummaryType are required in order to query GivingCampaigns.
SELECT * FROM GivingCampaigns WHERE ConstituentId = '280' AND GivingSummaryType = 'greatest'
| 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. |
Returns the giving funds summary for the constituent
The Cloud 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 Cloud.
Note: ConstituentId and GivingSummaryType are required in order to query GivingFunds.
SELECT * FROM GivingFunds WHERE ConstituentId = '280' AND GivingSummaryType = 'latest'
| 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. |
Returns the lifetime giving information for a constituent.
The Cloud 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 Cloud.
Note: ConstituentId are required in order to query LifetimeGiving.
SELECT * FROM LifetimeGiving WHERE ConstituentId = '280'
| 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. |
Returns a list of lists for the given list type
The Cloud 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 Cloud.
SELECT * FROM Lists WHERE ListType = 'Constituent'
| 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. |
Returns the list of members.
The Cloud 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 Cloud.
SELECT * FROM Members WHERE ConstituentId = '280'
| 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. |
Returns a list of memberships.
The Cloud 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 Cloud.
SELECT * FROM Memberships WHERE ConstituentId = '280' SELECT * FROM Memberships WHERE DateAdded >= '2010-06-01 14:03:35'
| 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. |
Returns a list of notes that tracks helpful or important details such as specific interests and special instructions for donations
The Cloud 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 Cloud.
SELECT * FROM Notes WHERE ConstituentId='280' SELECT * FROM Notes WHERE DateAdded >= '2010-06-01 14:03:35'
| 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. |
Returns a paginated list of online presences that store a constituent's social media accounts, websites.
The Cloud 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 Cloud.
SELECT * FROM OnlinePresences WHERE ConstituentId = '280' SELECT * FROM OnlinePresences WHERE DateAdded >= '2010-06-01 14:03:35' SELECT * FROM OnlinePresences WHERE IncludeInactive = true
| 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 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 | If set to true, includes inactive online presences in the result. |
Retrieves a list of opportunities
The Cloud 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 Cloud.
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'
| 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 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 | If set to true, includes inactive opportunities in the response. | |
| ListId | String | Defines a list identifier used to filter the set of opportunities to those included in the specified list. If this value is set, other specified filters will be ignored. |
Retrieves custom fields for an opportunity
| 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. |
Returns a list of attachments for an opportunity
The Cloud 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 Cloud.
Note: OpportunityId is required in order to query OpportunityAttachments.
SELECT * FROM OpportunityAttachments WHERE OpportunityId = '4'
| Name | Type | References | Description |
| Id [KEY] | String | The immutable system record ID of the attachment. | |
| OpportunityId | String | 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. |
Returns a list of packages that contains content and other items for the appeals that organizations use to solicit gifts
The Cloud 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 Cloud.
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'
| Name | Type | References | Description |
| Id [KEY] | String | The immutable system record ID of the package. | |
| AppealId | String | 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 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 | If set to true, includes inactive packages in the response. |
Returns the fee payments for a participant.
The Cloud 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 Cloud.
Note: ParticipantId is required in order to query ParticipantFeePayments.
SELECT * FROM ParticipantFeePayments WHERE ParticipantId = '197'
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the participant fee. | |
| ParticipantId | String | 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. |
Returns a list of fees for a participant.
The Cloud 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 Cloud.
Note: ParticipantId is required in order to query ParticipantFees.
SELECT * FROM ParticipantFees WHERE ParticipantId = '197'
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the participant fee. | |
| ParticipantId | String | 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. |
Returns a list of participation levels for all events.
The Cloud 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 Cloud.
SELECT * FROM ParticipantLevels WHERE IncludeInactive = true
| 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 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 | If set to true, includes inactive participation levels in the result. |
Returns the participant options for a participant.
The Cloud 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 Cloud.
Note: ParticipantId is required in order to query ParticipantOptions.
SELECT * FROM ParticipantOptions WHERE ParticipantId = '197'
| Name | Type | References | Description |
| Id [KEY] | String | The ID of the participant option. | |
| ParticipantId | String | 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. |
Returns a list of phones for all constituents or a specific constituent
The Cloud 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 Cloud.
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'
| 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 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 | If set to true, includes inactive phones in the result. |
Returns a list of all available rating categories.
The Cloud 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 Cloud.
SELECT * FROM RatingCategories WHERE SourceName = 'Econometrics' SELECT * FROM RatingCategories WHERE IncludeInactive = true
| 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 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 | If set to true, includes inactive rating categories in the result. |
Returns a list of ratings for a constituent.
The Cloud 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 Cloud.
Note: ConstituentId is required in order to query Ratings.
SELECT * FROM Ratings WHERE ConstituentId = '280' SELECT * FROM Ratings WHERE IncludeInactive = true SELECT * FROM Ratings WHERE MostRecentlyUsed = true
| 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 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 | If set to true, includes inactive ratings in the result. | |
| MostRecentOnly | Boolean | If set to true, includes only most recent ratings in the result. |
Returns a list of all available rating sources.
The Cloud 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 Cloud.
SELECT * FROM RatingSources WHERE IncludeInactive = true
| Name | Type | References | Description |
| Inactive | Boolean | Indicates whether the rating source is inactive. | |
| Name | String | The name of the rating source. |
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 | If set to true, includes inactive rating sources in the result. |
Returns a list of relationships between constituents and other individuals and organizations such as family, friends, and employers
The Cloud 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 Cloud.
SELECT * FROM Relationships WHERE Id = '1' SELECT * FROM Relationships WHERE ConstituentId = '280'
| 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. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT operations with BlackBaud Raiser's Edge NXT.
Stored procedures accept a list of parameters, perform their intended function, and then return, if applicable, any relevant response data from BlackBaud Raiser's Edge NXT, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| AutomateRecurringGift | Converts a manual recurring gift to an automated recurring gift in the web view |
| UpdateGiftReceipt | Edits a gift receipt |
| UpdateGiftStatus | Edit the status of a recurring gift. |
Converts a manual recurring gift to an automated recurring gift in the web view
| 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. |
| Name | Type | Description |
| Success | String | Execution status of the stored procedure. |
Gets an authentication token from BlackBaudRaiserEdgeNXT.
| 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. |
| 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. |
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.
| 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. |
| Name | Type | Description |
| URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
Refreshes the OAuth access token used for authentication with BlackBaudRaiserEdgeNXT.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | Set this to the token value that expired. |
| 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. |
Edits a 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'
| 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. |
| Name | Type | Description |
| Success | String | Execution status of the stored procedure |
Edit the status of a recurring gift.
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'
| 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. |
| Name | Type | Description |
| Success | String | Execution status of the stored procedure |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for BlackBaud Raiser's Edge NXT:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| 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. |
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'
| 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. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| 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. |
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
| 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. |
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'
| 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. |
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'
| 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. |
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'
| 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. |
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 <> ''
| 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. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the Cloud can offload to the data source or process client side. Your data source may support additional SQL syntax. 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 |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| 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 CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData 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.
| 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. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| 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. |
The connection string 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 in the connection string for this provider. Click the links for further details.
| Property | Description |
| 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. |
| 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 |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
| 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 |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| Property | Description |
| IncludeCustomFields | Set to true to retrieve custom fields values for Constituents, Actions, Opportunities, and Gifts. |
| MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
| 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. |
| Readonly | You can use this property to enforce read-only access to BlackBaud Raiser's Edge NXT from the provider. |
| RTK | The runtime key used for licensing. |
| 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. |
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| 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. |
| 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. |
The client Id assigned when you register your application with an OAuth authorization server.
string
""
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.
The client secret assigned when you register your application with an OAuth authorization server.
string
""
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.
The access token for connecting using OAuth.
string
""
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.
Subscription key which provides access to the API. Found in your Developer Profile.
string
""
To obtain a key, follow these steps:
The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
string
""
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.
The verifier code returned from the OAuth authorization URL.
string
""
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.
See to obtain the OAuthVerifier value.
Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the Cloud exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file.
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.
The OAuth refresh token for the corresponding OAuth access token.
string
""
The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.
The lifetime in seconds of the OAuth AccessToken.
string
""
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
The Unix epoch timestamp in milliseconds when the current Access Token was created.
string
""
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
string
""
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.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
The protocol used by a proxy-based firewall.
string
"NONE"
This property specifies the protocol that the Cloud will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Cloud connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
| Type | Default Port | Description |
| TUNNEL | 80 | When this is set, the Cloud opens a connection to BlackBaud Raiser's Edge NXT and traffic flows back and forth through the proxy. |
| SOCKS4 | 1080 | When this is set, the Cloud sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
| SOCKS5 | 1080 | When this is set, the Cloud sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
The name or IP address of a proxy-based firewall.
string
""
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the Cloud uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
The TCP port for a proxy-based firewall.
int
0
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
The user name to use to authenticate with a proxy-based firewall.
string
""
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
A password used to authenticate to a proxy-based firewall.
string
""
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
bool
true
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of a proxy to route HTTP traffic through.
string
""
The hostname or IP address of a proxy to route HTTP traffic through. The Cloud can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the Cloud uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
The TCP port the ProxyServer proxy is running on.
int
80
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
The authentication type to use to authenticate to the ProxyServer proxy.
string
"BASIC"
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the Cloud will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
A user name to be used to authenticate to the ProxyServer proxy.
string
""
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
A password to be used to authenticate to the ProxyServer proxy.
string
""
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the Cloud uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
The SSL type to use when connecting to the ProxyServer proxy.
string
"AUTO"
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
| AUTO | Default setting. If the URL is an HTTPS URL, the Cloud will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
string
""
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Cloud uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
A filepath which designates the name and location of the log file.
string
""
Once this property is set, the Cloud will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.
Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.
If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.
For more control over what is written to the log file, you can adjust the Verbosity property.
Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.
To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.
If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.
The verbosity level that determines the amount of detail included in the log file.
string
"1"
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
Core modules to be included in the log file.
string
""
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
A string specifying the maximum size in bytes for a log file (for example, 10 MB).
string
"100MB"
When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.
Adjust the maximum number of logfiles generated with MaxLogFileCount.
A string specifying the maximum file count of log files.
int
-1
When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.
Adjust the maximum size of the logfiles generated with MaxLogFileSize.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| 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. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
string
"%APPDATA%\\CData\\RaiserEdgeNXT Data Provider\\Schema"
The path to a directory which contains the schema files for the Cloud (.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%\\CData\\RaiserEdgeNXT Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
string
""
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Cloud.
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.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
string
""
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Cloud.
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.
This section provides a complete list of the Caching properties you can configure in the connection string for this provider.
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
bool
false
When AutoCache = true, the Cloud automatically maintains a cache of your table's data in the database of your choice.
When AutoCache = true, the Cloud caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:
Specifies the path to the cache when caching to a file.
string
"%APPDATA%\\CData\\RaiserEdgeNXT Data Provider"
The CacheLocation is a simple, file-based cache.
If left unspecified, the default location is "%APPDATA%\\CData\\RaiserEdgeNXT Data Provider" with %APPDATA% being set to the user's configuration directory:
The tolerance for stale data in the cache specified in seconds when using AutoCache .
int
600
The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The Cloud checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.
Use offline mode to get the data from the cache instead of the live source.
bool
false
When Offline = true, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.
This property determines whether or not to cache the table metadata to a file store.
bool
false
As you execute queries with this property set, table metadata in the BlackBaud Raiser's Edge NXT catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.
The Cloud automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| IncludeCustomFields | Set to true to retrieve custom fields values for Constituents, Actions, Opportunities, and Gifts. |
| MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
| 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. |
| Readonly | You can use this property to enforce read-only access to BlackBaud Raiser's Edge NXT from the provider. |
| RTK | The runtime key used for licensing. |
| 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. |
Set to true to retrieve custom fields values for Constituents, Actions, Opportunities, and Gifts.
bool
false
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.
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
int
-1
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
These hidden properties are used only in specific use cases.
string
""
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.
| 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. |
The number of results to return per page of data retrieved from BlackBaud Raiser's Edge NXT.
string
""
The pagesize will automatically be determined if you do not manually set it. It is generally not necessary to ever set this value.
This property indicates whether or not to include pseudo columns as columns to the table.
string
""
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, "*=*".
You can use this property to enforce read-only access to BlackBaud Raiser's Edge NXT from the provider.
bool
false
If this property is set to true, the Cloud will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.
The runtime key used for licensing.
string
""
The RTK property may be used to license a build.
The value in seconds until the timeout error is thrown, canceling the operation.
int
60
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 Cloud throws an exception.
A filepath pointing to the JSON configuration file containing your custom views.
string
""
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Cloud 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 Cloud.
This User Defined View configuration file is formatted as follows:
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"