Blackbaud Raisers Edge NXT Connector for CData Sync

Build 22.0.8479
  • Blackbaud Raisers Edge NXT
    • 接続の確立
    • 高度な機能
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • ビュー
        • ActionAttachments
        • ActionCustomFields
        • Actions
        • Addresses
        • Aliases
        • AppealAttachments
        • CampaignAttachments
        • Campaigns
        • ConsentCategories
        • ConsentChannelCategories
        • ConsentChannels
        • ConsentSources
        • ConstituentAppeals
        • ConstituentAttachments
        • ConstituentCodes
        • ConstituentConsents
        • ConstituentFundraiserAssignments
        • Constituents
        • ConstituentsCustomFields
        • ConstituentSolicitCodes
        • Countries
        • Educations
        • Emails
        • EventCategories
        • EventFees
        • EventParticipantGuests
        • EventParticipantMemberships
        • EventParticipantOptions
        • EventParticipants
        • Events
        • FundAttachments
        • FundraiserAssignments
        • FundraiserGoals
        • FundraisingAppeals
        • Funds
        • GiftAcknowledgements
        • GiftAttachments
        • GiftBatches
        • GiftPayments
        • GiftReceipts
        • Gifts
        • GiftsCustomFields
        • GiftSoftCredits
        • GiftSplits
        • Giving
        • GivingAppeals
        • GivingCampaigns
        • GivingFunds
        • LifetimeGiving
        • Lists
        • Members
        • Memberships
        • Notes
        • OnlinePresences
        • Opportunities
        • OpportunitiesCustomFields
        • OpportunityAttachments
        • Packages
        • ParticipantFeePayments
        • ParticipantFees
        • ParticipantLevels
        • ParticipantOptions
        • Phones
        • RatingCategories
        • Ratings
        • RatingSources
        • Relationships
    • 接続文字列オプション
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • SubscriptionKey
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • IncludeCustomFields
        • MaxRows
        • Other
        • PageSize
        • PseudoColumns
        • Timeout
        • UserDefinedViews

Blackbaud Raisers Edge NXT Connector for CData Sync

概要

CData Sync App は、Blackbaud Raisers Edge NXT データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。

BlackBaud Raiser's Edge NXT コネクタはCData Sync アプリケーションから使用可能で、BlackBaud Raiser's Edge NXT からデータを取得して、サポートされている任意の同期先に移動できます。

Blackbaud Raisers Edge NXT Connector for CData Sync

接続の確立

Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、BlackBaud Raiser's Edge NXT への接続を作成します。BlackBaud Raiser's Edge NXT アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからBlackBaud Raiser's Edge NXT コネクタをダウンロードおよびインストールします。

必須プロパティは[設定]タブにリストされています。[Advanced]タブには、通常は必要ない接続プロパティが表示されます。

BlackBaud Raiser's Edge NXT への接続

接続を確立する前に、BlackBaud Raiser's Edge NXT プロファイルにあるSubscriptionKey を指定します。

BlackBaud Raiser's Edge NXT への認証

BlackBaud Raiser's Edge NXT はOAuth 認証標準を利用しています。埋め込みクレデンシャル を使用すると、接続プロパティを設定せずにBlackBaud Raiser's Edge NXT に接続できます。

あるいは、カスタムOAuth アプリの作成 で認証して、OAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得することもできます。

認証方法については、OAuth 認証の使用 を参照してください。

Blackbaud Raisers Edge NXT Connector for CData Sync

高度な機能

このセクションでは、BlackBaud Raiser's Edge NXT Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、BlackBaud Raiser's Edge NXT にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理 を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。

Blackbaud Raisers Edge NXT Connector for CData Sync

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

Blackbaud Raisers Edge NXT Connector for CData Sync

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

次のプロパティを設定します。

  • プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
  • 接続をトンネルするには、FirewallType をTUNNEL に設定します。
  • 認証するには、FirewallUser とFirewallPassword を設定します。
  • SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

Blackbaud Raisers Edge NXT Connector for CData Sync

データモデル

概要

このセクションでは、利用可能なAPI オブジェクトを示し、BlackBaud Raiser's Edge NXT API へのSQL の実行について詳しく説明します。

主要機能

  • Sync App はドキュメント、フォルダ、およびグループなどのBlackBaud Raiser's Edge NXT エンティティをリレーショナルビューとしてモデル化し、SQL を記述してBlackBaud Raiser's Edge NXT データをクエリできるようにします。
  • ストアドプロシージャを使用するとBlackBaud Raiser's Edge NXT の操作を実行できます。
  • これらのオブジェクトへのライブ接続により、Sync App を使用するとBlackBaud Raiser's Edge NXT アカウントへのあらゆる変更が即座に反映されます。

ビュー

ビュー では、利用可能なビューを説明します。ビューは、Actions、Emails、Events などを静的にモデル化するように定義されています。

ストアドプロシージャ

ストアドプロシージャ は、BlackBaud Raiser's Edge NXT のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、BlackBaud Raiser's Edge NXT の操作を実行できます。

Blackbaud Raisers Edge NXT Connector for CData Sync

ビュー

ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます(その機能がデータソースに適用できる場合)。

ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。

ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。

Blackbaud Raisers Edge NXT Connector for CData Sync ビュー

Name Description
ActionAttachments Retrieves a list of attachments for an action.
ActionCustomFields Retrieves custom fields for an action
Actions Retrieves a list of actions for all constituents and for specified constituent and details of the specified action.
Addresses Addresses store information about constituent residences and other addresses along with information about where or whether to send mail
Aliases Retrieves a list of aliases for a constituent
AppealAttachments Returns a list of attachments for an appeal.
CampaignAttachments Returns a list of attachments for a campaign.
Campaigns Campaigns are your organization's overall fundraising efforts or initiatives, such as operating expenses, new buildings, and endowments
ConsentCategories Returns a list of consent categories.
ConsentChannelCategories Returns a list of valid consent channel category combinations.
ConsentChannels Represents the consent channel entity
ConsentSources Represents the consent source entity
ConstituentAppeals Returns a list of appeals for a constituent.
ConstituentAttachments Returns a list of attachments for a constituent.
ConstituentCodes Constituent codes define the high-level affiliations between constituents and your organization - such as Board member, Vendor, and Volunteer - to provide context for why constituents are in the database
ConstituentConsents Returns a list of constituent consent records.
ConstituentFundraiserAssignments Returns a list of fundraiser assignments for a constituent.
Constituents Returns a paginated list of constituents
ConstituentsCustomFields Retrieves custom fields for all constituents
ConstituentSolicitCodes Returns a list of solicit codes for the specified constituent.
Countries Returns the list of available countries.
Educations Returns a list of educations for all constituent or a specified constituent
Emails Returns a list of email addresses of all constituents or a specified constituent
EventCategories Returns a list of active event categories.
EventFees Returns a list of fees for an event.
EventParticipantGuests The participant's basic summary information
EventParticipantMemberships The individual's membership category
EventParticipantOptions Returns the participant options for an event.
EventParticipants Returns a list of participants for an event.
Events Returns a list of events
FundAttachments Returns a list of attachments for a fund.
FundraiserAssignments Returns a list of assignments for a fundraiser.
FundraiserGoals Returns a list of goals for a fundraiser
FundraisingAppeals Returns a list of fundraising appeals.
Funds Returns a list of funds.
GiftAcknowledgements Returns a list of acknowledgements for a gift
GiftAttachments Returns a list of attachments for a gift.
GiftBatches Returns a list of gift batches.
GiftPayments Returns payments for a gift.
GiftReceipts Returns receipts for a gift.
Gifts Returns a paginated list of gifts
GiftsCustomFields Retrieves custom fields for all gifts
GiftSoftCredits Returns soft credits for a gift.
GiftSplits Returns the splits for a gift.
Giving Returns the first, latest or greatest gift recorded for a constituent.
GivingAppeals Returns the giving appeals summary for the constituent
GivingCampaigns Returns the giving campaigns summary for the constituent
GivingFunds Returns the giving funds summary for the constituent
LifetimeGiving Returns the lifetime giving information for a constituent.
Lists Returns a list of lists for the given list type
Members Returns the list of members.
Memberships Returns a list of memberships.
Notes Returns a list of notes that tracks helpful or important details such as specific interests and special instructions for donations
OnlinePresences Returns a paginated list of online presences that store a constituent's social media accounts, websites.
Opportunities Retrieves a list of opportunities
OpportunitiesCustomFields Retrieves custom fields for an opportunity
OpportunityAttachments Returns a list of attachments for an opportunity
Packages Returns a list of packages that contains content and other items for the appeals that organizations use to solicit gifts
ParticipantFeePayments Returns the fee payments for a participant.
ParticipantFees Returns a list of fees for a participant.
ParticipantLevels Returns a list of participation levels for all events.
ParticipantOptions Returns the participant options for a participant.
Phones Returns a list of phones for all constituents or a specific constituent
RatingCategories Returns a list of all available rating categories.
Ratings Returns a list of ratings for a constituent.
RatingSources Returns a list of all available rating sources.
Relationships Returns a list of relationships between constituents and other individuals and organizations such as family, friends, and employers

Blackbaud Raisers Edge NXT Connector for CData Sync

ActionAttachments

Retrieves a list of attachments for an action.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: ActionId is required in order to query ActionAttachments.

  • ActionId supports the '=' operator.
For example:
	SELECT * FROM ActionAttachments WHERE ActionId = '335'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the attachment.
ActionId String

Actions.Id

The immutable system record ID of the action this attachment is associated to.
ContentType String The content type. For physical attachments only.
Date Datetime The date of the attachment.
FileId String The identifier of the file.
FileName String The file name.
FileSize Integer The file size in bytes.
Name String The name of the attachment.
ParentId String The parent object's immutable system record ID.
Tags String The parent object's immutable system record ID.
ThumbnailId String The identifier of the thumbnail.
ThumbnailUrl String The URL for a thumbnail.
Type String The attachment type.
Url String The URL for the attachment.

Blackbaud Raisers Edge NXT Connector for CData Sync

ActionCustomFields

Retrieves custom fields for an action

Columns

Name Type References Description
Id String The immutable system record ID of the custom field.
ActionId String The parent object's immutable system record ID.
Value String The value of the custom field.
Date Datetime The date on the custom field.
Category String The category on the custom field.
Commment String The date when the custom field was created.
Type String The type of data that the custom field represents.

Blackbaud Raisers Edge NXT Connector for CData Sync

Actions

Retrieves a list of actions for all constituents and for specified constituent and details of the specified action.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=' operator.
  • ComputedStatus supports the '=' operator.
  • ConstituentId supports the '=' operator.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
  • StatusCode supports the '=,in' operators.
For example:
	
	SELECT * FROM Actions WHERE ConstituentId = '280'
	
	SELECT * FROM Actions WHERE ComputedStatus = 'Completed'
	
	SELECT * FROM Actions WHERE DateAdded >= '2010-06-01 14:03:35'
	

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the action.
Category String The channel or intent of the constituent interaction.
Completed Boolean Indicates whether the action is complete.
CompletedDate Datetime The date when the action was completed.
ComputedStatus String The computed action status.

使用できる値は次のとおりです。Open, Completed, PastDue

ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with the action.
Date Date The action date.
DateAdded Datetime The date when the action was created.
DateModified Datetime The date when the action was last modified.
Description String The detailed explanation that elaborates on the action summary.
Direction String The direction of the action.
EndTime String The end time of the action.
Fundraisers String The set of immutable constituent system record IDs for the fundraisers associated with the action.
Location String The location of the action.
OpportunityId String

Opportunities.Id

The immutable system record ID of the opportunity associated with the action.
Outcome String The outcome of the action. Available values are Successful and Unsuccessful.
Priority String The priority of the action.
StartTime String The start time of the action.
Status String The action status.
StatusCode String The action status code. This property is only returned when the system is configured to use custom action statuses.

使用できる値は次のとおりです。Closed, Completed, Pending, Not Completed, Open, Sent, Continuous

Summary String The short description of the action that appears at the top of the record.
Type String Additional description of the action to complement the category.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
ListId String Defines a list identifier used to filter the set of actions to those included in the specified list. If this value is set, other specified filters will be ignored.

Blackbaud Raisers Edge NXT Connector for CData Sync

Addresses

Addresses store information about constituent residences and other addresses along with information about where or whether to send mail

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=' operator.
  • ConstituentId supports the '=' operator.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
  • IncludeInactive supports the '=' operator.
For example:
	
	SELECT * FROM Addresses WHERE ConstituentId = '280'
	
	SELECT * FROM Addresses WHERE DateModified >= '2010-06-01 14:03:35'
	
	SELECT * FROM Addresses WHERE IncludeInactive = true

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the address.
AddressLines String The address lines.
City String The city of the address.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with the address.
Country String The country of the address.
County String The county of the address.
DateAdded Datetime The date when the address was created.
DateModified Datetime The date when the address was last modified.
DoNotMail Boolean Indicates whether the constituent requests not to be contacted at this address.
End Datetime The date when the constituent ceased to reside at this address.
FormattedAddress String The date when the constituent ceased to reside at this address.
Inactive Boolean This computed field indicates that the address is active if the current date is before any end date.
PostalCode String The postal code of the address.
Preferred Boolean Indicates whether this is the constituent's preferred address.
SeasonalEndD Integer The day of the year ceases to reside at this address.
SeasonalEndM Integer The month of the year ceases to reside at this address.
SeasonalEndY Integer The year ceases to reside at this address.
SeasonalStartD Integer The day of year that the constituent begins residing at this address.
SeasonalStartM Integer The month of year that the constituent begins residing at this address.
SeasonalStartY Integer The year that the constituent begins residing at this address.
Start Datetime The date when the constituent began residing at this address.
State String The state of the address.
Suburb String The suburb of the address.
Type String The address type.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean If set to true, includes inactive addresses in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

Aliases

Retrieves a list of aliases for a constituent

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: ConstituentId is required in order to query Aliases.

  • ConstituentId supports the '=' operator.
For example:
	SELECT * FROM Aliases WHERE ConstituentId = '280'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the alias.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with the alias.
Name String The name to use as the constituent's alias.
Type String The alias type.

Blackbaud Raisers Edge NXT Connector for CData Sync

AppealAttachments

Returns a list of attachments for an appeal.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: AppealId is required in order to query AppealAttachments.

  • AppealId supports the '=' operator.
For example:
	SELECT * FROM AppealAttachments WHERE AppealId = '2'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the attachment.
AppealId String

FundraisingAppeals.Id

The immutable system record ID of the appeal.
ContentType String The content type. For physical attachments only.
Date Datetime The date of the attachment.
FileId String The identifier of the file.
FileName String The file name.
FileSize Integer The file size in bytes.
Name String The name of the attachment.
ParentId String The parent object's immutable system record ID.
Tags String The tags associated with the attachment.
ThumbnailId String The identifier of the thumbnail.
ThumbnailUrl String The URL for a thumbnail.
Type String The attachment type.
Url String The URL for the attachment.

Blackbaud Raisers Edge NXT Connector for CData Sync

CampaignAttachments

Returns a list of attachments for a campaign.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: CampaignId is required in order to query CampaignAttachments.

  • CampaignId supports the '=' operator.
For example:
	SELECT * FROM CampaignAttachments WHERE CampaignId = '2'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the attachment.
CampaignId String

Campaigns.Id

The immutable system record ID of the campaign.
ContentType String The content type. For physical attachments only.
Date Datetime The date of the attachment.
FileId String The identifier of the file.
FileName String The file name.
FileSize Integer The file size in bytes.
Name String The name of the attachment.
ParentId String The parent object's immutable system record ID.
Tags String The tags associated with the attachment.
ThumbnailId String The identifier of the thumbnail.
ThumbnailUrl String The URL for a thumbnail.
Type String The attachment type.
Url String The URL for the attachment.

Blackbaud Raisers Edge NXT Connector for CData Sync

Campaigns

Campaigns are your organization's overall fundraising efforts or initiatives, such as operating expenses, new buildings, and endowments

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=' operator.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
  • IncludeInactive supports the '=' operators.
For example:
	
	SELECT * FROM Campaigns WHERE DateModified >= '2010-06-01 14:03:35'
	
	SELECT * FROM Campaigns WHERE IncludeInactive=true

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the campaign.
Category String The category of the campaign.
DateAdded Datetime The date when the campaign was created.
DateModified Datetime The date when the campaign was last modified.
Description String The display name of the campaign.
EndDate Datetime The end date of the campaign.
GoalValue Double The monetary goal associated with the campaign.
Inactive Boolean This computed field indicates that the campaign is active if the current date is after any start_date and before any end_date.
LookupId String The user-defined identifier for the campaign.
StartDate Datetime The start date of the campaign.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean If set to true, includes inactive campaigns in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

ConsentCategories

Returns a list of consent categories.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • IncludeInactive supports the '=' operator.
For example:
	
	SELECT * FROM ConsentCategories WHERE IncludeInactive = true
	

Columns

Name Type References Description
Description String The name of the consent category.
Inactive Boolean Indicates whether the consent category is inactive.
Sequence Integer The placement of the category in the order of category table values, if defined.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean If set to true, includes inactive consent categories in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

ConsentChannelCategories

Returns a list of valid consent channel category combinations.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

Columns

Name Type References Description
Category String The name of the category included in the channel/category combination.
Channel String The name of the channel included in the channel/category combination.
Sequence Integer The placement of the channel/category in the order of channel/category table values, if defined.

Blackbaud Raisers Edge NXT Connector for CData Sync

ConsentChannels

Represents the consent channel entity

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

Columns

Name Type References Description
Description String The name of the consent channel.

Blackbaud Raisers Edge NXT Connector for CData Sync

ConsentSources

Represents the consent source entity

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • IncludeInactive supports the '=' operator.
For example:
	
	SELECT * FROM ConsentSources WHERE IncludeInactive=true
	

Columns

Name Type References Description
Description String The name of the consent source.
Inactive Boolean Indicates whether the consent source is inactive.
Sequence Integer The placement of the source in the order of source table values, if defined.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean If set to true, includes inactive consent sources in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

ConstituentAppeals

Returns a list of appeals for a constituent.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • ConstituentId supports the '=' operator.
For example:
	
	SELECT * FROM ConstituentAppeals WHERE ConstituentId='280'
	

Columns

Name Type References Description
Id [KEY] String The immutable system record ID.
AppealCategoryDescription String The appeal category description.
AppealCategoryId String The immutable system record ID of the appeal category.
AppealCategoryInactive Boolean Indicates whether the appeal category is inactive.
AppealDescription String The appeal description.
AppealId String The immutable system record ID of the appeal.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent the appeal is associated to.
Date Datetime The date when the appeal was added.
PackageDescription String The package description.
PackageId String The package Id.

Blackbaud Raisers Edge NXT Connector for CData Sync

ConstituentAttachments

Returns a list of attachments for a constituent.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: ConstituentId is required in order to query ConstituentAttachments.

  • ConstituentId supports the '=' operator.
For example:
	SELECT * FROM ConstituentAttachments WHERE ConstituentId = '280'
	

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the attachment.
ConstituentId String The immutable system record ID of the constituent associated with the attachment.
ContentType String The content type.
Date Datetime The date of the attachment.
FileId String The identifier of the file.
FileName String The file name.
FileSize Integer The file size in bytes.
Name String The name of the attachment.
ParentId String The parent object's immutable system record ID.
Tags String The tags associated with the attachment.
Type String The attachment type.
Url String The URL for the attachment.

Blackbaud Raisers Edge NXT Connector for CData Sync

ConstituentCodes

Constituent codes define the high-level affiliations between constituents and your organization - such as Board member, Vendor, and Volunteer - to provide context for why constituents are in the database

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=' operator.
  • ConstituentId supports the '=' operator.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
  • IncludeInactive supports the '=' operator.
For example:
	
	SELECT * FROM ConstituentCodes WHERE Id = '144'

	SELECT * FROM ConstituentCodes WHERE ConstituentId = '280'
	
	SELECT * FROM ConstituentCodes WHERE DateAdded >= '1999-10-26T15:45:27'
	
	SELECT * FROM ConstituentCodes WHERE DateModified >= '1999-10-26T15:45:27'
	
	SELECT * FROM ConstituentCodes WHERE IncludeInactive = true
	

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the constituent code.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with the constituent code.
DateAdded Datetime The date when the constituent code was created.
DateModified Datetime The date when the constituent code was last modified.
Description String The description of the constituent code.
Inactive Boolean This computed field indicates that the constituent code is active if the current date is after any start date and before any end date.
StartD Integer The start day of the constituent code.
StartM Integer The start month of the constituent code.
StartY Integer The start year of the constituent code.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean This computed field indicates that the constituent code is active if the current date is after any start date and before any end date.

Blackbaud Raisers Edge NXT Connector for CData Sync

ConstituentConsents

Returns a list of constituent consent records.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: ConstituentId is required in order to query ConstituentConsents.

  • ConstituentId supports the '=' operator.
  • Category supports the '=,in' operators.
  • Channel supports the '=,in' operators.
  • MostRecentOnly supports the '=' operator.
For example:
	
	SELECT * FROM ConstituentConsents WHERE ConstituentId = '280'
	
	SELECT * FROM ConstituentConsents WHERE ConstituentId = '280' AND Channel IN ('Phone','Email')
	
	SELECT * FROM ConstituentConsents WHERE ConstituentId = '280' AND Category IN ('Fundraising','Newsletter')
	

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the consent record.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent the consent is associated to.
Category String The category that the consent response applies to.
Channel String The channel that the consent response applies to.
ConsentDate Datetime The date the consent response was received.
ConsentStatement String The statement the constituent responded to when providing consent.
ConstituentConsentResponse String How the constituent responded to consent for the specified channel/category.
DateAdded Datetime The date the consent response was added.
PrivacyNotice String The privacy notice provided to the constituent.
Source String The source of the consent response from the constituent.
UserName String The user that added the consent response.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
MostRecentOnly Boolean If set to true, includes inactive constituent consents in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

ConstituentFundraiserAssignments

Returns a list of fundraiser assignments for a constituent.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: ConstituentId is required in order to query ConstituentFundraiserAssignments.

  • ConstituentId supports the '=' operator.
  • IncludeInactive supports the '=' operator.
For example:
	SELECT * FROM ConstituentFundraiserAssignments WHERE ConstituentId = '280'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the fundraiser assignment.
AmountValue Double The goal amount for the fundraiser to solicit from the assigned constituent.
AppealId String

FundraisingAppeals.Id

The immutable system record ID of the appeal the fundraiser should use to request gifts.
CampaignId String

Campaigns.Id

The immutable system record ID of the campaign to apply resulting gifts to.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent to apply resulting gifts to.
End Datetime The fundraiser assignment end date.
FundId String

Funds.Id

The immutable system record ID of the fund any resulting gifts should be applied to.
FundraiserId String The immutable system record ID of the fundraiser.
Start Datetime The fundraiser assignment start date.
Type String The type of fundraiser.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean If set to true, includes inactive assignments in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

Constituents

Returns a paginated list of constituents

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,in' operators.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
  • FundraiserStatus supports the '=,in' operators.
  • ConstituentCode supports the '=' operator.
  • CustomFieldCategory supports the '=' operator.
  • Fields supports the '=,in' operators.
  • IncludeDeceased supports the '=' operator.
  • ListId supports the '=' operator.
  • IncludeInactive supports the '=' operator.
  • PostalCode supports the '=,in' operators.
For example:
	
	SELECT * FROM Constituents WHERE Id = '280'
	
	SELECT * FROM Constituents WHERE ListId = '75e71c26-7288-49db-a767-f9305b704fee'
	
	SELECT * FROM Constituents WHERE FundraiserStatus IN ('Active', 'None')

Columns

Name Type References Description
Id [KEY] String The immutable system record ID for the constituent.
AddressLines String The address lines.
AddressCity String The city of the address.
AddressConstituentId String The immutable system record ID of the constituent associated with the address.
AddressCountry String The country of the address.
AddressCounty String The county of the address.
AddressDateAdded Datetime The date when the address was created.
AddressDateModified Datetime The date when the address was last modified.
AddressDoNotMail Boolean Indicates whether the constituent requests not to be contacted at this address.
AddressEnd Datetime The date when the constituent ceased to reside at this address.
AddressFormattedAddress String This computed field retrieves the formatted address in the configured format of the country.
AddressId String The immutable system record ID of the address.
AddressInactive Boolean This computed field indicates that the address is active if the current date is before any end date.
AddressPostalCode String The postal code of the address.
AddressPreferred Boolean Indicates whether this is the constituent's preferred address.
AddressSeasonalEndD Integer The day of the year ceases to reside at this address.
AddressSeasonalEndM Integer The month of the year ceases to reside at this address.
AddressSeasonalEndY Integer The year ceases to reside at this address.
AddressSeasonalStartD Integer The day of year that the constituent begins residing at this address.
AddressSeasonalStartM Integer The month of year that the constituent begins residing at this address.
AddressSeasonalStarty Integer The year that the constituent begins residing at this address.
AddressStart Date The date when the constituent began residing at this address.
AddressState String The state of the address.
AddressSuburb String The suburb of the address.
AddressType String The address type.
Age Integer This computed field calculates the constituent's age based on the birth date property.
BirthdateD Integer The constituent's day of birth.
BirthdateM Integer The constituent's month of birth.
BirthdateY Integer The constituent's year of birth.
DateAdded Datetime The date when the constituent was created.
DateModified Datetime The date when the constituent was last modified.
Deceased String Indicates whether the constituent is deceased.
DeceasedDateD Integer The day of the year when the constituent died.
DeceasedDateM Integer The month of year when the constituent died.
DeceasedDateY Integer The year when the constituent died.
EmailAddress String The email address.
EmailConstituentId String The immutable system record ID of the constituent associated with the email address.
EmailDateAdded Datetime The date when the email address was created.
EmailDateModified Datetime The date when the email address was last modified.
EmailDoNotEmail Boolean Indicates whether the constituent requests not to be contacted at this email address.
EmailId String The immutable system record ID of the email address.
EmailInactive Boolean Indicates whether the email address is inactive.
EmailPrimary Boolean Indicates whether this is the constituent's primary email address.
EmailType String The type of email address. Available values are the entries in the Phone Types table.
First String The constituent's first name.
FormerName String The constituent's former name.
FundraiserStatus String Indicates whether the constituent is a fundraiser.
Gender String The constituent's gender.
GivesAnonymously Boolean Indicates whether the constituent gives anonymously.
Inactive Boolean Indicates whether the constituent is inactive.
Last String The constituent's last name.
LookupId String The user-defined identifier for the constituent.
MaritalStatus String The constituent's marital status.
Middle String The constituent's middle name.
Name String If the constituent's type is Individual, this is the full name of the constituent. If the type is Organization, this is the organization's name.
OnlinePresenceAddress String The web address for the online presence.
OnlinePresenceConstituentId String The immutable system record ID of the constituent associated with the online presence.
OnlinePresenceDateAdded Datetime The date when the online presence was created.
OnlinePresenceDateModified Datetime The date when the online presence was last modified.
OnlinePresenceId String The immutable system record ID of the online presence.
OnlinePresenceInactive Boolean Indicates whether the online presence is inactive.
OnlinePresencePrimary Boolean Indicates whether this is the constituent's primary online presence.
OnlinePresenceType String The online presence type.
PhoneConstituentId String The immutable system record ID of the constituent associated with the phone.
PhoneDateAdded Datetime The date when the phone was created.
PhoneDateModified Datetime The date when the phone was last modified.
PhoneDoNotCall Boolean Indicates whether the constituent requests not to be contacted at this number.
PhoneId String The immutable system record ID of the phone.
PhoneInactive Boolean Indicates whether the phone is inactive.
PhoneNumber String The phone number.
PhonePrimary Boolean Indicates whether this is the constituent's primary phone.
PhoneType String The phone type.
PreferredName String The constituent's preferred name.
SpouseFirst String This computed field retrieves information about the constituent's spouse using the constituent's relationships.
SpouseId String This computed field retrieves information about the constituent's spouse using the constituent's relationships.
SpouseLast String This computed field retrieves information about the constituent's spouse using the constituent's relationships.
Suffix String The constituent's primary suffix.
Suffix2 String The constituent's secondary suffix.
Title String The constituent's primary title.
Title2 String The constituent's secondary title.
Type String The type of constituent.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
ConstituentCode String Represents a list of constituent codes. Returns constituents if any of the specified constituent codes match any of their active constituent codes.
CustomFieldCategory String Represents a list of custom field categories. Returns constituents if any of the specified custom field categories match any of their active custom fields.
Fields String Represents the fields to include on the returned records.
IncludeDeceased Boolean Set this parameter to true to include deceased constituents in the response.
IncludeInactive Boolean Set this parameter to true to include inactive constituents in the response.
ListId String Defines a list identifier used to filter the set of constituents to those included in the specified list. If this value is set, other specified filters will be ignored.
PostalCode String Represents a comma-separated list of postal codes. Returns constituents if any of the specified postal codes match the postal code for their preferred address.

Blackbaud Raisers Edge NXT Connector for CData Sync

ConstituentsCustomFields

Retrieves custom fields for all constituents

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

Columns

Name Type References Description
Id String The immutable system record ID of the custom field.
ConstituentId String The parent object's immutable system record ID.
Name String The custom field category.
Value String The value of the custom field.
Comment String The comment on the custom field.
DateAdded Datetime The date when the custom field was created.
DateModified Datetime The date when the custom field was last modified.
Type String The type of data that the custom field represents.

Blackbaud Raisers Edge NXT Connector for CData Sync

ConstituentSolicitCodes

Returns a list of solicit codes for the specified constituent.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: ConstituentId is required in order to query ConstituentSolicitCodes.

  • ConstituentId supports the '=' operator.
For example:
 
	SELECT * FROM ConstituentSolicitCodes WHERE ConstituentId = '280'
	

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the constituent solicit code.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with the solicit code.
EndDate Datetime The end date of the solicit code.
SolicitCode String Communication instructions and/or restrictions for a constituent.
StartDate Datetime The start date of the solicit code.

Blackbaud Raisers Edge NXT Connector for CData Sync

Countries

Returns the list of available countries.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the country.
Abbreviation String The user-defined abbreviation for the country.
Name String The country name.

Blackbaud Raisers Edge NXT Connector for CData Sync

Educations

Returns a list of educations for all constituent or a specified constituent

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=' operator.
  • ConstituentId supports the '=' operator.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
For example:
	
	SELECT * FROM Educations WHERE ConstituentId = '280'
	
	SELECT * FROM Educations WHERE DateAdded >= '2010-06-01 14:03:35'	

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the education.
Campus String The campus.
ClassOf String The year the constituent graduated.
ClassOfDegree String The class of degree.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with the education.
DateAdded Datetime The date when the education was created.
DateEnteredD Integer The first day of attendance.
DateEnteredM Integer The first month of attendance.
DateEnteredY Integer The first year of attendance.
DateGraduatedD Integer The graduation day.
DateGraduatedM Integer The graduation month.
DateGraduatedY Integer The graduation year.
DateLeftD Integer The last day of attendance.
DateLeftM Integer The last month of attendance.
DateLeftY Integer The last year of attendance.
DateModified Datetime The date when the education was last modified.
Degree String The degree received.
Department String The name of the education department.
Faculty String The name of the faculty.
Gpa Double The grade point average.
KnownName String The known name.
Majors String The major courses of study.
Minors String The minor courses of study.
Primary Boolean Indicates whether this is the constituent's primary school association.
RegistrationNumber String The registration number.
School String The school name.
SocialOrganization String The social organization.
Status String The status of the education.
SubjectOfStudy String The subject of study.
Type String The type of education.

Blackbaud Raisers Edge NXT Connector for CData Sync

Emails

Returns a list of email addresses of all constituents or a specified constituent

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • ConstituentId supports the '=,in' operators.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
  • IncludeInactive supports "=" operator.
For example:
	
	SELECT * FROM Emails WHERE ConstituentId = '280'
	
	SELECT * FROM Emails WHERE DateAdded >= '2010-06-01 14:03:35'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the email address.
Address String The email address.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with the email address.
DateAdded Datetime The date when the email address was created.
DateModified Datetime The date when the email address was last modified.
DoNotEmail Boolean Indicates whether the constituent requests not to be contacted at this email address.
Inactive Boolean Indicates whether the email address is inactive.
Primary Boolean Indicates whether this is the constituent's primary email address.
Type String The type of email address.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean If set to true, includes inactive email addresses in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

EventCategories

Returns a list of active event categories.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • IncludeInactive supports the '=' operator.
For example:
	
	SELECT * FROM EventCategories WHERE IncludeInactive = true

Columns

Name Type References Description
Id [KEY] String The ID of the event category.
Inactive Boolean Whether the category is inactive. True if inactive.
Name String The name of the event category.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean If set to true, includes inactive campaigns in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

EventFees

Returns a list of fees for an event.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: EventId is required in order to query EventFees.

  • EventId supports the '=' operator.
For example:
	SELECT * FROM EventFees WHERE EventId = '2'

Columns

Name Type References Description
Id [KEY] String The ID of the event fee.
ContributionAmount Double The tax deductible amount for this fee.
Cost Double The fee's cost.
EventId String

Events.Id

The ID of the event the fee is linked to.
Name String The name of the event fee.
NumberSold Integer The number of fees sold.

Blackbaud Raisers Edge NXT Connector for CData Sync

EventParticipantGuests

The participant's basic summary information

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: EventId is required in order to query EventParticipantGuests.

  • EventId supports the '=' operator.
For example:
	SELECT * FROM EventParticipantGuests WHERE EventId = '2'

Columns

Name Type References Description
ContactId String The ID of the contact attending the event.
EventId String

Events.Id

The ID of the event which the participant belongs to.
Name String The participant's full name.
ParticipantId String The ID of the participant.

Blackbaud Raisers Edge NXT Connector for CData Sync

EventParticipantMemberships

The individual's membership category

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: EventId is required in order to query EventParticipantMemberships.

  • EventId supports the '=' operator.
For example:
	SELECT * FROM EventParticipantMemberships WHERE EventId = '2'

Columns

Name Type References Description
CategoryId String The ID of the membership category.
CategoryName String The name of the membership category.
EventId String

Events.Id

The ID of the event which the participant belongs to.

Blackbaud Raisers Edge NXT Connector for CData Sync

EventParticipantOptions

Returns the participant options for an event.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: EventId is required in order to query EventParticipantOptions.

  • EventId supports the '=' operator.
For example:
	SELECT * FROM EventParticipantOptions WHERE EventId = '2'

Columns

Name Type References Description
Id [KEY] String The ID of the event participant option.
EventId String

Events.Id

The ID of the event which the participant belongs to.
AddedByService String The ID of the service who added this option.
AddedByUser String The ID of the user that added this option.
DateAdded Datetime The date this option was added.
DateUpdated Datetime The date this option was updated.
InputType String The available types of event participant options.
ListOptions String A event participant option list option.
MultiSelect Boolean Only valid for List input type, determines if multiple options can be selected.
Name String The name of the event participant option.
ParticipantId String The ID of the participant.
UpdatedByService String The ID of the service who updated this option.
UpdatedByUser String The ID of the user who updated this option.
Version Integer The version number of the option.

Blackbaud Raisers Edge NXT Connector for CData Sync

EventParticipants

Returns a list of participants for an event.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: EventId is required in order to query EventParticipants.

  • Attended supports the '=' operator.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
  • EventId supports the '=' operator.
  • InvitationStatus supports the '=' operator.
  • IsConstituent supports the '=' operator.
  • ParticipationLevelName supports the '=,in' operators.
  • RsvpStatus supports the '=,in' operators.
  • EmailEligible supports the '=' operator.
  • PhoneCallEligible supports the '=' operator.
  • FeesPaid supports the '=' operator.
  • Fields supports the '=' operator.
For example:
	SELECT * FROM EventParticipants WHERE EventId = '2'
	
	SELECT * FROM EventParticipants WHERE EventId = '2' AND DateAdded >= '2010-06-01 14:03:35'

Columns

Name Type References Description
Id [KEY] String The ID of the participant.
Attended Boolean Whether the participant attended the event.
ClassOf String The participant's graduating class.
ContactId String The ID of the contact attending the event.
DateAdded Datetime The date the participant was created.
DateModified Datetime The date when the participant was last modified.
DoNotCall Boolean The participant's phone call preference.
DoNotEmail Boolean The participant's email preference.
Email String The participant's email address.
EventId String

Events.Id

The ID of the event which the participant belongs to.
FirstName String The participant's first name.
FormerName String The participant's former name.
HostContactId String The ID of the contact attending the event.
HostName String The participant's full name.
HostParticipantId String The ID of the host participant.
InvitationStatus String The possible states for a constituent's invitation to an event.
IsConstituent Boolean Indicates whether the participant is a constituent.
LastName String The participant's last name.
LookupId String The LookupId of the participant.
MiddleName String The participant's middle name.
Name String The participant's full name.
NameTag String The name tag for the participant.
ParticipationLevelId String The ID of the participation level.
ParticipationLevelIsInactive Boolean Whether the participation level is inactive. True if inactive.
ParticipationLevelName String The name of the participation level.
Phone String The participant's phone number.
PreferredName String The participant's preferred name.
RsvpDateD Integer The day in the fuzzy date.
RsvpDateM Integer The month in the fuzzy date.
RsvpDateY Integer The year in the fuzzy date.
RsvpStatus String The possible states for a participant's RSVP for an event.
Seat String The seat assignment for the participant.
Suffix String The participant's suffix.
Title String The participant's title.
TotalPaid Integer The sum of the participant's paid gifts with a type of Registration Fees.
TotalRegistrationFees Integer The sum of the participant's fee amounts.
SummaryNote String summary Notes.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
EmailEligible Boolean A filter to include or exclude participants based on whether they have a primary email address that's not marked Do not email.
PhoneCallEligible Boolean A filter to include or exclude participants based on whether they have a primary phone number that's not marked Do not call.
FeesPaid Boolean A filter to include or exclude participants that have paid or not paid their fees.
Fields String Represents a list of fields to include on the returned records.

Blackbaud Raisers Edge NXT Connector for CData Sync

Events

Returns a list of events

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=' operator.
  • CategoryName supports the '=' operator.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
  • Name supports the '=' operator.
  • StartDate supports the '>=,<=' operators.
  • IncludeInactive supports the '=' operator.
  • Fields supports the '=' operator.
For example:
	
	SELECT * FROM Events WHERE Id = '2'
	
	SELECT * FROM Events WHERE StartDate >= '2000-04-06T05:50:00' AND StartDate <= '2020-04-06T06:50:00'
	
	SELECT * FROM Events WHERE DateAdded >= '2010-06-01 14:03:35'

Columns

Name Type References Description
Id [KEY] String The ID of the event.
AttendedCount Integer The number of event attendees.
AttendingCount Integer The number of event participants who plan to attend.
CampaignId String The ID of the campaign affiliated with the event.
Capacity Integer The number of people that can attend the event.
CategoryId String The ID of the event category.
CategoryInactive Boolean Whether the category is inactive.
CategoryName String The name of the event category.
DateAdded Datetime The date when the event was created.
DateModified Datetime The date when the event was last modified.
EndDate Datetime The end date of the event.
EndTime String The end time of the event.
FundId String The ID of the fund affiliated with the event.
Goal Double The monetary goal of the event.
Inactive Boolean Whether the event is inactive.
InvitedCount Integer The number of event invitees.
LocationName String The name of the location.
LocationAddressLines String The location's address lines.
LocationPostalCode String The location's postal code.
LocationLocalityId String The record ID of the locality record.
LocationLocalityName String The name of the locality.
LocationAdministrativeAreaId String The record ID of the administrative area.
LocationAdministrativeAreaName String The name of the administrative area.
LocationAdministrativeAreaShortDesc String The short description of the administrative area.
LocationSubAdministrativeAreaId String The ID of the sub administrative area.
LocationSubAdministrativeAreaName String The name of the sub administrative area.
LocationCountryId String The ID of the country record.
LocationCountryDisplayName String The display name of the country.
LocationCountryIsoAlpha2Code String The ISO 3166-1 alpha-2 code for the country.
LocationFormattedAddress String The location's formatted address.
LookupId String The lookup ID of the event.
Name String The name of the event.
StartDate Date The start date of the event.
StartTime String The start time of the event.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
Fields String Represents a list of fields to include on the returned records
IncludeInactive Boolean If set to true, includes inactive phones in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

FundAttachments

Returns a list of attachments for a fund.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: FundId is required in order to query FundAttachments.

  • FundId supports the '=' operator.
For example:
	SELECT * FROM FundAttachments WHERE FundId = '4'
	

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the attachment.
FundId String

Funds.Id

The immutable system record ID of the fund.
ContentType String The content type. For physical attachments only.
Date Datetime The date of the attachment.
FileId String The identifier of the file.
FileName String The file name.
FileSize Integer The file size in bytes.
Name String The name of the attachment.
ParentId String The parent object's immutable system record ID.
Tags String The tags associated with the attachment.
ThumbnailId String The identifier of the thumbnail.
ThumbnailUrl String The URL for a thumbnail.
Type String The attachment type.
Url String The URL for the attachment.

Blackbaud Raisers Edge NXT Connector for CData Sync

FundraiserAssignments

Returns a list of assignments for a fundraiser.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: FundraiserId is required in order to query FundraiserAssignments.

  • FundraiserId supports the '=' operator.
For example:
	SELECT * FROM FundraiserAssignments WHERE FundraiserId = '4'
	

Columns

Name Type References Description
Id String The immutable system record ID of the given assignment.
AmountValue Double The goal amount for the fundraiser to solicit from the assigned constituent.
AppealId String

FundraisingAppeals.Id

The immutable system record ID of the appeal the fundraiser should use to request gifts.
CampaignId String

Campaigns.Id

The immutable system record ID of the campaign to apply resulting gifts to.
ConstituentId String

Constituents.Id

The immutable system record ID of the target constituent.
End Datetime The fundraiser end date.
FundId String

Funds.Id

The immutable system record ID of the fund any resulting gifts should be applied to.
FundraiserId String The immutable system record ID of the fundraiser assigned to the constituent.
Start Date The fundraiser start date.
Type String The type of fundraiser.

Blackbaud Raisers Edge NXT Connector for CData Sync

FundraiserGoals

Returns a list of goals for a fundraiser

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: FundraiserId is required in order to query FundraiserGoals.

  • FundraiserId supports the '=' operator.
For example:
	SELECT * FROM FundraiserGoals WHERE FundraiserId = '4'
	

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the fundraiser goal.
AmountValue Double The fundraiser goal amount.
AppealId String

FundraisingAppeals.Id

The immutable system record ID of the appeal associated with the fundraiser goal.
CampaignId String

Campaigns.Id

The immutable system record ID of the campaign associated with the fundraiser goal.
FundId String

Funds.Id

The immutable system record ID of the fund associated with the fundraiser goal.
FundraiserId String The immutable system record ID of the fundraiser associated with the fundraiser goal.
Type String The fundraiser goal type. Available values are Campaign, Fund, UnspecifiedCategory, and Appeal.
UnspecifiedCategoryName String The unspecified category name for the fundraiser goal.

Blackbaud Raisers Edge NXT Connector for CData Sync

FundraisingAppeals

Returns a list of fundraising appeals.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,in' operators.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
  • IncludeInactive supports the '=' operator.
For example:
	
	SELECT * FROM FundraisingAppeals WHERE Id = '4'
	
	SELECT * FROM FundraisingAppeals WHERE IncludeInactive = true

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the appeal.
Category String The category of the appeal.
DateAdded Datetime The date when the appeal was created.
DateModified Datetime The date when the appeal was last modified.
Description String The display name of the appeal.
EndDate Datetime The end date of the appeal.
GoalValue Double The monetary goal associated with the appeal.
Inactive Boolean This computed field indicates that the appeal is active if the current date is after any start_date and before any end_date.
LookupId String The user-defined identifier for the appeal.
StartDate Datetime The start date of the appeal.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean If set to true, includes inactive appeals in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

Funds

Returns a list of funds.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=,in' operators.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
  • IncludeInactive supports the '=' operator.
For example:
	
	SELECT * FROM Funds WHERE Id = '4'
	
	SELECT * FROM Funds WHERE IncludeInactive = true

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the fund.
Category String The category of the fund.
DateAdded Datetime The date when the fund was created.
DateModified Datetime The date when the fund was last modified.
Description String The display name of the fund.
EndDate Datetime The end date of the fund.
GoalValue Double The monetary goal associated with the fund.
Inactive Boolean This computed field indicates that the fund is active if the current date is after any start_date and before any end_date.
LookupId String The user-defined identifier for the fund.
StartDate Datetime The start date of the fund.
Type String The type of the fund.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean If set to true, includes inactive funds in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

GiftAcknowledgements

Returns a list of acknowledgements for a gift

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: GiftId are required in order to query GiftAcknowledgements.

  • GiftId supports the '=' operator.
For example:
	SELECT * FROM GiftAcknowledgements WHERE GiftId = '476'

Columns

Name Type References Description
GiftId String

Gifts.Id

The immutable system record ID of the gift associated with the acknowledgement.
Date Datetime The date associated with the acknowledgement.
Letter String The letter associated with the acknowledgement.
Status String The status of the acknowledgement. Available values are: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT, and DONOTACKNOWLEDGE.

Blackbaud Raisers Edge NXT Connector for CData Sync

GiftAttachments

Returns a list of attachments for a gift.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: GiftId are required in order to query GiftAttachments.

  • GiftId supports the '=' operator.
For example:
	SELECT * FROM GiftAttachments WHERE GiftId = '476'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the attachment.
GiftId String

Gifts.Id

The immutable system record ID of the gift the attachments are associated to.
ContentType String The content type. For physical attachments only.
Date Datetime The date of the attachment.
FileId String The identifier of the file.
FileName String The file name.
FileSize Integer The file size in bytes.
Name String The name of the attachment.
ParentId String The parent object's immutable system record ID.
Tags String The tags associated with the attachment.
ThumbnailId String The identifier of the thumbnail.
ThumbnailUrl String The URL for a thumbnail.
Type String The attachment type.
Url String The URL for the attachment.

Blackbaud Raisers Edge NXT Connector for CData Sync

GiftBatches

Returns a list of gift batches.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • BatchNumber supports the '=' operator.
  • CreatedBy supports the '=' operator.
  • HasExceptions supports the '=' operator.
  • IsApproved supports the '=' operator.
  • SearchText supports the '=' operator.

Columns

Name Type References Description
Id [KEY] String The batch identifier.
ActualAmount Integer The actual batch amount.
BatchDescription String The batch description.
BatchNumber String The batch number.
CreatedBy String Created by user name.
AddedBy String Added by user name.
CreatedOn Datetime The date the batch was created.
DateAdded Datetime The date the batch was added.
HasExceptions Boolean The has exceptions boolean.
IsApproved Boolean Approved boolean.
Approved Boolean Approved boolean.
NumberOfGifts Integer The number of gifts in the batch.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
SearchText String If set to true, includes inactive gift batches in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

GiftPayments

Returns payments for a gift.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: GiftId are required in order to query GiftPayments.

  • GiftId supports the '=' operator.
For example:
	SELECT * FROM GiftPayments WHERE GiftId = '476'

Columns

Name Type References Description
GiftId String

Gifts.Id

The immutable system record ID of the gift associated with the payment.
AccountToken String The tokenized account information (e.g. credit card) from the external payment provider. Only applies to payment methods of CreditCard and DirectDebit.
BbpsConfigurationId String The bbps configuration ID. Only applies to payment methods of CreditCard and DirectDebit.
BbpsTransactionId String The bbps transaction ID. Only applies to payment methods of CreditCard and DirectDebit.
CheckDateD String The day of the check date. Only applies to payment method of PersonalCheck.
CheckDateM String The month of the check date. Only applies to payment method of PersonalCheck.
CheckDateY String The year of the check date. Only applies to payment method of PersonalCheck.
CheckNumber String The check number. Only applies to payment method of PersonalCheck.
CheckoutTransactionId String The checkout transaction ID. Only applies to payment methods of CreditCard and DirectDebit.
PaymentMethod String The payment method.
Reference String The reference.
ReferenceDateD String The day of the reference date.
ReferenceDateM String The month of the reference date.
ReferenceDateY String The year of the reference date.

Blackbaud Raisers Edge NXT Connector for CData Sync

GiftReceipts

Returns receipts for a gift.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: GiftId are required in order to query GiftReceipts.

  • GiftId supports the '=' operator.
For example:
	SELECT * FROM GiftReceipts WHERE GiftId = '476'

Columns

Name Type References Description
GiftId String

Gifts.Id

The immutable system record ID of the gift associated with the receipt.
AmountValue Integer The amount of the receipt.
Date Datetime The date on the receipt.
Number Integer The number of the receipt.
Status String The status of the receipt. Available values are: RECEIPTED, NEEDSRECEIPT, and DONOTRECEIPT.

Blackbaud Raisers Edge NXT Connector for CData Sync

Gifts

Returns a paginated list of gifts

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=' operator.
  • ConstituentId supports the '=,in' operators.
  • Date supports the '>=,<=' operators.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
  • PostStatus supports the '=,in' operators.
  • Type supports the '=' operator.
  • ListId supports the '=' operator.
  • AppealId supports the '=,in' operators.
  • FundId supports the '=,in' operators.
  • CampaignId supports the '=,in' operators.
  • AcknowledgmentStatus supports the '=,in' operators.
  • ReceiptStaus supports the '=,in' operators.
For example:
	
	SELECT * FROM Gifts WHERE ConstituentId IN ('280', '281')
	
	SELECT * FROM Gifts WHERE PostStatus = 'Posted'
	
	SELECT * FROM Gifts WHERE Type IN ('Pledge', 'GiftInKind')

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the gift.
AmountValue Double The monetary amount of the gift.
BalanceValue Double The balance remaining on the gift.
BatchNumber String The batch number associated with this gift.
Constituency String The constituency of the gift.
ConstituentId String The immutable system record ID of the constituent associated with the gift.
Date Date The gift date.
DateAdded Datetime The date when the gift was created.
DateModified Datetime The date when the gift was last modified.
GiftAidAmountValue Double This computed field calculates the total qualified amount of tax reclaimed from Gift Aid across all gift_splits for this gift.
GiftAidQualificationStatus String This computed field determines the Gift Aid qualification status based on tax declaration information and the database format. Available values are: Qualified, NotQualified, and PartlyQualified. For the UK only.
GiftStatus String The status of the gift. Available values are Active, Held, Terminated, Completed, and Cancelled.
IsAnonymous Bool Indicates whether the gift is anonymous.
LinkedGifts String The identifiers of other gifts that are linked to this gift.
LookupId String The user-defined identifier for the gift.
Origin String The origin of the gift.
PostDate Datetime The date that the gift was posted to general ledger.
PostStatus String The general ledger post status of the gift.
RecurringGiftStatusDateD Integer The date (D) that the gift status was last modified.
RecurringGiftStatusDateM Integer The date (M) that the gift status was last modified.
RecurringGiftStatusDateY Integer The date (Y) that the gift status was last modified.
Reference String Notes to track special details about a gift such as the motivation behind it or a detailed description of a gift-in-kind.
Subtype String The subtype of the gift.
Type String The gift type.
GiftCode String The gift Code.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
ListId String Defines a list identifier used to filter the set of gifts to those included in the specified list. If this value is set, other specified filters will be ignored.
AppealId String Returns gifts if any of the specified appeal identifiers match any of their appeals.
FundId String Returns gifts if any of the specified fund identifiers match any of their funds.
CampaignId String Returns gifts if any of the specified campaign identifiers match any of their campaigns.
AcknowledgmentStatus String Returns gifts if their acknowledgement status matches any specified.
ReceiptStaus String Returns gifts if their receipt status matches any specified.

Blackbaud Raisers Edge NXT Connector for CData Sync

GiftsCustomFields

Retrieves custom fields for all gifts

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

Columns

Name Type References Description
Id String The immutable system record ID of the custom field.
GiftId String The parent object's immutable system record ID.
Name String The custom field category.
Value String The value of the custom field.
Comment String The comment on the custom field.
DateAdded Datetime The date when the custom field was created.
DateModified Datetime The date when the custom field was last modified.
Type String The type of data that the custom field represents.

Blackbaud Raisers Edge NXT Connector for CData Sync

GiftSoftCredits

Returns soft credits for a gift.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: GiftId are required in order to query GiftSoftCredits.

  • GiftId supports the '=' operator.
For example:
	SELECT * FROM GiftSoftCredits WHERE GiftId = '476'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the soft credit.
AmountValue Double The amount of the soft credit.
ConstituentId String The immutable system record ID of the constituent associated with the soft credit.
GiftId String

Gifts.Id

The immutable system record ID of the gift associated with the soft credit.

Blackbaud Raisers Edge NXT Connector for CData Sync

GiftSplits

Returns the splits for a gift.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: GiftId are required in order to query GiftSplits.

  • GiftId supports the '=' operator.
For example:
	SELECT * FROM GiftSplits WHERE GiftId = '476'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the gift split.
GiftId String

Gifts.Id

The immutable system record ID of the gift associated with the gift split.
AmountValue Integer The amount of the gift split.
AppealId String The immutable system record ID of the appeal associated with the gift split.
CampaignId String The immutable system record ID of the campaign associated with the gift split.
FundId String The immutable system record ID of the fund associated with the gift split.
GiftAidAmount String The amount of tax reclaimed from gift aid for this gift split. For the UK only.
GiftAidQualificationStatus String The gift aid qualification status of the gift split. Available values are: Qualified, and NotQualified. For the UK only.
PackageId String The immutable system record ID of the package associated with the gift split.

Blackbaud Raisers Edge NXT Connector for CData Sync

Giving

Returns the first, latest or greatest gift recorded for a constituent.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: ConstituentId and GivingSummaryType are required in order to query Giving.

  • ConstituentId supports the '=' operator.
  • GivingSummaryType supports the '=' operator.
For example:
	SELECT * FROM Giving WHERE ConstituentId = '280' AND GivingSummaryType = 'greatest'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the gift.
AmountValue Double The gift amount.
Date Date The gift date.
Type String The gift type.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with this giving.
GivingSummaryType String The giving summary type. Available values are First, Latest and Greatest.

使用できる値は次のとおりです。first, greatest, latest

Blackbaud Raisers Edge NXT Connector for CData Sync

GivingAppeals

Returns the giving appeals summary for the constituent

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: ConstituentId and GivingSummaryType are required in order to query GivingAppeals.

  • ConstituentId supports the '=' operator.
  • GivingSummaryType supports the '=' operator.
For example:
	SELECT * FROM GivingAppeals WHERE ConstituentId = '280' AND GivingSummaryType = 'first'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the appeal.
Description String The description.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with this giving.
GivingSummaryType String The giving summary type. Available values are First, Latest and Greatest.

使用できる値は次のとおりです。first, greatest, latest

Blackbaud Raisers Edge NXT Connector for CData Sync

GivingCampaigns

Returns the giving campaigns summary for the constituent

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: ConstituentId and GivingSummaryType are required in order to query GivingCampaigns.

  • ConstituentId supports the '=' operator.
  • GivingSummaryType supports the '=' operator.
For example:
	SELECT * FROM GivingCampaigns WHERE ConstituentId = '280' AND GivingSummaryType = 'greatest'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the campaign.
Description String The campaign description.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with this giving.
GivingSummaryType String The giving summary type. Available values are First, Latest and Greatest.

使用できる値は次のとおりです。first, greatest, latest

Blackbaud Raisers Edge NXT Connector for CData Sync

GivingFunds

Returns the giving funds summary for the constituent

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: ConstituentId and GivingSummaryType are required in order to query GivingFunds.

  • ConstituentId supports the '=' operator.
  • GivingSummaryType supports the '=' operator.
For example:
	
	SELECT * FROM GivingFunds WHERE ConstituentId = '280' AND GivingSummaryType = 'latest'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the fund.
Description String The fund description.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with this giving.
GivingSummaryType String The giving summary type. Available values are First, Latest and Greatest.

使用できる値は次のとおりです。first, greatest, latest

Blackbaud Raisers Edge NXT Connector for CData Sync

LifetimeGiving

Returns the lifetime giving information for a constituent.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: ConstituentId are required in order to query LifetimeGiving.

  • ConstituentId supports the '=' operator.
For example:
	SELECT * FROM LifetimeGiving WHERE ConstituentId = '280'

Columns

Name Type References Description
ConsecutiveYearsGiven Integer This computed field calculates the number of consecutive years the constituent has given.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with the lifetime giving.
TotalCommittedMatchingGiftsValue Double This computed field calculates the total amount of matching gift commitments attributed to the constituent.
TotalGivingValue Double This computed field calculates the total amount given by the constituent.
TotalPledgeBalanceValue Double This computed field calculates the unpaid pledge balance for the constituent.
TotalReceivedGivingValue Double This computed field calculates the total received amount given by the constituent.
TotalReceivedMatchingGiftsValue Double This computed field calculates the total amount of payments toward matching gift pledges attributed to the constituent.
TotalSoftCreditsValue Double This computed field calculates the total amount of soft credits applied to the constituent.
TotalYearsGiven Integer This computed field calculates the total number of years the constituent has given.

Blackbaud Raisers Edge NXT Connector for CData Sync

Lists

Returns a list of lists for the given list type

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • ListType supports the '=' operator.
For example:
	SELECT * FROM Lists WHERE ListType = 'Constituent'
	

Columns

Name Type References Description
Id [KEY] String The immutable system record ID for the list.
DateModified Datetime The date this list was last modified.
Description String The description of the list
IsPublic Boolean Indicates whether this is a public or private list.
LastModifiedByUserId String The ID of the user that last modified the list.
LastModifiedByUserName String The name of the user that last modified the list.
Name String The name of the list.
RecordCount Integer The total number of records defined by this list based on the last time this list was saved.
ListType String Type of the list.

使用できる値は次のとおりです。Constituent, Gift, Action, Opportunity

Blackbaud Raisers Edge NXT Connector for CData Sync

Members

Returns the list of members.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • ConstituentId supports the '=' operator.
For example:
	SELECT * FROM Members WHERE ConstituentId = '280'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the member.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with the member.
Primary Boolean Indicates whether this is the primary member on the membership.

Blackbaud Raisers Edge NXT Connector for CData Sync

Memberships

Returns a list of memberships.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • ConstituentId supports the '=' operator.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
For example:
	
	SELECT * FROM Memberships WHERE ConstituentId = '280'
	
	SELECT * FROM Memberships WHERE DateAdded >= '2010-06-01 14:03:35'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the membership.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with the membership.
Category String The membership category.
DateAdded Datetime The date when the membership was created.
DateModified Datetime The date when the membership was last modified.
DuesValue Integer The membership dues.
Expires Datetime The date when the membership expires.
Joined Datetime The date when the membership becomes active.
Program String The membership program.
Standing String The membership status. Available values are New, Active, Lapsed, and Dropped.
Subcategory String The membership subcategory.

Blackbaud Raisers Edge NXT Connector for CData Sync

Notes

Returns a list of notes that tracks helpful or important details such as specific interests and special instructions for donations

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=' operator.
  • ConstituentId supports the '=' operator.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
For example:
	
	SELECT * FROM Notes WHERE ConstituentId='280'
	
	SELECT * FROM Notes WHERE DateAdded >= '2010-06-01 14:03:35'
	

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the note.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with the note.
DateD Integer The day of note date.
DateM Integer The month of note date.
DateY Integer The year of note date.
DateAdded Datetime The date when the note was created.
DateModified Datetime The date when the note was last modified.
Summary String The note summary.
Text String The note's contents.
Type String The note type.

Blackbaud Raisers Edge NXT Connector for CData Sync

OnlinePresences

Returns a paginated list of online presences that store a constituent's social media accounts, websites.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • ConstituentId supports the '=' operator.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
  • IncludeInactive supports the '=' operator.
For example:
	
	SELECT * FROM OnlinePresences WHERE ConstituentId = '280'
	
	SELECT * FROM OnlinePresences WHERE DateAdded >= '2010-06-01 14:03:35'
	
	SELECT * FROM OnlinePresences WHERE IncludeInactive = true

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the online presence.
Address String The web address for the online presence.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with the online presence.
DateAdded Datetime The date when the online presence was created.
DateModified Datetime The date when the online presence was last modified.
Inactive Boolean Indicates whether the online presence is inactive.
Primary Boolean Indicates whether this is the constituent's primary online presence.
Type String The online presence type.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean If set to true, includes inactive online presences in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

Opportunities

Retrieves a list of opportunities

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=' operator.
  • ConstituentId supports the '=,in' operators.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
  • IncludeInactive supports the '=' operator.
For example:
	
	SELECT * FROM Opportunities WHERE Id = '4'
	
	SELECT * FROM Opportunities WHERE ConstituentId IN ('255', '266')
	
	SELECT * FROM Opportunities WHERE DateAdded >= '1999-06-01 14:03:35'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the opportunity.
AskAmountValue Double The monetary amount solicited from the prospect for the opportunity.
AskDate Date The date when the solicitation was made.
CampaignId String

Campaigns.Id

The immutable system record ID of the campaign associated with the opportunity. The campaign sets the overall objectives for raising money.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with the opportunity.
DateAdded Datetime The date when the opportunity was created.
DateModified Datetime The date when the opportunity was last modified.
Deadline Datetime The goal date for the opportunity to result in a gift.
ExpectedAmountValue Double The monetary amount that is realistically expected to result from the opportunity.
ExpectedDate Datetime The date when the prospect is expected to give in response to the opportunity.
FundId String

Funds.Id

The immutable system record ID of the fund associated with the opportunity.
FundedAmountValue Double The monetary amount that the prospect gave in response to the opportunity.
FundedDate Datetime The date when the prospect gave in response to the opportunity.
Fundraisers String Fundraiser constituents interact with other constituents and prospects on behalf of your organization to cultivate relationships and advance opportunities to secure major gifts.
Inactive Boolean Indicates whether the opportunity is inactive.
LinkedGifts String The immutable system record IDs of the gifts related to the opportunity.
Name String The name that identifies the opportunity throughout the program, such as in lists or on constituent records.
Purpose String The intended use for any money raised as a result of the opportunity.
Status String The status that indicates where the opportunity is in the solicitation process.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean If set to true, includes inactive opportunities in the response.
ListId String Defines a list identifier used to filter the set of opportunities to those included in the specified list. If this value is set, other specified filters will be ignored.

Blackbaud Raisers Edge NXT Connector for CData Sync

OpportunitiesCustomFields

Retrieves custom fields for an opportunity

Columns

Name Type References Description
Id String The immutable system record ID of the custom field.
OpportunityId String The parent object's immutable system record ID.
Name String The custom field category.
Value String The value of the custom field.
Date Datetime The date when the custom field was created.
DateAdded Datetime The date when the custom field was added.
DateModified Datetime The date when the custom field was last modified.
Type String The type of data that the custom field represents.

Blackbaud Raisers Edge NXT Connector for CData Sync

OpportunityAttachments

Returns a list of attachments for an opportunity

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: OpportunityId is required in order to query OpportunityAttachments.

  • OpportunityId supports the '=' operator.
For example:
	SELECT * FROM OpportunityAttachments WHERE OpportunityId = '4'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the attachment.
OpportunityId String

Opportunities.Id

The ID of the Opportunity.
Content_type String The content type. For physical attachments only.
Date Datetime The date of the attachment.
FileId String The identifier of the file.
FileName String The file name. For physical attachments only.
FileSize Integer The file size in bytes. For physical attachments only.
Name String The name of the attachment.
ParentId String The parent object's immutable system record ID.
Tags String The tags associated with the attachment.
ThumbnailId String The identifier of the thumbnail. For physical attachments that are images only.
ThumbnailUrl String The URL for a thumbnail.
Type String The attachment type. Available values are Link and Physical.
Url String The URL for the attachment.

Blackbaud Raisers Edge NXT Connector for CData Sync

Packages

Returns a list of packages that contains content and other items for the appeals that organizations use to solicit gifts

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=' operator.
  • AppealId supports the '=,in' operators.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
  • IncludeInactive supports the '=' operator.
For example:
	
	SELECT * FROM Packages WHERE Id = '1'
	
	SELECT * FROM Packages WHERE AppealId IN ('17', '18')
	
	SELECT * FROM Packages WHERE DateAdded >= '1999-06-01 14:03:35'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the package.
AppealId String

FundraisingAppeals.Id

The immutable system record ID of the appeal associated with this package.
Category String The category of the package.
DateAdded Datetime The date when the package was created.
DateModified Datetime The date when the package was last modified.
DefaultGiftAmountValue Double The default amount for gifts associated with this package.
Description String The display name of the package.
End Datetime The end date of the package.
GoalValue Double The goal of this package.
Inactive Boolean This computed field indicates that the package is active if the current date is after any start and before any end.
LookupId String The user-defined identifier for the package.
Notes String The notes on the package.
RecipientCount Integer The amount of recipients of the package.
Start Datetime The start date of the package.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean If set to true, includes inactive packages in the response.

Blackbaud Raisers Edge NXT Connector for CData Sync

ParticipantFeePayments

Returns the fee payments for a participant.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: ParticipantId is required in order to query ParticipantFeePayments.

  • ParticipantId supports the '=' operator.
For example:
	SELECT * FROM ParticipantFeePayments WHERE ParticipantId = '197'

Columns

Name Type References Description
Id [KEY] String The ID of the participant fee.
ParticipantId String

EventParticipants.Id

The ID of the participant that the participant fee is linked to.
AppliedAmount Integer The applied amount of the participant fee payment.
GiftId String The ID of the gift that the participant fee is linked to.

Blackbaud Raisers Edge NXT Connector for CData Sync

ParticipantFees

Returns a list of fees for a participant.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: ParticipantId is required in order to query ParticipantFees.

  • ParticipantId supports the '=' operator.
For example:
	SELECT * FROM ParticipantFees WHERE ParticipantId = '197'

Columns

Name Type References Description
Id [KEY] String The ID of the participant fee.
ParticipantId String

EventParticipants.Id

The ID of the record that the participant fee is linked to.
DateD Integer The day in the fuzzy date.
DateM Integer The month in the fuzzy date.
DateY Integer The year in the fuzzy date.
EventFeeContributionAmount Integer The tax deductible amount for this fee.
EventFeeCost Double The fee's cost.
EventFeeEventId String The ID of the event the fee is linked to.
EventFeeId String The ID of the event fee.
EventFeeName String The name of the event fee.
EventFeeNumberSold Integer The number of fees sold.
FeeAmount Double The amount of the participant fee.
Quantity Integer The quantity purchased.
TaxReceiptableAmount Integer The tax receiptable amount of the participant fee.

Blackbaud Raisers Edge NXT Connector for CData Sync

ParticipantLevels

Returns a list of participation levels for all events.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • IncludeInactive supports the '=' operator.
For example:
	
	SELECT * FROM ParticipantLevels WHERE IncludeInactive = true

Columns

Name Type References Description
Id [KEY] String The ID of the participation level.
IsInactive Boolean Whether the participation level is inactive. True if inactive.
Name String The name of the participation level.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean If set to true, includes inactive participation levels in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

ParticipantOptions

Returns the participant options for a participant.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: ParticipantId is required in order to query ParticipantOptions.

  • ParticipantId supports the '=' operator.
For example:
	SELECT * FROM ParticipantOptions WHERE ParticipantId = '197'

Columns

Name Type References Description
Id [KEY] String The ID of the participant option.
ParticipantId String

EventParticipants.Id

The ID of the participant.
AddedByService String The name of the service that added this participant option.
AddedByUser String The ID of the user that added the participant option.
DateAdded Datetime The date the participant option was added.
DateUpdated Datetime The date the participant option was updated.
EventId String The ID of the event.
EventParticipantOptionId String The ID of the event participant option.
OptionValue String The participant's response to the option.
UpdatedByService String The name of the service that updated this participant option.
UpdatedByUser String The ID of the user who updated the participant option.

Blackbaud Raisers Edge NXT Connector for CData Sync

Phones

Returns a list of phones for all constituents or a specific constituent

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=' operator.
  • ConstituentId supports the '=,in' operators.
  • DateAdded supports the '>=' operators.
  • DateModified supports the '>=' operators.
  • IncludeInactive supports the '=' operators.
For example:
	
	SELECT * FROM Phones WHERE Id = '1'
	
	SELECT * FROM Phones WHERE ConstituentId IN ('280', '281')
	
	SELECT * FROM Phones WHERE DateAdded >= '2010-06-01 14:03:35'

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the phone.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with the phone.
DateAdded Datetime The date when the phone was created.
DateModified Datetime The date when the phone was last modified.
DoNotCall Boolean Indicates whether the constituent requests not to be contacted at this number.
Inactive Boolean Indicates whether the phone is inactive.
Number String The phone number.
Primary Boolean Indicates whether this is the constituent's primary phone.
Type String The phone type.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean If set to true, includes inactive phones in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

RatingCategories

Returns a list of all available rating categories.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • IncludeInactive supports the '=' operator.
  • SourceName supports the '=' operator.
For example:
	
	SELECT * FROM RatingCategories WHERE SourceName = 'Econometrics'
	
	SELECT * FROM RatingCategories WHERE IncludeInactive = true

Columns

Name Type References Description
Inactive Boolean Indicates whether the category is inactive.
Name String The name of the rating category.
SourceName String The source of the category.
Type String The type of the rating category.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean If set to true, includes inactive rating categories in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

Ratings

Returns a list of ratings for a constituent.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.
Note: ConstituentId is required in order to query Ratings.

  • ConstituentId supports the '=' operator.
  • IncludeInactive supports the '=' operator.
  • MostRecentlyUsed supports the '=' operator.
For example:
	
	SELECT * FROM Ratings WHERE ConstituentId = '280'
	
	SELECT * FROM Ratings WHERE IncludeInactive = true
	
	SELECT * FROM Ratings WHERE MostRecentlyUsed = true

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the rating.
Category String The category of the rating.
Comment String A comment about the rating.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with the rating.
Date Datetime The date of the rating.
Inactive Boolean This computed field indicates that the rating is active if the category is active.
Source String The source of the rating.
Type String This computed field indicates the type of data that the rating represents based on the category property.
Value String The value of the rating.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean If set to true, includes inactive ratings in the result.
MostRecentOnly Boolean If set to true, includes only most recent ratings in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

RatingSources

Returns a list of all available rating sources.

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • IncludeInactive supports the '=' operator.
For example:
	
	SELECT * FROM RatingSources WHERE IncludeInactive = true

Columns

Name Type References Description
Inactive Boolean Indicates whether the rating source is inactive.
Name String The name of the rating source.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
IncludeInactive Boolean If set to true, includes inactive rating sources in the result.

Blackbaud Raisers Edge NXT Connector for CData Sync

Relationships

Returns a list of relationships between constituents and other individuals and organizations such as family, friends, and employers

Table Specific Information

Select

The Sync App will use the BlackBaud Raiser's Edge NXT API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • Id supports the '=' operator.
  • ConstituentId supports the '=' operator.
  • DateAdded supports the '>=,>' operators.
  • DateModified supports the '>=,>' operators.
For example:
	SELECT * FROM Relationships WHERE Id = '1'
	
	SELECT * FROM Relationships WHERE ConstituentId = '280'
	

Columns

Name Type References Description
Id [KEY] String The immutable system record ID of the relationship.
Comment String The comment on the relationship.
ConstituentId String

Constituents.Id

The immutable system record ID of the constituent associated with the relationship.
DateAdded Datetime The date when the relationship was created.
DateModified Datetime The date when the relationship was last modified.
EndD Integer The end day for the relationship.
EndM Integer The end month for the relationship.
EndY Integer The end year for the relationship.
IsOrganizationContact Boolean Indicates whether the related individual represents the organization as a contact.
IsPrimaryBusiness Boolean Indicates whether the related organization is the individual's primary business.
IsSpouse Boolean Indicates whether the related constituent is the constituent's spouse.
Name String The name of the related constituent.
OrganizationContactType String Provides context for interactions with the related individual who represents the organization as a contact.
Position String The individual's position in the organization.
ReciprocalRelationshipId String The identifier for the reciprocal relationship record.
ReciprocalType String Describes the constituent's relationship to the related constituent.
RelationId String The immutable system record ID of the related individual or organization.
StartD Integer The start day for the relationship.
StartM Integer The start month for the relationship.
StartY Integer The start year for the relationship.
Type String The type of relation that the relationship represents.

Blackbaud Raisers Edge NXT Connector for CData Sync

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

OAuth


プロパティ説明
OAuthClientIdOAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecretOAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
SubscriptionKeySubscription key which provides access to the API. Found in your Developer Profile.

SSL


プロパティ説明
SSLServerCertTLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall


プロパティ説明
FirewallTypeプロキシベースのファイアウォールで使われるプロトコル。
FirewallServerプロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPortプロキシベースのファイアウォールのTCP ポート。
FirewallUserプロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPasswordプロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy


プロパティ説明
ProxyAutoDetectこれは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServerHTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPortProxyServer プロキシが起動しているTCP ポート。
ProxyAuthSchemeProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUserProxyServer プロキシへの認証に使われるユーザー名。
ProxyPasswordProxyServer プロキシへの認証に使われるパスワード。
ProxySSLTypeProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptionsProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging


プロパティ説明
LogModulesログファイルに含めるコアモジュール。

Schema


プロパティ説明
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemasこのプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesこのプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Miscellaneous


プロパティ説明
IncludeCustomFieldsSet to true to retrieve custom fields values for Constituents, Actions, Opportunities, and Gifts.
MaxRowsクエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PageSizeThe number of results to return per page of data retrieved from BlackBaud Raiser's Edge NXT.
PseudoColumnsこのプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
Blackbaud Raisers Edge NXT Connector for CData Sync

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。


プロパティ説明
OAuthClientIdOAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecretOAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
SubscriptionKeySubscription key which provides access to the API. Found in your Developer Profile.
Blackbaud Raisers Edge NXT Connector for CData Sync

OAuthClientId

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

Blackbaud Raisers Edge NXT Connector for CData Sync

OAuthClientSecret

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

Blackbaud Raisers Edge NXT Connector for CData Sync

SubscriptionKey

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

解説

To obtain a key, follow these steps:

  • 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.

Blackbaud Raisers Edge NXT Connector for CData Sync

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。


プロパティ説明
SSLServerCertTLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
Blackbaud Raisers Edge NXT Connector for CData Sync

SSLServerCert

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります:

説明 例
フルPEM 証明書(例では省略されています) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。 C:\cert.cer
公開鍵(例では省略されています) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) 34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

Blackbaud Raisers Edge NXT Connector for CData Sync

Firewall

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。


プロパティ説明
FirewallTypeプロキシベースのファイアウォールで使われるプロトコル。
FirewallServerプロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPortプロキシベースのファイアウォールのTCP ポート。
FirewallUserプロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPasswordプロキシベースのファイアウォールへの認証に使われるパスワード。
Blackbaud Raisers Edge NXT Connector for CData Sync

FirewallType

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。

タイプ デフォルトポート 説明
TUNNEL 80 これが設定されている場合、Sync App はBlackBaud Raiser's Edge NXT への接続を開き、プロキシを経由して通信が行われます。
SOCKS4 1080 これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5 1080 これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

Blackbaud Raisers Edge NXT Connector for CData Sync

FirewallServer

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

Blackbaud Raisers Edge NXT Connector for CData Sync

FirewallPort

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

Blackbaud Raisers Edge NXT Connector for CData Sync

FirewallUser

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

Blackbaud Raisers Edge NXT Connector for CData Sync

FirewallPassword

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

Blackbaud Raisers Edge NXT Connector for CData Sync

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。


プロパティ説明
ProxyAutoDetectこれは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
ProxyServerHTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPortProxyServer プロキシが起動しているTCP ポート。
ProxyAuthSchemeProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUserProxyServer プロキシへの認証に使われるユーザー名。
ProxyPasswordProxyServer プロキシへの認証に使われるパスワード。
ProxySSLTypeProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptionsProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
Blackbaud Raisers Edge NXT Connector for CData Sync

ProxyAutoDetect

これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

Blackbaud Raisers Edge NXT Connector for CData Sync

ProxyServer

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

Blackbaud Raisers Edge NXT Connector for CData Sync

ProxyPort

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

Blackbaud Raisers Edge NXT Connector for CData Sync

ProxyAuthScheme

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

  • BASIC: Sync App はHTTP BASIC 認証を行います。
  • DIGEST: Sync App はHTTP DIGEST 認証を行います。
  • NEGOTIATE: Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKereros トークンを取得します。
  • PROPRIETARY: Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

Blackbaud Raisers Edge NXT Connector for CData Sync

ProxyUser

ProxyServer プロキシへの認証に使われるユーザー名。

解説

ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

Blackbaud Raisers Edge NXT Connector for CData Sync

ProxyPassword

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

Blackbaud Raisers Edge NXT Connector for CData Sync

ProxySSLType

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。

AUTOデフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS接続は、常にSSL 有効となります。
NEVER接続は、SSL 有効になりません。
TUNNEL接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

Blackbaud Raisers Edge NXT Connector for CData Sync

ProxyExceptions

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

Blackbaud Raisers Edge NXT Connector for CData Sync

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。


プロパティ説明
LogModulesログファイルに含めるコアモジュール。
Blackbaud Raisers Edge NXT Connector for CData Sync

LogModules

ログファイルに含めるコアモジュール。

解説

指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログ ページを参照してください。

Blackbaud Raisers Edge NXT Connector for CData Sync

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。


プロパティ説明
Locationテーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemasこのプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tablesこのプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
Blackbaud Raisers Edge NXT Connector for CData Sync

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\RaiserEdgeNXT Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:

Blackbaud Raisers Edge NXT Connector for CData Sync

BrowsableSchemas

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

Blackbaud Raisers Edge NXT Connector for CData Sync

Tables

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Blackbaud Raisers Edge NXT Connector for CData Sync

Views

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Blackbaud Raisers Edge NXT Connector for CData Sync

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。


プロパティ説明
IncludeCustomFieldsSet to true to retrieve custom fields values for Constituents, Actions, Opportunities, and Gifts.
MaxRowsクエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
Otherこれらの隠しプロパティは特定のユースケースでのみ使用されます。
PageSizeThe number of results to return per page of data retrieved from BlackBaud Raiser's Edge NXT.
PseudoColumnsこのプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeoutタイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UserDefinedViewsカスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
Blackbaud Raisers Edge NXT Connector for CData Sync

IncludeCustomFields

Set to true to retrieve custom fields values for Constituents, Actions, Opportunities, and Gifts.

解説

Setting this to true will significantly impact the performance of selecting data from Constituents, Actions, Opportunities, and Gifts. Retrieval of custom fields requires making a lookup per record, making it very expensive to retrieve them.

Blackbaud Raisers Edge NXT Connector for CData Sync

MaxRows

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

解説

クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。

Blackbaud Raisers Edge NXT Connector for CData Sync

Other

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

DefaultColumnSizeデータソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename基底のソケットデータ転送を指定のファイルに記録します。

Blackbaud Raisers Edge NXT Connector for CData Sync

PageSize

The number of results to return per page of data retrieved from BlackBaud Raiser's Edge NXT.

解説

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

Blackbaud Raisers Edge NXT Connector for CData Sync

PseudoColumns

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

Blackbaud Raisers Edge NXT Connector for CData Sync

Timeout

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

Blackbaud Raisers Edge NXT Connector for CData Sync

UserDefinedViews

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

  • 各ルートエレメントはビューの名前を定義します。
  • 各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Constituents WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}
UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8479