Skip to Content

Financial Edge NXT Connection Details

Introduction

Connector Version

This documentation is based on version 21.0.8662 of the connector.

Get Started

Blackbaud Financial Edge NXT Version Support

The connector leverages the Blackbaud FinancialEdge NXT SKY API to enable bidirectional access to Blackbaud Financial Edge NXT.

Establish a Connection

Authenticate to Blackbaud Financial Edge NXT

Blackbaud Financial Edge NXT uses the OAuth authentication standard. Blackbaud Financial Edge NXT should be enabled on an authorization account to retrieve results.

You can connect after setting required connection properties for your user credentials and obtaining required access tokens using a tool such as Postman.

See Using OAuth Authentication for an authentication guide and details of the OAuth authentication flow.

Use OAuth Authentication

OAuth requires the use of access tokens obtained with Postman or a similar tool. OAuth authentication is supported as described in Connection under Configure OAuth Connections.

Embedded Credentials

Authenticate using the Embedded OAuth Credentials
Desktop Authentication with the Embedded OAuth App

You can connect without setting any connection properties for your user credentials. After setting the following connection properties, you are ready to connect:

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.
  • SubscriptionKey: Set this to your Subscription Key.

When you connect, the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process.

  1. Extracts the access token from the callback URL and authenticates requests.
  2. Obtains a new access token when the old one expires.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Custom Credentials

Desktop Authentication with your OAuth App

Follow the steps below to authenticate with the credentials for a custom OAuth app. See Creating a Custom OAuth App.

Get an OAuth Access Token

After setting the following, you are ready to connect:

  • OAuthClientId: Set this to the Client ID in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.
  • CallbackURL: Set this to the Redirect URL in your app settings.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • SubscriptionKey: Set this to your subscription key.

When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

  1. Extracts the access token from the callback URL and authenticates requests.
  2. Obtains a new access token when the old one expires.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Headless Machines

Use OAuth on a Headless Machine

To create Blackbaud Financial Edge NXT data sources on headless servers or other machines on which the connector cannot open a browser, you need to authenticate from another machine. Authentication is a two-step process.

  1. Instead of installing the connector on another machine, you can follow the steps below to obtain the OAuthVerifier value. Or, you can install the connector on another machine and transfer the OAuth authentication values, after you authenticate through the usual browser-based flow.
  2. You can then configure the connector to automatically refresh the access token from the headless machine.

You can follow the headless OAuth authentication flow using the connector's embedded OAuth credentials or using the OAuth credentials for your custom OAuth app.

Use the Credentials for a Custom OAuth App

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:

  • InitiateOAuth: Set this to OFF.
  • OAuthClientId: Set this to the App ID in your app settings.
  • OAuthClientSecret: Set this to the App Secret in your app settings.
  • SubscriptionKey: Set this to your subscription key.

You can then follow the steps below to authenticate from another machine and obtain the OAuthVerifier connection property.

  1. Call the GetOAuthAuthorizationURL stored procedure with the CallbackURL input parameter set to the exact Redirect URI you specified in your app settings.
  2. Open the returned URL in a browser. Log in and grant permissions to the connector. You are then redirected to the callback URL, which contains the verifier code.
  3. Save the value of the verifier code. You will set this in the OAuthVerifier connection property.

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

  • OAuthClientId: Set this to the consumer key in your app settings.
  • OAuthClientSecret: Set this to the consumer secret in your app settings.
  • OAuthVerifier: Set this to the verifier code.
  • OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified file.
  • InitiateOAuth: Set this to REFRESH.
  • SubscriptionKey: Set this to your subscription key.

Connect to Data

After the OAuth settings file is generated, set the following properties to connect to data:

  • OAuthSettingsLocation: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.
  • InitiateOAuth: Set this to REFRESH.
  • SubscriptionKey: Set this to your subscription key.

Transfer OAuth Settings

Follow the steps below to install the connector on another machine, authenticate, and then transfer the resulting OAuth values.

On a second machine, install the connector and connect with the following properties set:

  • OAuthSettingsLocation: Set this to a writable text file.
  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthClientId: Set this to the Client ID in your app settings.
  • OAuthClientSecret: Set this to the Client Secret in your app settings.
  • CallbackURL: Set this to the Callback URL in your app settings.
  • SubscriptionKey: Set this to your subscription key.

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:

  • InitiateOAuth: Set this to REFRESH.
  • OAuthSettingsLocation: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.
  • SubscriptionKey: Set this to your subscription key.

Create a Custom OAuth App

For more information about the first two steps, please see the getting started guide on Blackbaud here: https://developer.blackbaud.com/skyapi/docs/getting-started

Create an app to obtain the OAuth client credentials, the OAuthClientId and OAuthClientSecret. Follow these steps:

1. Set up a developer account

To do so, go to: https://developer.sky.blackbaud.com/signup/

2. Get a subscription key
  • Request a subscription to an API from the Products page (https://developer.sky.blackbaud.com/products/), select SKY API Standard Edition.
  • Select Subscribe. A confirmation screen appears.
  • To submit your request, select Confirm. You will get an email notification when your request is approved.
  • After it is approved, you can view the subscription key within your developer profile.
3. Register your app
  • From My Applications (https://developer.blackbaud.com/apps), select Register app.
  • Enter your app details.
  • Set redirect URI to https://oauth.cdata.com/oauth/.
  • Save, you can now get your app Client ID and Client Secret.
Create a Custom OAuth App: Desktop

Create an app to obtain the OAuth client credentials, the OAuthClientId and OAuthClientSecret. Follow these steps:

1. Set up a developer account
2. Get a subscription key
  • Request a subscription to an API from the Products page (https://developer.sky.blackbaud.com/products/), select SKY API Standard Edition.
  • Select Subscribe. A confirmation screen appears.
  • To submit your request, select Confirm. You will get an email notification when your request is approved.
  • After it is approved, you can view the subscription key within your developer profile.
3. Register your app
  • From My Applications (https://developer.blackbaud.com/apps), select Register app.
  • Enter your app details.
  • Set redirect URI to http://localhost:33333, or another port of your choice.
  • Save, you can now get your app Client ID and Client Secret.

Important Notes

Configuration Files and Their Paths

  • All references to adding configuration files and their paths refer to files and locations on the Harmony Agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the Blackbaud Financial Edge NXT connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

User Defined Views

The Jitterbit Connector for Blackbaud Financial Edge NXT allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

  • Create a JSON-formatted configuration file defining the views you want.
  • DDL statements.

Define Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Accounts 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"

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model

The Jitterbit Connector for Blackbaud Financial Edge NXT models Blackbaud Financial Edge NXT objects as relational views. A Blackbaud Financial Edge NXT object has relationships to other objects; in the views, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to Blackbaud Financial Edge NXT APIs.

Schemas for most database objects are defined in simple, text-based configuration files. For the views that may have custom fields, the columns are being listed dynamically. When the authenticated user changes custom fields for some objects, they will be reflected in the respective views.

The connector offloads as much of the SELECT statement processing as possible to the Blackbaud Financial Edge NXT APIs and then processes the rest of the query in memory. See SupportEnhancedSQL for more information on how the connector circumvents API limitations with in-memory client-side processing.

Views

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. To find out more about tables and stored procedures, please navigate to their corresponding entries in this help document.

Jitterbit Connector for Blackbaud Financial Edge NXT Views

Name Description
AccountCashflows Returns the list of available cashflow values
AccountCodes Returns the account codes.
AccountFundRequirements Returns the requirements for the account funds.
AccountFunds Returns the account funds.
Accounts Retrieve and query accounts.
AccountSegments Returns the specified account segment value.
AccountStructures Returns a list of account structures.
AccountWorkingCapitals Returns the list of available working capital values
BatchValidations Returns the results of batch validation.
BudgetAccounts Returns details for every fiscal period and account in scenario.
BudgetDetails Returns the specified budget details.
BudgetFiscalPeriods Returns details for every fiscal period in a budget scenario.
BudgetGrants Returns details for every fiscal period and grant in scenario.
BudgetLines Returns the specified budget lines.
BudgetProjects Returns details for every fiscal period and project in scenario.
Budgets Returns a top level overview of every budget scenario.
BudgetScenarios Returns details for every scenario ID.
CashManagementDistributionSetLineItemProjects The project distribution for the line items in the cash management distribution sets .
CashManagementDistributionSets Returns the list of cash management distribution sets and their line items.
Classes The list of classes
ClientNames Returns the client type names.
FiscalYears Returns the list of fiscal year details.
GrantCustomFields Returns the list of grant custom field options.
GrantStatuses Returns the list of grant statuses.
GrantTypes Returns the list of grant types.
JournalCodes Returns the list of all available journal codes.
JournalEntries Retrieve and query journal entries.
JournalEntryBatches Returns the list of journal entry batches.
LedgerSummaries Lists general ledger summaries for the specified fiscal year and criteria. Note that summary records only exist for closed, optimized fiscal years. If any activity occurs in a fiscal period that has not since been closed and optimized, it will not be included in the GL summary record(s).
MediaTypes Returns a list of media type options.
PeriodSummaries Once the summarization process is complete, this is how you get data returned.
PeriodSummariesProcessingInfo This endpoint reports on the current status of the summarize request, whether it is completed, still running, or failed.
ProjectAttachments Returns the list of attachments for the specified project.
ProjectContactMethods Address information of contacts for projects.
ProjectContacts The contacts for a project.
ProjectDepartments Returns the list of project departments.
ProjectDivisions Returns the list of project divisions.
ProjectLocations Returns the list of project locations.
Projects Retrieve and query projects.
ProjectStatuses Returns the list of project statuses.
ProjectTypes Returns the list of project types.
TransactionCodes Returns the list of all available transaction codes.
TransactionCodeValues Returns the list of all values for the specified transaction code.
TransactionDistributions Returns a list of transactions matching the search criteria
TransactionDistributionSets Returns the list of transaction distribution sets.

AccountCashflows

Returns the list of available cashflow values

Columns
Name Type References Description
CashflowId [KEY] Integer The cashflow identifier.
Description String The description for this cashflow.
Value String The value for this cashflow.

AccountCodes

Returns the account codes.

Columns
Name Type References Description
AccountCodeId [KEY] Integer The identifier for this account code.
IsControl Boolean If this account is a controlled account.
IsContra Boolean If this is a contra account.
Category String The category for this account code.
Description String The description for this account code.
Value Integer The value of this account code.
Class String The class of this account code.

AccountFundRequirements

Returns the requirements for the account funds.

Columns
Name Type References Description
FundId [KEY] Integer AccountFunds.FundId The identifier for this fund.
Name [KEY] String The name for this fund requirement.
Type String The type for this fund requirement.
PreserveDetailsDuringClosing Boolean If or not this fund requirements preserves details during closing.
RequireToBalance Boolean If or not this fund requirement is required to balance.
RequireOnAccountsSpecified String The require on accounts specified for this fund requirement.
Default String The default for this fund requirement.

AccountFunds

Returns the account funds.

Columns
Name Type References Description
FundId [KEY] Integer The identifier for this fund.
Value String The value for this fund.
Description String The description for this fund.
BeginningBalancesLocked Datetime The beginning balances locked date for this fund.
FundBalanceAccount String The fund balance account for this fund.

Accounts

Retrieve and query accounts.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • Id supports the '=' operator. This column is filtered servereport suite ID (RSID)e when it is the only specified filter in the criteria.
  • DateModified supports the following operators : >,>=.

For example, the following queries are processed server side:

SELECT * FROM Accounts WHERE AccountId = 123
SELECT * FROM Accounts WHERE DateModified >= '2010-01-01 10:10:10'
SELECT * FROM Accounts WHERE DateModified > '2010-01-01 10:10:10' 

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
AccountId [KEY] Integer The identifier for this account.
AccountNumber String The account number for this account.
Class String The class for this account.
Description String The description for this account.
DateModified Datetime The modified date of the account.
WorkingCapital String The working capital schedule for this account.
Cashflow String The cash flow for this account.
PreventPostingDate Datetime If, and the date after which, to prevent posting. Filling out this field will automatically set the prevent data entry field to 'true'.
ModifiedBy String The modifier of the account.
DefaultTransactionCodes String The default transaction codes on this account.
PreventDataEntry Boolean If to prevent data entry. If a date is given for prevent posting, this value is set to true.
DateAdded Datetime The created date of the account.
AddedBy String The creator of the account.
CustomFields String Custom field : The list of custom fields supported as distict columns.

AccountSegments

Returns the specified account segment value.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • SegmentId supports the '=' operator. This the only supported column.

For example, the following query is processed server side:

Select * FROM AccountSegments WHERE SegmentId = 123

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
SegmentId [KEY] Integer AccountStructures.SegmentId The identifier for this account segment.
Type [KEY] String The type for this account segment.
Value String The values for this account segment.
Description String The descriptions for this account segment.

AccountStructures

Returns a list of account structures.

Columns
Name Type References Description
SegmentId [KEY] Integer The identifier for this account segment.
Type String The type for this account segment.
Length Integer The length of this account segment.
Separator String The separator for this account segment.
Sequence Integer The sequence for this account segment.

AccountWorkingCapitals

Returns the list of available working capital values

Columns
Name Type References Description
WorkingCapitalId [KEY] Integer The working capital value identifier.
Description String The description for this working capital value.
Value String The value for this working capital value.

BatchValidations

Returns the results of batch validation.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • BatchId supports the '=' operator. This the only supported column.

For example, the following query is processed server side:

Select * FROM BatchValidations WHERE BatchId = 123

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
BatchId [KEY] String JournalEntryBatches.BatchId Indicates if the request was valid.
IsValid Boolean Indicates if the request was valid.
Errors String The list of errors received during validation.

BudgetAccounts

Returns details for every fiscal period and account in scenario.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • BudgetScenarioId, AccountNumber support the '=' operator. A blank search is not supported.

For example, the following queries are processed server side:

Select * FROM BudgetAccounts WHERE BudgetScenarioId = 123
Select * FROM BudgetAccounts WHERE BudgetScenarioId = 123 AND AccountNumber = 'abc' 

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
BudgetScenarioId [KEY] Integer Budgets.BudgetScenarioId The scenario ID for this budget.
AccountNumber [KEY] String Accounts.AccountNumber The account number for this period.
BudgetCategory String The budget category for this period.
FiscalYear String FiscalYears.Year The fiscal year for this period.
FiscalPeriodId Integer FiscalYears.FiscalPeriodId The fiscal period.
PeriodPercent Double The percent for this period.
PeriodAmount Decimal The amount for this period.
TotalAmount Decimal The total amount for this period.

BudgetDetails

Returns the specified budget details.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • BudgetScenarioId supports the '=' operator. This the only supported column.

For example, the following query is processed server side:

Select * FROM BudgetDetails WHERE BudgetScenarioId = 123

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
BudgetScenarioId [KEY] Integer Budgets.BudgetScenarioId The scenario ID for this budget.
ScenarioId String Budgets.ScenarioId The scenario ID for this budget scenario.
BudgetType String The budget type for this budget.
Status String The status of this budget.
Description String The description for this budget.
Locked Boolean The status of the lock for this budget.
StartFiscalYear String The start fiscal year for this budget.
EndFiscalYear String The end fiscal year for this budget.
StartFiscalPeriod Integer The start fiscal period for this budget.
EndFiscalPeriod Integer The end fiscal period for this budget.
TotalExpense Double The total expense for this budget.
TotalRevenue Double The total revenue for this budget.
DateAdded Datetime The date this budget was added.
AddedBy String The name of who added this budget.
DateModified Datetime The date this budget was modified.
ModifiedBy String The name of who modified this budget.

BudgetFiscalPeriods

Returns details for every fiscal period in a budget scenario.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • BudgetScenarioId supports the '=' operator. This the only supported column.

For example, the following query is processed server side:

Select * FROM BudgetFiscalPeriods WHERE BudgetScenarioId = 123

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
BudgetScenarioId [KEY] Integer Budgets.BudgetScenarioId The scenario ID for this budget.
Category [KEY] String The budget category for this period.
FiscalYear String FiscalYears.Year The fiscal year of this period.
FiscalPeriodId [KEY] Integer FiscalYears.FiscalPeriodId The fiscal period.
PeriodAmount Decimal The amount for this period.
TotalAmount Decimal The total amount for this period.

BudgetGrants

Returns details for every fiscal period and grant in scenario.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • BudgetScenarioId, Grant support the '=' operator. A blank search is not supported.

For example, the following queries are processed server side:

Select * FROM BudgetGrants WHERE BudgetScenarioId = 123
Select * FROM BudgetGrants WHERE BudgetScenarioId = 123 AND Grant = 'abc'

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
BudgetScenarioId [KEY] Integer Budgets.BudgetScenarioId The scenario ID for this budget.
Grant [KEY] String The grant name for this period.
AccountNumber [KEY] String Accounts.AccountNumber The account number for this period.
BudgetCategory String The budget category for this period.
FiscalYear String FiscalYears.Year The fiscal year for this period.
FiscalPeriodId Integer FiscalYears.FiscalPeriodId The fiscal period.
PeriodPercent Double The percent for this period.
PeriodAmount Decimal The amount for this period.
TotalAmount Decimal The total amount for this period.

BudgetLines

Returns the specified budget lines.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • BudgetScenarioId supports the '=' operator. This the only supported column.

For example, the following query is processed server side:

Select * FROM BudgetLines WHERE BudgetScenarioId = 123

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
BudgetScenarioId [KEY] Integer Budgets.BudgetScenarioId The scenario ID for this budget.
BudgetLineId [KEY] Integer The budget line ID.
AccountNumber String Accounts.AccountNumber The number for an account on this budget.
AccountDescription String The description for an account on this budget.
UiProjectId String The user defined project ID for this budget line.
ProjectDescription String The description for a project on this budget line.
Notes String The note for this budget line.
GrantDescription String The description of the {Grant} t-code.
Total Decimal The total amount for this budget line.
Periods String The period distributions for this budget line.

BudgetProjects

Returns details for every fiscal period and project in scenario.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • BudgetScenarioId, UiProjectId support the '=' operator. A blank search is not supported.

For example, the following queries are processed server side:

Select * FROM BudgetProjects WHERE BudgetScenarioId = 123
Select * FROM BudgetProjects WHERE BudgetScenarioId = 123 AND UiProjectId = 'abc' 

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
BudgetScenarioId [KEY] Integer Budgets.BudgetScenarioId The scenario ID for this budget.
UiProjectId [KEY] String The user-visible identifier of the project.
BudgetCategory String The budget category for this period.
FiscalYear String FiscalYears.Year The fiscal year for this period.
FiscalPeriodId Integer FiscalYears.FiscalPeriodId The fiscal period.
AccountNumber String Accounts.AccountNumber The account number for this period.
PeriodAmount Decimal The amount for this period.
TotalAmount Decimal The total amount for this period.
PeriodPercent Double The percent for this period.

Budgets

Returns a top level overview of every budget scenario.

Columns
Name Type References Description
BudgetScenarioId [KEY] Integer The identifier for this budget scenario.
ScenarioId String BudgetScenarios.ScenarioId The scenario ID of this budget scenario.
Status String The status of this budget scenario.
Description String The description for this budget scenario.
BudgetType String The type for this budget scenario.
StartDate Datetime The start date for this budget scenario.
EndDate Datetime The end date for this budget scenario.
StartFiscalYear String The start fiscal year for this budget scenario.
EndFiscalYear String The end fiscal year for this budget scenario.
Locked String The locked status of this budget scenario.

BudgetScenarios

Returns details for every scenario ID.

Columns
Name Type References Description
ScenarioId [KEY] Integer The database identifier for the scenario id.
Value String Short description.
Inactive Boolean If or not the scenario ID is inactive.
Description String Long description.

CashManagementDistributionSetLineItemProjects

The project distribution for the line items in the cash management distribution sets .

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • SetId supports the '=' operator. This the only supported column.

For example, the following query is processed server side:

Select * FROM CashManagementDistributionSetLineItemProjects WHERE SetId = 123

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
SetId [KEY] Integer CashManagementDistributionSets.SetId The identifier of the cash management distribution set.
ProjectId [KEY] Integer The identifier of the project for the line item.
LineNumber Integer The line number for the line item.
Percent Double The pecentage the distribution the line item represents.
AccountClass String The class of the account for the line item.

CashManagementDistributionSets

Returns the list of cash management distribution sets and their line items.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • SetId supports the '=' operator. This the only supported column.

For example, the following query is processed server side:

Select * FROM CashManagementDistributionSets WHERE SetId = 123

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
SetId [KEY] Integer The identifier of the cash management distribution set.
Name String The name of the cash management distribution set.
LineItemPercent Double The percentage of the total distribution set the line item represents.
LineItemRowNumber Integer The row number for the line item.
LineItemAccountId String The identifier of the account for the line item.

Classes

The list of classes

Columns
Name Type References Description
ClassId [KEY] Integer The class identifier.
Value String The value for this class.
Description String The description for this class.

ClientNames

Returns the client type names.

Columns
Name Type References Description
RecordType String The name of the record type.
ClientRecordTypeName String The client's name for this record type.

FiscalYears

Returns the list of fiscal year details.

Columns
Name Type References Description
FiscalYearId [KEY] Integer The identifier for this fiscal year.
StartDate Datetime The start date for this fiscal year.
Status String The status of this fiscal year.
Year String The year of this fiscal year.
Description String The description of this fiscal year.
EndDate Datetime The end date for this fiscal year.
FiscalPeriodId [KEY] Integer The identifier for this fiscal period.
FiscalPeriodStartDate Datetime The start date for this fiscal period.
FiscalPeriodEndDate Datetime The end date for this fiscal period.
FiscalPeriodSequence Integer The sequence of this fiscal period.
FiscalPeriodClosed Boolean If or not this fiscal period is closed.

GrantCustomFields

Returns the list of grant custom field options.

Columns
Name Type References Description
CustomFieldId [KEY] Integer The identifier for this custom field.
Name String The name for this custom field.
Type String The type (boolean, table, etc) for this custom field.
IsRequired Boolean If this custom field is required.
TableValues String List of table values. Only applicable if type = 'Table'.

GrantStatuses

Returns the list of grant statuses.

Columns
Name Type References Description
Id [KEY] Integer The identifier for this lookup value.
Value String The value for this lookup value.
Description String The description for this lookup value.

GrantTypes

Returns the list of grant types.

Columns
Name Type References Description
Id [KEY] Integer The identifier for this lookup value.
Value String The value for this lookup value.
Description String The description for this lookup value.

JournalCodes

Returns the list of all available journal codes.

Columns
Name Type References Description
JournalCodeId [KEY] Integer The identifier of the journal.
Code String The abbreviated code of the journal.
Journal String The full journal name of the journal.

JournalEntries

Retrieve and query journal entries.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • BatchId supports the '=' operator. This the only supported column.

For example, the following query is processed server side:

Select * FROM JournalEntries WHERE BatchId = 123

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
JournalEntryId [KEY] Integer The journal entry identifier.
BatchId Integer The batch identifier.
AccountNumber String The journal entry account number.
TypeCode String The journal entry transaction type (debit or credit).
Journal String The full name of the journal.
LineNumber Integer The journal entry line number.
Reference String The journal entry reference.
PostDate Datetime The journal entry post date, in ISO 8601 format: 2016-03-14.
Amount Double The journal entry amount.
Notes String The journal entry notes.
Encumbrance String The journal entry encumbrance type.
Distributions String The journal entry distributions.
CustomFields String Custom field : The list of custom fields supported as distict columns.

JournalEntryBatches

Returns the list of journal entry batches.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • BatchId supports the '=' operator. This column is filtered servereport suite ID (RSID)e when it is the only specified filter in the criteria.

For example, the following query is processed server side:

Select * FROM JournalEntryBatches WHERE BatchId = 123

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
BatchId [KEY] Integer The batch identifier.
UiBatchId String The batch user-visible identifier.
Description String The batch description.
BatchStatus String The batch status.
CreateInterfundSets Boolean Indicates if or not the batch should create interfund entries when posted.
CreateBankAccountAdjustments Boolean Indicates if or not the batch should create bank account admustments when posted.
DateAdded Datetime The created date of the batch.
AddedBy String The creator of the batch.
DateModified Datetime The modified date of the batch.
ModifiedBy String The modifier of the batch.

LedgerSummaries

Lists general ledger summaries for the specified fiscal year and criteria. Note that summary records only exist for closed, optimized fiscal years. If any activity occurs in a fiscal period that has not since been closed and optimized, it will not be included in the GL summary record(s).

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • FiscalYearId, AccountNumber and UiProjectId support the '=' operator. A blank search is not supported.

For example, the following query is processed server side:

SELECT * FROM LedgerSummaries WHERE FiscalYearId = 1 AND  AccountNumber = 'abc' AND UiProjectId = 'def'

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
FiscalYearId String FiscalYears.FiscalYearId The fiscal year identifier.
FiscalYear String FiscalYears.Year The summarized fiscal year.
AccountNumber String Accounts.AccountNumber The account number of summarized transactions.
PeriodStartDate Datetime The start date of the summarized period.
FiscalPeriod String The summarized fiscal period.
EncumberedBeginningBalance Double The encumbered transaction balance at the beginning of the summarized period.
EncumberedCredit Double The sum of encumbered transaction credits int he summarized period.
UiProjectId String The project identifier of summarized transactions.
PeriodEndDate Datetime The end date of the summarized period.
TransactionCodes String The transaction code values of summarized transactions.
Credit Double The sum of transaction credits int he summarized period.
Debit Double The sum of transaction debits int he summarized period.
EncumberedDebit Double The sum of encumbered transaction debits int he summarized period.
BeginningBalance Double The total transaction balance at the beginning of the summarized period.

MediaTypes

Returns a list of media type options.

Columns
Name Type References Description
TypeId [KEY] Integer The identifier for this media type.
Value String The value of the media type.
Description String The description of the media type.

PeriodSummaries

Once the summarization process is complete, this is how you get data returned.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • FiscalYear, FiscalPeriod, AccountNumber and UiProjectId support the '=' operator. A blank search is not supported.

For example, the following query is processed server side:

SELECT * FROM PeriodSummaries WHERE FiscalYear = 'year' AND FiscalPeriod = 'period' AND  AccountNumber = 'abc' AND UiProjectId = 'def'

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
FiscalYear String FiscalYears.Year The summarized fiscal year.
FiscalPeriod String FiscalYears.FiscalPeriod The summarized fiscal period.
AccountNumber String Accounts.AccountNumber The account number of summarized transactions.
UiProjectId String The project identifier of summarized transactions.
PeriodStartDate Datetime The start date of the summarized period.
PeriodEndDate Datetime The end date of the summarized period.
TransactionCodes String The transaction code values of summarized transactions.
BeginningBalance Double The total transaction balance at the beginning of the summarized period.
Debit Double The sum of transaction debits int he summarized period.
Credit Double The sum of transaction credits int he summarized period.
EncumberedBeginningBalance Double The encumbered transaction balance at the beginning of the summarized period.
EncumberedCredit Double The sum of encumbered transaction credits int he summarized period.
EncumberedDebit Double The sum of encumbered transaction debits int he summarized period.

PeriodSummariesProcessingInfo

This endpoint reports on the current status of the summarize request, whether it is completed, still running, or failed.

Columns
Name Type References Description
ProcessId [KEY] String The process identifier for the summary process
FiscalPeriodId Integer FiscalYears.FiscalPeriodId The fiscal period identifier for the sumary process
Status String The status of the summary process
StatusMessage String The status message of the summary proces

ProjectAttachments

Returns the list of attachments for the specified project.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • ProjectId supports the '=' operator. This column is required to fetch the project attachments.

For example, the following queries are processed server side:

SELECT * FROM ProjectAttachments WHERE ProjectId = 1

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
Id Integer The attachment identifier
ProjectId Integer The identifier for the project to retrieve the attachments for
Name String The name of this attachment
Url String The URL of this attachment
Type String The attachment type. Available values are Link and Physical
MediaType String User-defined category of this attachment
DateAttached Datetime The date the attachment was added

ProjectContactMethods

Address information of contacts for projects.

Columns
Name Type References Description
ProjectId [KEY] Integer ProjectContacts.ProjectId The identifier for this project.
ContactId [KEY] Integer ProjectContacts.ContactId The identifier for this contact.
ContactMethodId [KEY] Integer The address contact method identifier.
ContactType String The type of contact (email, phone, etc).
ContactInfo String The contact information (email address, phone number, etc) for this method.

ProjectContacts

The contacts for a project.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • ProjectId supports the '=' operator. This column is the only supported filter.

For example, the following query is processed server side:

SELECT * FROM ProjectContacts WHERE ProjectId = 1

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
ProjectId [KEY] Integer Projects.ProjectId The identifier for this project.
ContactId [KEY] Integer The identifier for this contact.
Description String The description for this address.
Country String The country for the address.
City String The city for the address.
County String The county for this address.
State String The state or province (or suburb in NZ) for the address.
Postal String Refers to the Postal Code or ZIP of the address.
Title String The title for the primary contact.
FirstName String The first name of the primary contact.
MiddleName String The middle initial or name of the primary contact.
LastName String The last name of the primary contact.
Suffix String The suffix of the primary contact.
Position String The position of the primary contact.

ProjectDepartments

Returns the list of project departments.

Columns
Name Type References Description
Id [KEY] Integer The identifier for this lookup value.
Value String The value for this lookup value.
Description String The description for this lookup value.

ProjectDivisions

Returns the list of project divisions.

Columns
Name Type References Description
Id [KEY] Integer The identifier for this lookup value.
Value String The value for this lookup value.
Description String The description for this lookup value.

ProjectLocations

Returns the list of project locations.

Columns
Name Type References Description
Id [KEY] Integer The identifier for this lookup value.
Value String The value for this lookup value.
Description String The description for this lookup value.

Projects

Retrieve and query projects.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • ProjectId supports the '=' operator. This column is filtered servereport suite ID (RSID)e when it is the only specified filter in the criteria.
  • Location,Type,Division and Department support the '=' operator. A blank search is not supported.

For example, the following queries are processed server side:

SELECT * FROM Projects WHERE ProjectId = 1
SELECT * FROM Projects WHERE Location = 'abc' AND Type = 'def' AND Division = 'abc' AND Department = 'abc'  

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
ProjectId [KEY] Integer The project database identifier.
UiProjectId String The project user-visible identifier.
Description String The project description.
Location String The project location.
EndDate Datetime The project end date, in ISO 8601 format: 2016-03-14.
StartDate Datetime The project start date, in ISO 8601 format: 2016-03-14.
Type String The project type.
AddedBy String The creator of the project.
PostingDate Datetime The date after which to prevent posting, if applicable.
PreventPostingAfter Boolean If preventing data entry, if to prevent posting after a certain date.
Division String The project division.
PreventDataEntry Boolean If to prevent data entry for this project.
ModifiedBy String The modifier of the project.
Status String The project status.
Department String The project department.
AccountRestrictions String The account allowances or restrictions for this project.
DateAdded Datetime The created date of the project.
DateModified Datetime The modified date of the project.
CustomFields String Custom field : The list of custom fields supported as distict columns.

ProjectStatuses

Returns the list of project statuses.

Columns
Name Type References Description
Id [KEY] Integer The identifier for this lookup value.
Value String The value for this lookup value.
Description String The description for this lookup value.

ProjectTypes

Returns the list of project types.

Columns
Name Type References Description
Id [KEY] Integer The identifier for this lookup value.
Value String The value for this lookup value.
Description String The description for this lookup value.

TransactionCodes

Returns the list of all available transaction codes.

Columns
Name Type References Description
TransactionCodeId [KEY] Integer The transaction code identifier.
Name String The transaction code name.
UsedForGrants Boolean If the transaction code is used for grants.
Description String The transaction code description.

TransactionCodeValues

Returns the list of all values for the specified transaction code.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • TransactionCodeId supports the '=' operator. This column is the only supported filter.

For example, the following query is processed server side:

SELECT * FROM TransactionCodeValues WHERE TransactionCodeId = 1

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
TransactionCodeId Integer TransactionCodes.TransactionCodeId The transaction code identifier.
Id [KEY] Integer The transaction code value id.
Name String The transaction code name.
Value String The transaction code value.

TransactionDistributions

Returns a list of transactions matching the search criteria

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • BatchId, AccountNumber , UiProjectId , TypeCode , Encumbrance, Journal, and PostStatus support the '=' operator. A blank search is not supported.
  • PostDate supports the following operators : <,<=,=,>=,>.
  • DateModified supports the following operators : >,>=.

For example, the following queries are processed server side:

SELECT * FROM TransactionDistributions WHERE BatchId = 123 AND PostDate < '2010-01-01 10:10:10'
SELECT * FROM TransactionDistributions WHERE AccountNumber = 'abc' AND Journal = 'def' AND PostDate <= '2010-01-01 10:10:10'
SELECT * FROM TransactionDistributions WHERE UiProjectId = 'abc' AND PostStatus = 'def' AND PostDate = '2010-01-01 10:10:10'
SELECT * FROM TransactionDistributions WHERE TypeCode = 'abc' AND DateModified > '2010-01-01 08:10:10' AND PostDate >= '2010-01-01 10:10:10'
SELECT * FROM TransactionDistributions WHERE Encumbrance = 'abc' AND PostDate > '2010-01-01 10:10:10'

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
DistributionId [KEY] Integer The distribution identifier.
TransactionId [KEY] Integer The transaction identifier.
TransactionAmount Double The transaction amount.
BatchId Integer JournalEntryBatches.BatchId The batch identifier
DistributionAmount Double The distribution amount.
AccountNumber String Accounts.AccountNumber The account number.
AccountClass String The account class.
UiProjectId String The project user-visible identifier.
PostDate Datetime The transaction post date.
TypeCode String The transaction type (debit or credit). The allowed values are Debit, Credit.
Reference String The transaction reference.
Encumbrance String The transaction encumbrance type.
Journal String The full name of the journal.
TransactionCodeValues String The distribution transaction codes.
DateAdded Datetime The created date of the transaction distribution.
AddedBy String The creator of the transaction distribution.
DateModified Datetime The modified date of the transaction distribution.
ModifiedBy String The modifier of the transaction distribution.
PostStatus String The post status of the transaction distribution.

TransactionDistributionSets

Returns the list of transaction distribution sets.

The connector will use the Blackbaud Financial Edge NXT API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • SetId supports the '=' operator. This column is the only supported filter.

For example, the following query is processed server side:

SELECT * FROM TransactionDistributionSets WHERE SetId = 1

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will result in unfiltered data being pushed.

Columns
Name Type References Description
SetId [KEY] Integer The identifier for the transaction distribution set.
Name String The name of the transaction distribution set.
LineNumber [KEY] Integer The line item number.
LineItemPercent Double The percentage of the total distribution set the line item represents.
LineItemProjectId Integer The identifier of the project for the line item.
LineItemAccountClass String The class of the account for the line item.
LineItemTransactionCodeValues String The transaction code values for the line item.

Stored Procedures

Stored procedures are available to complement the data available from the Data Model. It may be necessary to update data available from a view using a stored procedure because the data does not provide for direct, table-like, two-way updates. In these situations, the retrieval of the data is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures take a list of parameters and return back a dataset that contains the collection of tuples that constitute the response.

Jitterbit Connector for Blackbaud Financial Edge NXT Stored Procedures

Name Description
GetOAuthAccessToken Gets an authentication token from Blackbaud Financial Edge NXT.
GetOAuthAuthorizationURL Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the auth token from this URL.
RefreshOAuthAccessToken Refreshes the OAuth access token used for authentication with Blackbaud Financial Edge NXT.

GetOAuthAccessToken

Gets an authentication token from Blackbaud Financial Edge NXT.

Input
Name Type Required Description
AuthMode String False The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app. The allowed values are APP, WEB. The default value is APP.
CallbackURL String False Determines where the response is sent. The value of this parameter must exactly match one of the values registered in the settings for the app (including the HTTP or HTTPS schemes, capitalization, and trailing '/').
Verifier String False The verifier returned from Blackbaud Financial Edge NXT 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 in GetOAuthAuthorizationURL.
State String False This field indicates any state that 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 Blackbaud Financial Edge NXT authorization server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
Result Set Columns
Name Type Description
OAuthAccessToken String The access token used for communication with Blackbaud Financial Edge NXT.
OAuthRefreshToken String The refresh token used for RefreshOAuthAccessToken procedure.

GetOAuthAuthorizationURL

Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the auth token from this URL.

Input
Name Type Required Description
CallbackUrl String False The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the Blackbaud Financial Edge NXT app settings.
State String False This field indicates any state that 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 Blackbaud authorization server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
Result Set Columns
Name Type Description
URL String The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app.

RefreshOAuthAccessToken

Refreshes the OAuth access token used for authentication with Blackbaud Financial Edge NXT.

Input
Name Type Required Description
OAuthRefreshToken String True The refresh token returned from the original authorization code exchange.
Result Set Columns
Name Type Description
OAuthAccessToken String The authentication token returned from Blackbaud Financial Edge NXT. This can be used in subsequent calls to other operations for this particular service.
OAuthRefreshToken String A token that may be used to obtain a new access token.
ExpiresIn String The remaining lifetime on the access token.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Blackbaud Financial Edge NXT:

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

  • sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs
Columns
Name Type Description
CatalogName String The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas
Columns
Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables
Columns
Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Accounts table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Accounts'
Columns
Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures
Columns
Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SelectEntries stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2
Columns
Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName String The name of the data type.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Accounts table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Accounts'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns
Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:financialedgenxt:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''
Columns
Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Collaborative Query Processing

When working with data sources that do not support SQL-92, you can query the sys_sqlinfo view to determine the query capabilities of the underlying APIs, expressed in SQL syntax. The connector offloads as much of the SELECT statement processing as possible to the server and then processes the rest of the query in memory.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the connector 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
STRING_FUNCTIONS Supported string functions. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Supported numeric functions. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Supported date/time functions. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION Indicates if the provider supports transactions such as commit and rollback. YES, NO
DIALECT Indicates the SQL dialect to use.
KEY_PROPERTIES Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS Indicates if multiple schemas may exist for the provider. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indicates if multiple catalogs may exist for the provider. YES, NO
DATASYNCVERSION The Data Sync version needed to access this driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY The Data Sync category of this driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Whether enhanced SQL functionality beyond what is offered by the API is supported. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Whether batch operations are supported. YES, NO
SQL_CAP All supported SQL capabilities for this driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. YES, NO
PSEUDO_COLUMNS A string array indicating the available pseudo columns.
MERGE_ALWAYS If the value is true, The Merge Mode is forcibly executed in Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID Indicates whether the CheckCache statement should be done against the parent key column. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns
Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity
Columns
Name Type Description
Id String The database-generated ID returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

Advanced Configurations Properties

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

OAuth

Property Description
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientId The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken The access token for connecting using OAuth.
SubscriptionKey Subscription key which provides access to the API. Found in your 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.

SSL

Property Description
SSLServerCert The certificate to be accepted from the server when connecting using TLS/SSL.

Schema

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.

Miscellaneous

Property Description
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 Financial Edge NXT.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.

OAuth

This section provides a complete list of OAuth properties you can configure.

Property Description
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientId The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken The access token for connecting using OAuth.
SubscriptionKey Subscription key which provides access to the API. Found in your 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.

InitiateOAuth

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values

OFF, GETANDREFRESH, REFRESH

Data Type

string

Default Value

OFF

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId

The client ID assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken

The access token for connecting using OAuth.

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.

Data Type

string

Default Value

%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.

Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

The default location is "%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

  • Windows: "register://%DSN"
  • Unix: "%AppData%..."

where DSN is the name of the current DSN used in the open connection.

The following table lists the value of %APPDATA% by OS:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Linux ~/.config

SubscriptionKey

Subscription key which provides access to the API. Found in your Profile.

Data Type

string

Default Value

""

Remarks

Subscription key which provides access to the API. Found in your Profile.

CallbackURL

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

Data Type

string

Default Value

""

Remarks

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

OAuthVerifier

The verifier code returned from the OAuth authorization URL.

Data Type

string

Default Value

""

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken

The OAuth refresh token for the corresponding OAuth access token.

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn

The lifetime in seconds of the OAuth AccessToken.

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

SSL

This section provides a complete list of SSL properties you can configure.

Property Description
SSLServerCert The certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate C:\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type

string

Default Value

%APPDATA%\FinancialEdgeNXT Data Provider\Schema

Remarks

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\FinancialEdgeNXT Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

Property Description
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 Financial Edge NXT.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.

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.

Data Type

int

Default Value

-1

Remarks

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.

Data Type

string

Default Value

""

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting
Property Description
DefaultColumnSize Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename Records the underlying socket data transfer to the specified file.

PageSize

The number of results to return per page of data retrieved from Blackbaud Financial Edge NXT.

Data Type

string

Default Value

""

Remarks

The pagesize will automatically be determined if you do not manually set it. It is generally not necessary to ever set this value.

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.