Ir para o conteúdo

Detalhes da Conexão do Blackbaud Raiser's Edge NXT

Introdução

Versão do conector

Esta documentação é baseada na versão 21.0.8257 do conector.

Começando

Suporte à versão Edge NXT do BlackBaud Raiser

O conector aproveita a API SKY para permitir o acesso bidirecional ao Edge NXT da BlackBaud Raiser.

Estabelecendo uma Conexão

Autenticar Via Autenticação OAuth

Você pode se conectar depois de definir as propriedades de conexão necessárias para suas credenciais de usuário e obter os tokens de acesso necessários usando uma ferramenta como o Postman.

Antes de estabelecer uma conexão, forneça o SubscriptionKey, encontrado no perfil Edge NXT do BlackBaud Raiser.

Consulte Usando autenticação OAuth para obter detalhes do fluxo de autenticação OAuth.

Usando Autenticação OAuth

OAuth requer o uso de tokens de acesso obtidos com Postman ou ferramenta similar. A autenticação OAuth é suportada conforme descrito em Conexão em Configurar conexões OAuth.

Anotações Importantes

Procedimentos Armazenados

  • Os recursos de procedimentos armazenados descritos nesta documentação não são suportados no momento.
  • Como os procedimentos armazenados não são suportados atualmente, qualquer recurso dependente de procedimentos armazenados também não é suportado atualmente.

Arquivos de Configuração e Seus Caminhos

  • Todas as referências para adicionar arquivos de configuração e seus caminhos referem-se a arquivos e locais no Harmony Agente onde o conector está instalado. Esses caminhos devem ser ajustados conforme apropriado, dependendo do agente e do sistema operacional. Se vários agentes forem usados em um grupo de agentes, arquivos idênticos serão necessários em cada agente.

Características Avançadas

Esta seção detalha uma seleção de recursos avançados do conector Edge NXT do BlackBaud Raiser.

Visualizações definidas pelo usuário

O conector permite definir tabelas virtuais, denominadas visões definidas pelo usuário, cujo conteúdo é decidido por uma consultar pré-configurada. Essas exibições são úteis quando você não pode controlar diretamente as consultas enviadas aos drivers. Consulte Visualizações definidas pelo usuário para obter uma visão geral da criação e configuração de exibições personalizadas.

Configuração SSL

Use Configuração SSL para ajustar como o conector lida com as negociações de certificado TLS/SSL. Você pode escolher entre vários formatos de certificado; Veja o SSLServerCert propriedade em "Opções de cadeia de conexão" para obter mais informações.

Procurador

Para configurar o conector usando configurações de proxy do Agente Privado, selecione os Use Proxy Settings caixa de seleção na tela de configuração da conexão.

Visualizações Definidas pelo Usuário

O Conector Jitterbit para Blackbaud Raisers Edge NXT permite definir uma tabela virtual cujo conteúdo é decidido por uma consultar pré-configurada. Elas são chamadas de Visualizações Definidas pelo Usuário, que são úteis em situações onde você não pode controlar diretamente a consultar que está sendo emitida para o driver, por exemplo, ao usar o driver do Jitterbit. As Visualizações Definidas pelo Usuário podem ser usadas para definir predicados que são sempre aplicados. Se você especificar predicados adicionais na consultar para a visualização, eles serão combinados com a consultar já definida como parte da visualização.

Há duas maneiras de criar exibições definidas pelo usuário:

  • Crie um arquivo de configuração em formato JSON definindo as visualizações desejadas.
  • declarações DDL.

Definindo Visualizações Usando um Arquivo de Configuração

As visualizações definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json. O conector detecta automaticamente as visualizações especificadas neste arquivo.

Você também pode ter várias definições de exibição e controlá-las usando o UserDefinedViews propriedade de conexão. Quando você usa essa propriedade, apenas as exibições especificadas são vistas pelo conector.

Este arquivo de configuração de exibição definida pelo usuário é formatado da seguinte forma:

  • Cada elemento raiz define o nome de uma visualização.
  • Cada elemento raiz contém um elemento filho, chamado query, que contém a consultar SQL personalizada para a exibição.

Por exemplo:

{
    "MyView": {
        "query": "SELECT * FROM Constituents WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use o UserDefinedViews propriedade de conexão para especificar a localização do seu arquivo de configuração JSON. Por exemplo:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Esquema para Exibições Definidas pelo Usuário

As visualizações definidas pelo usuário são expostas no UserViews esquema por padrão. Isso é feito para evitar que o nome da exibição entre em conflito com uma entidade real no modelo de dados. Você pode alterar o nome do esquema usado para UserViews definindo o UserViewsSchemaName propriedade.

Trabalhando com Exibições Definidas pelo Usuário

Por exemplo, uma instrução SQL com uma Visualização Definida pelo Usuário chamada UserViews.RCustomers lista apenas clientes em Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Exemplo de consultar ao driver:

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

Resultando na consultar efetiva à fonte:

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

Esse é um exemplo muito simples de uma consultar a uma exibição definida pelo usuário que é efetivamente uma combinação da consultar de exibição e da definição de exibição. É possível compor essas consultas em padrões muito mais complexos. Todas as operações SQL são permitidas em ambas as consultas e são combinadas quando apropriado.

Configuração SSL

Personalizando a Configuração SSL

Por padrão, o conector tenta negociar SSL/TLS verificando o certificado do servidor em relação ao armazenamento de certificados confiáveis do sistema.

Para especificar outro certificado, consulte o SSLServerCert propriedade para os formatos disponíveis para fazê-lo.

Modelo de Dados

Visão geral

Esta seção mostra os objetos de API disponíveis e fornece mais informações sobre a execução de SQL para as APIs Edge NXT do BlackBaud Raiser.

Características principais

  • O conector modela as entidades Edge NXT do BlackBaud Raiser, como documentos, pastas e grupos como exibições relacionais, permitindo que você escreva SQL para consultar os dados Edge NXT do BlackBaud Raiser.
  • Procedimentos armazenados* permitem que você execute operações no Edge NXT do BlackBaud Raiser.
  • A conectividade ao vivo com esses objetos significa que quaisquer alterações na conta Edge NXT do seu BlackBaud Raiser são refletidas imediatamente ao usar o conector.

Visualizações

Visualizações descreve as exibições disponíveis. As visualizações são definidas estaticamente para modelar ações, E-mails, eventos, etc.

Procedimentos armazenados

NOTE: Procedimentos armazenados não são suportados atualmente. Veja a nota para detalhes.

Procedimentos armazenados são interfaces semelhantes a funções para o Edge NXT da BlackBaud Raiser. Procedimentos armazenados* permitem que você execute operações no Edge NXT do BlackBaud Raiser, incluindo download de documentos e movimentação de envelopes.

Processamento de consulta colaborativa

O conector descarrega o máximo possível do processamento da instrução SELECT para o Edge NXT do BlackBaud Raiser e, em seguida, processa o restante da consultar na memória. Limitações e requisitos da API "também estão documentados nesta seção.

Ver SupportEnhancedSQL para obter mais informações sobre como o conector contorna as limitações da API com processamento na memória do lado do cliente.

Visualizações

As exibições são compostas por colunas e pseudocolunas. As exibições são semelhantes às tabelas na forma como os dados são representados; no entanto, as exibições não oferecem suporte a atualizações. Entidades que são representadas como exibições são normalmente entidades somente leitura. Frequentemente, um procedimento armazenado* está disponível para atualizar os dados se tal funcionalidade for aplicável à fonte de dados.

As consultas podem ser executadas em uma exibição como se fosse uma tabela normal, e os dados retornados são semelhantes nesse aspecto. Para saber mais sobre tabelas e procedimentos armazenados, navegue até as entradas correspondentes neste documento de ajuda.

Conector Jitterbit para Blackbaud Raisers Edge NXT Views

Nome Descrição
ActionAttachments Recupera uma lista de anexos para uma ação.
ActionCustomFields Recupera campos personalizados para uma ação
Actions Recupera uma lista de ações para todos os constituintes e para o constituinte especificado e detalhes da ação especificada.
Addresses Endereços armazenam informações sobre residências constituintes e outros endereços junto com informações sobre onde ou se enviar correspondência
Aliases Recupera uma lista de aliases para um constituinte
AppealAttachments Retorna uma lista de anexos para uma apelação.
CampaignAttachments Retorna uma lista de anexos para uma campanha.
Campaigns As campanhas são os esforços ou iniciativas gerais de arrecadação de fundos da sua organização, como despesas operacionais, novos edifícios e doações
ConsentCategories Retorna uma lista de categorias de consentimento.
ConsentChannelCategories Retorna uma lista de combinações válidas de categoria de canal de consentimento.
ConsentChannels Representa a entidade do canal de consentimento
ConsentSources Representa a entidade de origem do consentimento
ConstituentAppeals Retorna uma lista de apelações para um constituinte.
ConstituentAttachments Retorna uma lista de anexos para um constituinte.
ConstituentCodes Os códigos constituintes definem as afiliações de alto nível entre os constituintes e sua organização - como membro do conselho, fornecedor e voluntário - para fornecer contexto para o motivo pelo qual os constituintes estão no banco de dados
ConstituentConsents Retorna uma lista de registros de consentimento do constituinte.
ConstituentFundraiserAssignments Retorna uma lista de atribuições de arrecadação de fundos para um constituinte.
Constituents Retorna uma lista paginada de constituintes
ConstituentsCustomFields Recupera campos personalizados para todos os constituintes
ConstituentSolicitCodes Retorna uma lista de códigos de solicitação para o constituinte especificado.
Countries Retorna a lista de países disponíveis.
Educations Retorna uma lista de educações para todos os constituintes ou um constituinte especificado
Emails Retorna uma lista de endereços e-mail de todos os constituintes ou de um constituinte especificado
EventCategories Retorna uma lista de categorias de eventos ativos.
EventFees Retorna uma lista de taxas para um evento.
EventParticipantGuests Informações resumidas básicas do participante
EventParticipantMemberships A categoria de associação do indivíduo
EventParticipantOptions Retorna as opções do participante para um evento.
EventParticipants Retorna uma lista de participantes de um evento.
Events Retorna uma lista de eventos
FundAttachments Retorna uma lista de anexos para um fundo.
FundraiserAssignments Retorna uma lista de atribuições para uma campanha de arrecadação de fundos.
FundraiserGoals Retorna uma lista de metas para uma arrecadação de fundos
FundraisingAppeals Retorna uma lista de apelos de arrecadação de fundos.
Funds Retorna uma lista de fundos.
GiftAcknowledgements Retorna uma lista de agradecimentos por um presente
GiftAttachments Retorna uma lista de anexos para um presente.
GiftBatches Retorna uma lista de lotes de presentes.
GiftPayments Devolve pagamentos de um presente.
GiftReceipts Devolve recibos de um presente.
Gifts Retorna uma lista paginada de presentes
GiftsCustomFields Recupera campos personalizados para todos os presentes
GiftSoftCredits Retorna soft credits para um presente.
GiftSplits Retorna as divisões para um presente.
Giving Retorna o primeiro, o mais recente ou o maior presente registrado para um constituinte.
GivingAppeals Retorna o sumário de apelação do constituinte
GivingCampaigns Retorna o resumo das campanhas de doação para o constituinte
GivingFunds Retorna o resumo dos fundos de doação para o constituinte
LifetimeGiving Retorna o tempo de vida dando informações para um constituinte.
Lists Retorna uma lista de listas para o tipo de lista fornecido
Members Retorna a lista de membros.
Memberships Retorna uma lista de associações.
Notes Retorna uma lista de notas que rastreia detalhes úteis ou importantes, como interesses específicos e instruções especiais para doações
OnlinePresences Retorna uma lista paginada de presenças on-line que armazenam as contas de mídia social e sites de um constituinte.
Opportunities Recupera uma lista de oportunidades
OpportunitiesCustomFields Recupera campos personalizados para uma oportunidade
OpportunityAttachments Retorna uma lista de anexos para uma oportunidade
Packages Retorna uma lista de pacotes que contém conteúdo e outros itens para os apelos que as organizações usam para solicitar presentes
ParticipantFeePayments Retorna os pagamentos de taxas de um participante.
ParticipantFees Retorna uma lista de taxas para um participante.
ParticipantLevels Retorna uma lista de níveis de participação para todos os eventos.
ParticipantOptions Retorna as opções de participante para um participante.
Phones Retorna uma lista de telefones para todos os constituintes ou um constituinte específico
RatingCategories Retorna uma lista de todas as categorias de classificação disponíveis.
Ratings Retorna uma lista de classificações para um constituinte.
RatingSources Retorna uma lista de todas as fontes de classificação disponíveis.
Relationships Retorna uma lista de relacionamentos entre constituintes e outros indivíduos e organizações, como família, amigos e empregadores

Anexos de Ação

Recupera uma lista de anexos para uma ação.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: ActionId é necessário para consultar ActionAttachments.

  • ActionId suporta o = operador.

Por exemplo:

SELECT * FROM ActionAttachments WHERE ActionId = '335'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do anexo.
ActionId String Ações.ID O ID de registro do sistema imutável da ação à qual este anexo está associado.
ContentType String O tipo de conteúdo. Apenas para anexos físicos.
Date Datetime A data do anexo.
FileId String O identificador do arquivo.
FileName String O nome do arquivo.
FileSize Integer O tamanho do arquivo em bytes.
Name String O nome do anexo.
ParentId String O ID de registro do sistema imutável do objeto pai.
Tags String O ID de registro do sistema imutável do objeto pai.
ThumbnailId String O identificador da miniatura.
ThumbnailUrl String O URL de uma miniatura.
Type String O tipo de anexo.
Url String A URL do anexo.

ActionCustomFields

Recupera campos personalizados para uma ação

Colunas
Nome Tipo Referências Descrição
Id String O ID de registro do sistema imutável do campo personalizado.
ActionId String O ID de registro do sistema imutável do objeto pai.
Value String O valor do campo personalizado.
Date Datetime A data no campo personalizado.
Category String A categoria no campo personalizado.
Commment String A data em que o campo personalizado foi criado.
Type String O tipo de dados que o campo personalizado representa.

Ações

Recupera uma lista de ações para todos os constituintes e para o constituinte especificado e detalhes da ação especificada.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • Id suporta o = operador.
  • ComputedStatus suporta o = operador.
  • ConstituentId suporta o = operador.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.
  • StatusCode suporta os operadores '=,in'.

Por exemplo:

SELECT * FROM Actions WHERE ConstituentId = '280'

SELECT * FROM Actions WHERE ComputedStatus = 'Completed'

SELECT * FROM Actions WHERE DateAdded >= '2010-06-01 14:03:35'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável da ação.
Category String O canal ou intenção da interação constituinte.
Completed Boolean Indica se a ação foi concluída.
CompletedDate Datetime A data em que a ação foi concluída.
ComputedStatus String O status da ação computada. Os valores permitidos são Aberto, Concluído, Vencido.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado à ação.
Date Date A data da ação.
DateAdded Datetime A data em que a ação foi criada.
DateModified Datetime A data em que a ação foi modificada pela última vez.
Description String A explicação detalhada que elabora o resumo da ação.
Direction String A direção da ação.
EndTime String A hora de término da ação.
Fundraisers String O conjunto de IDs de registro do sistema constituintes imutáveis para os captadores de fundos associados à ação.
Location String O local da ação.
OpportunityId String Oportunidades.ID O ID de registro do sistema imutável da oportunidade associada à ação.
Outcome String O resultado da ação. Os valores disponíveis são Bem-sucedido e Mal-sucedido.
Priority String A prioridade da ação.
StartTime String A hora de início da ação.
Status String O estado da ação.
StatusCode String O código de status da ação. Essa propriedade só é retornada quando o sistema está configurado para usar status de ação customizada. Os valores permitidos são Fechado, Concluído, Pendente, Não concluído, Aberto, Enviado, Contínuo.
Summary String A breve descrição da ação que aparece na parte superior do registro.
Type String Descrição adicional da ação para complementar a categoria.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
ListId String

Endereços

Os endereços armazenam informações sobre residências constituintes e outros endereços, juntamente com informações sobre onde ou se enviar correspondência

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • Id suporta o = operador.
  • ConstituentId suporta o = operador.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.
  • IncludeInactive suporta o = operador.

Por exemplo:

SELECT * FROM Addresses WHERE ConstituentId = '280'

SELECT * FROM Addresses WHERE DateModified >= '2010-06-01 14:03:35'

SELECT * FROM Addresses WHERE IncludeInactive = true
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do endereço.
AddressLines String As linhas de endereço.
City String A cidade do endereço.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado ao endereço.
Country String O país do endereço.
County String O condado do endereço.
DateAdded Datetime A data em que o endereço foi criado.
DateModified Datetime A data em que o endereço foi modificado pela última vez.
DoNotMail Boolean Indica se o constituinte solicita não ser contactado neste endereço.
End Datetime A data em que o constituinte deixou de residir neste endereço.
FormattedAddress String A data em que o constituinte deixou de residir neste endereço.
Inactive Boolean Este campo calculado indica que o endereço está ativo se a data atual for anterior a qualquer data final.
PostalCode String O código postal do endereço.
Preferred Boolean Indica se este é o endereço preferencial do constituinte.
SeasonalEndD Integer O dia do ano deixa de residir neste endereço.
SeasonalEndM Integer O mês do ano deixa de residir neste endereço.
SeasonalEndY Integer O ano deixa de residir neste endereço.
SeasonalStartD Integer O dia do ano em que o constituinte começa a residir neste endereço.
SeasonalStartM Integer O mês do ano em que o constituinte passa a residir neste endereço.
SeasonalStartY Integer O ano em que o constituinte passa a residir neste endereço.
Start Datetime A data em que o constituinte começou a residir neste endereço.
State String O estado do endereço.
Suburb String Bairro do endereço.
Type String O tipo de endereço.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean

Apelido

Recupera uma lista de aliases para um constituinte

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Nota: ConstituentId é necessário para consultar Aliases.

  • ConstituentId suporta o = operador.

Por exemplo:

SELECT * FROM Aliases WHERE ConstituentId = '280'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do alias.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado ao alias.
Name String O nome a ser usado como alias do constituinte.
Type String O tipo de alias.

RecursoAnexos

Retorna uma lista de anexos para uma apelação.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: AppealId é necessário para consultar AppealAttachments.

  • AppealId suporta o = operador.

Por exemplo:

SELECT * FROM AppealAttachments WHERE AppealId = '2'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do anexo.
AppealId String Apelos de arrecadação de fundos.ID O ID de registro do sistema imutável da apelação.
ContentType String O tipo de conteúdo. Apenas para anexos físicos.
Date Datetime A data do anexo.
FileId String O identificador do arquivo.
FileName String O nome do arquivo.
FileSize Integer O tamanho do arquivo em bytes.
Name String O nome do anexo.
ParentId String O ID de registro do sistema imutável do objeto pai.
Tags String As tags associadas ao anexo.
ThumbnailId String O identificador da miniatura.
ThumbnailUrl String O URL de uma miniatura.
Type String O tipo de anexo.
Url String A URL do anexo.

Anexos da Campanha

Retorna uma lista de anexos para uma campanha.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Nota: CampaignId é necessário para consultar CampaignAttachments.

  • CampaignId suporta o = operador.

Por exemplo:

SELECT * FROM CampaignAttachments WHERE CampaignId = '2'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do anexo.
CampaignId String Campanhas.ID O ID de registro do sistema imutável da campanha.
ContentType String O tipo de conteúdo. Apenas para anexos físicos.
Date Datetime A data do anexo.
FileId String O identificador do arquivo.
FileName String O nome do arquivo.
FileSize Integer O tamanho do arquivo em bytes.
Name String O nome do anexo.
ParentId String O ID de registro do sistema imutável do objeto pai.
Tags String As tags associadas ao anexo.
ThumbnailId String O identificador da miniatura.
ThumbnailUrl String O URL de uma miniatura.
Type String O tipo de anexo.
Url String A URL do anexo.

Campanhas

As campanhas são os esforços ou iniciativas gerais de arrecadação de fundos da sua organização, como despesas operacionais, novos edifícios e doações

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • Id suporta o = operador.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.
  • IncludeInactive suporta os operadores '='.

Por exemplo:

SELECT * FROM Campaigns WHERE DateModified >= '2010-06-01 14:03:35'

SELECT * FROM Campaigns WHERE IncludeInactive=true
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável da campanha.
Category String A categoria da campanha.
DateAdded Datetime A data em que a campanha foi criada.
DateModified Datetime A data em que a campanha foi modificada pela última vez.
Description String O nome de exibição da campanha.
EndDate Datetime A data de término da campanha.
GoalValue Double A meta monetária associada à campanha.
Inactive Boolean Este campo computado indica que a campanha está ativa se a data atual for após qualquer start_date e antes de qualquer end_date.
LookupId String O identificador definido pelo usuário para a campanha.
StartDate Datetime A data de início da campanha.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean

Categorias de Consentimento

Retorna uma lista de categorias de consentimento.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • IncludeInactive suporta o = operador.

Por exemplo:

SELECT * FROM ConsentCategories WHERE IncludeInactive = true
Colunas
Nome Tipo Referências Descrição
Description String O nome da categoria de consentimento.
Inactive Boolean Indica se a categoria de consentimento está inativa.
Sequence Integer O posicionamento da categoria na ordem dos valores da tabela de categorias, se definido.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean

Categorias de Canal de Consentimento

Retorna uma lista de combinações válidas de categoria de canal de consentimento.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

Colunas
Nome Tipo Referências Descrição
Category String O nome da categoria incluída na combinação canal/categoria.
Channel String O nome do canal incluído na combinação canal/categoria.
Sequence Integer O posicionamento do canal/categoria na ordem dos valores da tabela de canal/categoria, se definido.

Canais de Consentimento

Representa a entidade do canal de consentimento

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

Colunas
Nome Tipo Referências Descrição
Description String O nome do canal de consentimento.

Fontes de Consentimento

Representa a entidade de origem do consentimento

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • IncludeInactive suporta o = operador.

Por exemplo:

SELECT * FROM ConsentSources WHERE IncludeInactive=true
Colunas
Nome Tipo Referências Descrição
Description String O nome da fonte de consentimento.
Inactive Boolean Indica se a fonte de consentimento está inativa.
Sequence Integer O posicionamento da origem na ordem dos valores da tabela de origem, se definido.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean

Apelações Constituintes

Retorna uma lista de recursos para um constituinte.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • ConstituentId suporta o = operador.

Por exemplo:

SELECT * FROM ConstituentAppeals WHERE ConstituentId='280'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável.
AppealCategoryDescription String A descrição da categoria de apelação.
AppealCategoryId String O ID de registro do sistema imutável da categoria de apelação.
AppealCategoryInactive Boolean Indica se a categoria de apelação está inativa.
AppealDescription String A descrição do recurso.
AppealId String O ID de registro do sistema imutável da apelação.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte ao qual a apelação está associada.
Date Datetime A data em que o recurso foi adicionado.
PackageDescription String A descrição do pacote.
PackageId String O ID do pacote.

ConstituinteAnexos

Retorna uma lista de anexos para um constituinte.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: ConstituentId é necessário para consultar ConstituentAttachments.

  • ConstituentId suporta o = operador.

Por exemplo:

SELECT * FROM ConstituentAttachments WHERE ConstituentId = '280'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do anexo.
ConstituentId String O ID de registro do sistema imutável do constituinte associado ao anexo.
ContentType String O tipo de conteúdo.
Date Datetime A data do anexo.
FileId String O identificador do arquivo.
FileName String O nome do arquivo.
FileSize Integer O tamanho do arquivo em bytes.
Name String O nome do anexo.
ParentId String O ID de registro do sistema imutável do objeto pai.
Tags String As tags associadas ao anexo.
Type String O tipo de anexo.
Url String A URL do anexo.

Códigos Constituintes

Os códigos constituintes definem as afiliações de alto nível entre os constituintes e sua organização - como membro do conselho, fornecedor e voluntário - para fornecer contexto sobre o motivo pelo qual os constituintes estão no banco de dados

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • Id suporta o = operador.
  • ConstituentId suporta o = operador.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.
  • IncludeInactive suporta o = operador.

Por exemplo:

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
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do código constituinte.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado ao código do constituinte.
DateAdded Datetime A data em que o código constituinte foi criado.
DateModified Datetime A data em que o código constituinte foi modificado pela última vez.
Description String A descrição do código constituinte.
Inactive Boolean Este campo calculado indica que o código constituinte está ativo se a data atual for após qualquer data de início e antes de qualquer data de término.
StartD Integer O dia de início do código constituinte.
StartM Integer O mês de início do código constituinte.
StartY Integer O ano de início do código constituinte.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean

Consentimentos Constituintes

Retorna uma lista de registros de consentimento do constituinte.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: ConstituentId é necessário para consultar ConstituentConsents.

  • ConstituentId suporta o = operador.
  • Category suporta os operadores '=,in'.
  • Channel suporta os operadores '=,in'.
  • MostRecentOnly suporta o = operador.

Por exemplo:

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')
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do registro de consentimento.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte ao qual o consentimento está associado.
Category String A categoria à qual a resposta de consentimento se aplica.
Channel String O canal ao qual a resposta de consentimento se aplica.
ConsentDate Datetime A data em que a resposta de consentimento foi recebida.
ConsentStatement String A declaração à qual o constituinte respondeu ao fornecer o consentimento.
ConstituentConsentResponse String Como o constituinte respondeu ao consentimento para o canal/categoria especificado.
DateAdded Datetime A data em que a resposta de consentimento foi adicionada.
PrivacyNotice String O aviso de privacidade fornecido ao constituinte.
Source String A fonte da resposta de consentimento do constituinte.
UserName String O usuário que adicionou a resposta de consentimento.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
MostRecentOnly Boolean

Atribuições de Arrecadação de Fundos Constituintes

Retorna uma lista de atribuições de arrecadação de fundos para um constituinte.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: ConstituentId é necessário para consultar ConstituentFundraiserAssignments.

  • ConstituentId suporta o = operador.
  • IncludeInactive suporta o = operador.

Por exemplo:

SELECT * FROM ConstituentFundraiserAssignments WHERE ConstituentId = '280'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável da atribuição de arrecadação de fundos.
AmountValue Double O valor da meta para a arrecadação de fundos solicitar do constituinte designado.
AppealId String Apelos de arrecadação de fundos.ID O ID de registro do sistema imutável do apelo que o arrecadador de fundos deve usar para solicitar presentes.
CampaignId String Campanhas.ID O ID de registro do sistema imutável da campanha para aplicar os presentes resultantes.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte ao qual aplicar os presentes resultantes.
End Datetime A data de término da atribuição da campanha de arrecadação de fundos.
FundId String Fundos.ID O ID de registro do sistema imutável do fundo ao qual quaisquer presentes resultantes devem ser aplicados.
FundraiserId String O ID de registro do sistema imutável da arrecadação de fundos.
Start Datetime A data de início da atribuição da campanha de arrecadação de fundos.
Type String O tipo de arrecadação de fundos.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean

Constituintes

Retorna uma lista paginada de constituintes

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • Id suporta os operadores '=,in'.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.
  • FundraiserStatus suporta os operadores '=,in'.
  • ConstituentCode suporta o = operador.
  • CustomFieldCategory suporta o = operador.
  • Fields suporta os operadores '=,in'.
  • IncludeDeceased suporta o = operador.
  • ListId suporta o = operador.
  • IncludeInactive suporta o = operador.
  • PostalCode suporta os operadores '=,in'.

Por exemplo:

SELECT * FROM Constituents WHERE Id = '280'

SELECT * FROM Constituents WHERE ListId = '75e71c26-7288-49db-a767-f9305b704fee'

SELECT * FROM Constituents WHERE FundraiserStatus IN ('Active', 'None')
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável para o constituinte.
AddressLines String As linhas de endereço.
AddressCity String A cidade do endereço.
AddressConstituentId String O ID de registro do sistema imutável do constituinte associado ao endereço.
AddressCountry String O país do endereço.
AddressCounty String O condado do endereço.
AddressDateAdded Datetime A data em que o endereço foi criado.
AddressDateModified Datetime A data em que o endereço foi modificado pela última vez.
AddressDoNotMail Boolean Indica se o constituinte solicita não ser contactado neste endereço.
AddressEnd Datetime A data em que o constituinte deixou de residir neste endereço.
AddressFormattedAddress String Este campo calculado recupera o endereço formatado no formato configurado do país.
AddressId String O ID de registro do sistema imutável do endereço.
AddressInactive Boolean Este campo calculado indica que o endereço está ativo se a data atual for anterior a qualquer data final.
AddressPostalCode String O código postal do endereço.
AddressPreferred Boolean Indica se este é o endereço preferencial do constituinte.
AddressSeasonalEndD Integer O dia do ano deixa de residir neste endereço.
AddressSeasonalEndM Integer O mês do ano deixa de residir neste endereço.
AddressSeasonalEndY Integer O ano deixa de residir neste endereço.
AddressSeasonalStartD Integer O dia do ano em que o constituinte começa a residir neste endereço.
AddressSeasonalStartM Integer O mês do ano em que o constituinte começa a residir neste endereço.
AddressSeasonalStarty Integer O ano em que o constituinte passa a residir neste endereço.
AddressStart Date A data em que o constituinte começou a residir neste endereço.
AddressState String O estado do endereço.
AddressSuburb String Bairro do endereço.
AddressType String O tipo de endereço.
Age Integer Esse campo calculado calcula a idade do constituinte com base na propriedade da data de nascimento.
BirthdateD Integer Dia de nascimento do constituinte.
BirthdateM Integer O mês de nascimento do constituinte.
BirthdateY Integer Ano de nascimento do constituinte.
DateAdded Datetime A data em que o constituinte foi criado.
DateModified Datetime A data em que o constituinte foi modificado pela última vez.
Deceased String Indica se o constituinte é falecido.
DeceasedDateD Integer O dia do ano em que o constituinte morreu.
DeceasedDateM Integer O mês do ano em que o constituinte faleceu.
DeceasedDateY Integer O ano em que o constituinte morreu.
EmailAddress String O endereço e-mail.
EmailConstituentId String O ID de registro do sistema imutável do constituinte associado ao endereço e-mail.
EmailDateAdded Datetime A data em que o endereço e-mail foi criado.
EmailDateModified Datetime A data em que o endereço e-mail foi modificado pela última vez.
EmailDoNotEmail Boolean Indica se o constituinte solicita não ser contatado neste endereço e-mail.
EmailId String O ID de registro do sistema imutável do endereço e-mail.
EmailInactive Boolean Indica se o endereço e-mail está inativo.
EmailPrimary Boolean Indica se este é o endereço e-mail principal do constituinte.
EmailType String O tipo de endereço e-mail. Os valores disponíveis são as entradas na tabela Tipos de telefone.
First String O primeiro nome do constituinte.
FormerName String O antigo nome do constituinte.
FundraiserStatus String Indica se o constituinte é um arrecadador de fundos.
Gender String O sexo do constituinte.
GivesAnonymously Boolean Indica se o constituinte doa anonimamente.
Inactive Boolean Indica se o constituinte está inativo.
Last String O sobrenome do constituinte.
LookupId String O identificador definido pelo usuário para o constituinte.
MaritalStatus String Estado civil do constituinte.
Middle String O nome do meio do constituinte.
Name String Se o tipo do constituinte for Individual, este é o nome completo do constituinte. Se o tipo for Organização, este é o nome da organização.
OnlinePresenceAddress String O endereço da web para a presença online.
OnlinePresenceConstituentId String O ID de registro do sistema imutável do constituinte associado à presença online.
OnlinePresenceDateAdded Datetime A data em que a presença online foi criada.
OnlinePresenceDateModified Datetime A data em que a presença online foi modificada pela última vez.
OnlinePresenceId String O ID de registro do sistema imutável da presença online.
OnlinePresenceInactive Boolean Indica se a presença online está inativa.
OnlinePresencePrimary Boolean Indica se esta é a principal presença online do constituinte.
OnlinePresenceType String O tipo de presença online.
PhoneConstituentId String O ID de registro do sistema imutável do constituinte associado ao telefone.
PhoneDateAdded Datetime A data em que o telefone foi criado.
PhoneDateModified Datetime A data em que o telefone foi modificado pela última vez.
PhoneDoNotCall Boolean Indica se o constituinte solicita não ser contactado neste número.
PhoneId String O ID de registro do sistema imutável do telefone.
PhoneInactive Boolean Indica se o telefone está inativo.
PhoneNumber String O numero do telefone.
PhonePrimary Boolean Indica se este é o telefone principal do constituinte.
PhoneType String O tipo de telefone.
PreferredName String O nome preferido do constituinte.
SpouseFirst String Este campo calculado recupera informações sobre o cônjuge do constituinte usando os relacionamentos do constituinte.
SpouseId String Este campo calculado recupera informações sobre o cônjuge do constituinte usando os relacionamentos do constituinte.
SpouseLast String Este campo calculado recupera informações sobre o cônjuge do constituinte usando os relacionamentos do constituinte.
Suffix String O sufixo principal do constituinte.
Suffix2 String O sufixo secundário do constituinte.
Title String O título principal do constituinte.
Title2 String O título secundário do constituinte.
Type String O tipo de constituinte.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
ConstituentCode String
CustomFieldCategory String
Fields String
IncludeDeceased Boolean
IncludeInactive Boolean
ListId String
PostalCode String

ConstituintesCampos Personalizados

Recupera campos personalizados para todos os constituintes

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

Colunas
Nome Tipo Referências Descrição
Id String O ID de registro do sistema imutável do campo personalizado.
ConstituentId String O ID de registro do sistema imutável do objeto pai.
Name String A categoria de campo personalizado.
Value String O valor do campo personalizado.
Comment String O comentário no campo personalizado.
DateAdded Datetime A data em que o campo personalizado foi criado.
DateModified Datetime A data em que o campo personalizado foi modificado pela última vez.
Type String O tipo de dados que o campo personalizado representa.

ConstituentSolicitCodes

Retorna uma lista de códigos de solicitação para o constituinte especificado.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: ConstituentId é necessário para consultar ConstituentSolicitCodes.

  • ConstituentId suporta o = operador.

Por exemplo:

SELECT * FROM ConstituentSolicitCodes WHERE ConstituentId = '280'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do código de solicitação constituinte.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado ao código de solicitação.
EndDate Datetime A data final do código de solicitação.
SolicitCode String Instruções de comunicação e/ou restrições para um constituinte.
StartDate Datetime A data de início do código de solicitação.

Países

Retorna a lista de países disponíveis.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do país.
Abbreviation String A abreviação definida pelo usuário para o país.
Name String O nome do país.

Educação

Retorna uma lista de educações para todos os constituintes ou um constituinte especificado

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • Id suporta o = operador.
  • ConstituentId suporta o = operador.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.

Por exemplo:

SELECT * FROM Educations WHERE ConstituentId = '280'

SELECT * FROM Educations WHERE DateAdded >= '2010-06-01 14:03:35'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável da educação.
Campus String O campus.
ClassOf String O ano em que o constituinte se formou.
ClassOfDegree String A classe de grau.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado à educação.
DateAdded Datetime A data em que a educação foi criada.
DateEnteredD Integer O primeiro dia de atendimento.
DateEnteredM Integer O primeiro mês de atendimento.
DateEnteredY Integer O primeiro ano de atendimento.
DateGraduatedD Integer O dia da formatura.
DateGraduatedM Integer O mês da formatura.
DateGraduatedY Integer O ano da formatura.
DateLeftD Integer Último dia de atendimento.
DateLeftM Integer O último mês de atendimento.
DateLeftY Integer O último ano de atendimento.
DateModified Datetime A data em que a educação foi modificada pela última vez.
Degree String O grau recebido.
Department String O nome do departamento de educação.
Faculty String O nome da faculdade.
Gpa Double A média de notas.
KnownName String O nome conhecido.
Majors String Os principais cursos de estudo.
Minors String Os cursos menores de estudo.
Primary Boolean Indica se esta é a associação de escola primária do constituinte.
RegistrationNumber String O número de registro.
School String O nome da escola.
SocialOrganization String A organização social.
Status String A situação da educação.
SubjectOfStudy String O objeto de estudo.
Type String O tipo de educação.

E-mails

Retorna uma lista de endereços e-mail de todos os constituintes ou de um constituinte especificado

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • ConstituentId suporta os operadores '=,in'.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.
  • IncludeInactive suporta o operador "=".

Por exemplo:

SELECT * FROM Emails WHERE ConstituentId = '280'

SELECT * FROM Emails WHERE DateAdded >= '2010-06-01 14:03:35'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do endereço e-mail.
Address String O endereço e-mail.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado ao endereço e-mail.
DateAdded Datetime A data em que o endereço e-mail foi criado.
DateModified Datetime A data em que o endereço e-mail foi modificado pela última vez.
DoNotEmail Boolean Indica se o constituinte solicita não ser contatado neste endereço e-mail.
Inactive Boolean Indica se o endereço e-mail está inativo.
Primary Boolean Indica se este é o endereço e-mail principal do constituinte.
Type String O tipo de endereço e-mail.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean

EventCategories

Retorna uma lista de categorias de eventos ativos.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • IncludeInactive suporta o = operador.

Por exemplo:

SELECT * FROM EventCategories WHERE IncludeInactive = true
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID da categoria do evento.
Inactive Boolean Se a categoria está inativa. Verdadeiro se inativo.
Name String O nome da categoria do evento.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean

Taxas de Evento

Retorna uma lista de taxas para um evento.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: EventId é necessário para consultar EventFees.

  • EventId suporta o = operador.

Por exemplo:

SELECT * FROM EventFees WHERE EventId = '2'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID da taxa do evento.
ContributionAmount Double O valor dedutível do imposto para essa taxa.
Cost Double O custo da taxa.
EventId String Eventos.ID O ID do evento ao qual a taxa está vinculada.
Name String O nome da taxa do evento.
NumberSold Integer O número de taxas vendidas.

Participantes do EventoConvidados

Informações resumidas básicas do participante

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: EventId é necessário para consultar EventParticipantGuests.

  • EventId suporta o = operador.

Por exemplo:

SELECT * FROM EventParticipantGuests WHERE EventId = '2'
Colunas
Nome Tipo Referências Descrição
ContactId String A ID do contato que está participando do evento.
EventId String Eventos.ID O ID do evento ao qual o participante pertence.
Name String Nome completo do participante.
ParticipantId String O ID do participante.

Associação de Participantes do Evento

A categoria de associação do indivíduo

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: EventId é necessário para consultar EventParticipantMemberships.

  • EventId suporta o = operador.

Por exemplo:

SELECT * FROM EventParticipantMemberships WHERE EventId = '2'
Colunas
Nome Tipo Referências Descrição
CategoryId String O ID da categoria de associação.
CategoryName String O nome da categoria de associação.
EventId String Eventos.ID O ID do evento ao qual o participante pertence.

EventParticipantOptions

Retorna as opções do participante para um evento.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: EventId é necessário para consultar EventParticipantOptions.

  • EventId suporta o = operador.

Por exemplo:

SELECT * FROM EventParticipantOptions WHERE EventId = '2'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String A ID da opção do participante do evento.
EventId String Eventos.ID O ID do evento ao qual o participante pertence.
AddedByService String O ID do serviço que adicionou esta opção.
AddedByUser String O ID do usuário que incluiu esta opção.
DateAdded Datetime A data em que esta opção foi adicionada.
DateUpdated Datetime A data em que esta opção foi atualizada.
InputType String Os tipos disponíveis de opções de participantes do evento.
ListOptions String Uma opção de lista de opções do participante do evento.
MultiSelect Boolean Válido apenas para o tipo de entrada Lista, determina se várias opções podem ser selecionadas.
Name String O nome da opção do participante do evento.
ParticipantId String O ID do participante.
UpdatedByService String O ID do serviço que atualizou esta opção.
UpdatedByUser String O ID do usuário que atualizou esta opção.
Version Integer O número da versão da opção.

Participantes do Evento

Retorna uma lista de participantes de um evento.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: EventId é necessário para consultar EventParticipants.

  • Attended suporta o = operador.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.
  • EventId suporta o = operador.
  • InvitationStatus suporta o = operador.
  • IsConstituent suporta o = operador.
  • ParticipationLevelName suporta os operadores '=,in'.
  • RsvpStatus suporta os operadores '=,in'.
  • EmailEligible suporta o = operador.
  • PhoneCallEligible suporta o = operador.
  • FeesPaid suporta o = operador.
  • Fields suporta o = operador.

Por exemplo:

SELECT * FROM EventParticipants WHERE EventId = '2'

SELECT * FROM EventParticipants WHERE EventId = '2' AND DateAdded >= '2010-06-01 14:03:35'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID do participante.
Attended Boolean Se o participante participou do evento.
ClassOf String A turma de formandos do participante.
ContactId String A ID do contato que está participando do evento.
DateAdded Datetime A data em que o participante foi criado.
DateModified Datetime A data em que o participante foi modificado pela última vez.
DoNotCall Boolean A preferência de chamada telefônica do participante.
DoNotEmail Boolean A preferência e-mail do participante.
Email String O endereço e-mail do participante.
EventId String Eventos.ID O ID do evento ao qual o participante pertence.
FirstName String O primeiro nome do participante.
FormerName String O nome anterior do participante.
HostContactId String A ID do contato que está participando do evento.
HostName String Nome completo do participante.
HostParticipantId String O ID do participante hospedar.
InvitationStatus String Os estados possíveis para o convite de um constituinte para um evento.
IsConstituent Boolean Indica se o participante é um constituinte.
LastName String O sobrenome do participante.
LookupId String O LookupId do participante.
MiddleName String O nome do meio do participante.
Name String Nome completo do participante.
NameTag String A etiqueta de nome do participante.
ParticipationLevelId String O ID do nível de participação.
ParticipationLevelIsInactive Boolean Se o nível de participação está inativo. Verdadeiro se inativo.
ParticipationLevelName String O nome do nível de participação.
Phone String O número de telefone do participante.
PreferredName String O nome preferido do participante.
RsvpDateD Integer O dia na data difusa.
RsvpDateM Integer O mês na data difusa.
RsvpDateY Integer O ano na data imprecisa.
RsvpStatus String Os estados possíveis para o RSVP de um participante para um evento.
Seat String A atribuição de assento para o participante.
Suffix String O sufixo do participante.
Title String O título do participante.
TotalPaid Integer A soma dos brindes pagos pelo participante com um tipo de Taxa de Inscrição.
TotalRegistrationFees Integer A soma dos valores das taxas do participante.
SummaryNote String notas resumidas.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
EmailEligible Boolean
PhoneCallEligible Boolean
FeesPaid Boolean
Fields String

Eventos

Retorna uma lista de eventos

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • Id suporta o = operador.
  • CategoryName suporta o = operador.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.
  • Name suporta o = operador.
  • StartDate suporta os operadores '>=,<='.
  • IncludeInactive suporta o = operador.
  • Fields suporta o = operador.

Por exemplo:

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'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID do evento.
AttendedCount Integer O número de participantes do evento.
AttendingCount Integer O número de participantes do evento que planejam participar.
CampaignId String O ID da campanha afiliada ao evento.
Capacity Integer O número de pessoas que podem participar do evento.
CategoryId String O ID da categoria do evento.
CategoryInactive Boolean Se a categoria está inativa.
CategoryName String O nome da categoria do evento.
DateAdded Datetime A data em que o evento foi criado.
DateModified Datetime A data em que o evento foi modificado pela última vez.
EndDate Datetime A data final do evento.
EndTime String A hora de término do evento.
FundId String O ID do fundo afiliado ao evento.
Goal Double O objetivo monetário do evento.
Inactive Boolean Se o evento está inativo.
InvitedCount Integer O número de convidados do evento.
LocationName String O nome do local.
LocationAddressLines String As linhas de endereço do local.
LocationPostalCode String O código postal do local.
LocationLocalityId String O ID de registro do registro de localidade.
LocationLocalityName String O nome da localidade.
LocationAdministrativeAreaId String O ID do registro da área administrativa.
LocationAdministrativeAreaName String O nome da área administrativa.
LocationAdministrativeAreaShortDesc String A breve descrição da área administrativa.
LocationSubAdministrativeAreaId String O ID da área subadministrativa.
LocationSubAdministrativeAreaName String O nome da área subadministrativa.
LocationCountryId String A ID do registro do país.
LocationCountryDisplayName String O nome de exibição do país.
LocationCountryIsoAlpha2Code String O código alfa-2 ISO 3166-1 para o país.
LocationFormattedAddress String O endereço formatado do local.
LookupId String O ID de pesquisa do evento.
Name String O nome do evento.
StartDate Date A data de início do evento.
StartTime String A hora de início do evento.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
Fields String
IncludeInactive Boolean

FundoAnexos

Retorna uma lista de anexos para um fundo.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: FundId é necessário para consultar FundAttachments.

  • FundId suporta o = operador.

Por exemplo:

SELECT * FROM FundAttachments WHERE FundId = '4'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do anexo.
FundId String Fundos.ID O ID de registro do sistema imutável do fundo.
ContentType String O tipo de conteúdo. Apenas para anexos físicos.
Date Datetime A data do anexo.
FileId String O identificador do arquivo.
FileName String O nome do arquivo.
FileSize Integer O tamanho do arquivo em bytes.
Name String O nome do anexo.
ParentId String O ID de registro do sistema imutável do objeto pai.
Tags String As tags associadas ao anexo.
ThumbnailId String O identificador da miniatura.
ThumbnailUrl String O URL de uma miniatura.
Type String O tipo de anexo.
Url String A URL do anexo.

Atribuições de Arrecadação de Fundos

Retorna uma lista de atribuições para uma campanha de arrecadação de fundos.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: FundraiserId é necessário para consultar FundraiserAssignments.

  • FundraiserId suporta o = operador.

Por exemplo:

SELECT * FROM FundraiserAssignments WHERE FundraiserId = '4'
Colunas
Nome Tipo Referências Descrição
Id String O ID de registro do sistema imutável da atribuição fornecida.
AmountValue Double O valor da meta para a arrecadação de fundos solicitar do constituinte designado.
AppealId String Apelos de arrecadação de fundos.ID O ID de registro do sistema imutável do apelo que o arrecadador de fundos deve usar para solicitar presentes.
CampaignId String Campanhas.ID O ID de registro do sistema imutável da campanha para aplicar os presentes resultantes.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte de destino.
End Datetime A data de término da campanha de arrecadação de fundos.
FundId String Fundos.ID O ID de registro do sistema imutável do fundo ao qual quaisquer presentes resultantes devem ser aplicados.
FundraiserId String O ID de registro do sistema imutável da arrecadação de fundos atribuído ao constituinte.
Start Date A data de início da campanha de arrecadação de fundos.
Type String O tipo de arrecadação de fundos.

Objetivos da Arrecadação de Fundos

Retorna uma lista de metas para uma campanha de arrecadação de fundos

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: FundraiserId é necessário para consultar FundraiserGoals.

  • FundraiserId suporta o = operador.

Por exemplo:

SELECT * FROM FundraiserGoals WHERE FundraiserId = '4'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável da meta da campanha de arrecadação de fundos.
AmountValue Double O valor da meta da campanha de arrecadação de fundos.
AppealId String Apelos de arrecadação de fundos.ID O ID de registro do sistema imutável da apelação associado à meta de arrecadação de fundos.
CampaignId String Campanhas.ID O ID de registro do sistema imutável da campanha associada à meta de arrecadação de fundos.
FundId String Fundos.ID O ID de registro do sistema imutável do fundo associado à meta da campanha de arrecadação de fundos.
FundraiserId String O ID de registro do sistema imutável da campanha de arrecadação de fundos associada à meta da campanha de arrecadação de fundos.
Type String O tipo de objetivo da campanha de arrecadação de fundos. Os valores disponíveis são Campaign, Fund, UnspecifiedCategory e Appeal.
UnspecifiedCategoryName String O nome da categoria não especificada para a meta da campanha de arrecadação de fundos.

Apelos de Arrecadação de Fundos

Retorna uma lista de apelos de arrecadação de fundos.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • Id suporta os operadores '=,in'.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.
  • IncludeInactive suporta o = operador.

Por exemplo:

SELECT * FROM FundraisingAppeals WHERE Id = '4'

SELECT * FROM FundraisingAppeals WHERE IncludeInactive = true
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável da apelação.
Category String A categoria do recurso.
DateAdded Datetime A data em que a apelação foi criada.
DateModified Datetime A data em que a apelação foi modificada pela última vez.
Description String O nome de exibição da apelação.
EndDate Datetime A data final do recurso.
GoalValue Double A meta monetária associada à apelação.
Inactive Boolean Este campo calculado indica que a apelação está ativa se a data atual for após qualquer start_date e antes de qualquer end_date.
LookupId String O identificador definido pelo usuário para a apelação.
StartDate Datetime A data de início do recurso.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean

Fundos

Retorna uma lista de fundos.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • Id suporta os operadores '=,in'.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.
  • IncludeInactive suporta o = operador.

Por exemplo:

SELECT * FROM Funds WHERE Id = '4'

SELECT * FROM Funds WHERE IncludeInactive = true
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do fundo.
Category String A categoria do fundo.
DateAdded Datetime A data em que o fundo foi criado.
DateModified Datetime A data em que o fundo foi modificado pela última vez.
Description String O nome de exibição do fundo.
EndDate Datetime A data final do fundo.
GoalValue Double A meta monetária associada ao fundo.
Inactive Boolean Este campo calculado indica que o fundo está ativo se a data atual for posterior a qualquer start_date e antes de qualquer end_date.
LookupId String O identificador definido pelo usuário para o fundo.
StartDate Datetime A data de início do fundo.
Type String O tipo do fundo.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean

Reconhecimentos de Presentes

Retorna uma lista de agradecimentos por um presente

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Nota: GiftId são necessários para consultar GiftAcknowledgements.

  • GiftId suporta o = operador.

Por exemplo:

SELECT * FROM GiftAcknowledgements WHERE GiftId = '476'
Colunas
Nome Tipo Referências Descrição
GiftId String Presentes.ID O ID de registro do sistema imutável do presente associado ao reconhecimento.
Date Datetime A data associada ao reconhecimento.
Letter String A carta associada ao reconhecimento.
Status String O status do reconhecimento. Os valores disponíveis são: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT e DONOTACKNOWLEDGE.

PresenteAnexos

Retorna uma lista de anexos para um presente.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Nota: GiftId são necessários para consultar GiftAttachments.

  • GiftId suporta o = operador.

Por exemplo:

SELECT * FROM GiftAttachments WHERE GiftId = '476'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do anexo.
GiftId String Presentes.ID O ID de registro do sistema imutável do presente ao qual os anexos estão associados.
ContentType String O tipo de conteúdo. Apenas para anexos físicos.
Date Datetime A data do anexo.
FileId String O identificador do arquivo.
FileName String O nome do arquivo.
FileSize Integer O tamanho do arquivo em bytes.
Name String O nome do anexo.
ParentId String O ID de registro do sistema imutável do objeto pai.
Tags String As tags associadas ao anexo.
ThumbnailId String O identificador da miniatura.
ThumbnailUrl String O URL de uma miniatura.
Type String O tipo de anexo.
Url String A URL do anexo.

GiftBatches

Retorna uma lista de lotes de presentes.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • BatchNumber suporta o = operador.
  • CreatedBy suporta o = operador.
  • HasExceptions suporta o = operador.
  • IsApproved suporta o = operador.
  • SearchText suporta o = operador.
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O identificador do lote.
ActualAmount Integer A quantidade real do lote.
BatchDescription String A descrição do lote.
BatchNumber String O número do lote.
CreatedBy String Criado pelo nome de usuário.
AddedBy String Adicionado pelo nome de usuário.
CreatedOn Datetime A data em que o lote foi criado.
DateAdded Datetime A data em que o lote foi adicionado.
HasExceptions Boolean O possui exceções booleanas.
IsApproved Boolean Booleano aprovado.
Approved Boolean Booleano aprovado.
NumberOfGifts Integer O número de presentes no lote.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
SearchText String

Pagamentos de Presentes

Devolve pagamentos de um presente.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Nota: GiftId são necessários para consultar GiftPayments.

  • GiftId suporta o = operador.

Por exemplo:

SELECT * FROM GiftPayments WHERE GiftId = '476'
Colunas
Nome Tipo Referências Descrição
GiftId String Presentes.ID O ID de registro do sistema imutável do presente associado ao pagamento.
AccountToken String As informações de conta tokenizadas (por exemplo, cartão de crédito) do provedor de pagamento externo. Aplica-se apenas aos métodos de pagamento CreditCard e DirectDebit.
BbpsConfigurationId String O ID de configuração de bbps. Aplica-se apenas aos métodos de pagamento CreditCard e DirectDebit.
BbpsTransactionId String O ID da transação bbps. Aplica-se apenas aos métodos de pagamento CreditCard e DirectDebit.
CheckDateD String O dia da data do cheque. Aplica-se apenas ao método de pagamento do PersonalCheck.
CheckDateM String O mês da data do cheque. Aplica-se apenas ao método de pagamento do PersonalCheck.
CheckDateY String O ano da data do cheque. Aplica-se apenas ao método de pagamento do PersonalCheck.
CheckNumber String O número do cheque. Aplica-se apenas ao método de pagamento do PersonalCheck.
CheckoutTransactionId String O ID da transação de finalização da compra. Aplica-se apenas aos métodos de pagamento CreditCard e DirectDebit.
PaymentMethod String O método de pagamento.
Reference String A referência.
ReferenceDateD String O dia da data de referência.
ReferenceDateM String O mês da data de referência.
ReferenceDateY String O ano da data de referência.

Recibos de Presente

Devolve recibos de um presente.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Nota: GiftId são necessários para consultar GiftReceipts.

  • GiftId suporta o = operador.

Por exemplo:

SELECT * FROM GiftReceipts WHERE GiftId = '476'
Colunas
Nome Tipo Referências Descrição
GiftId String Presentes.ID O ID de registro do sistema imutável do presente associado ao recibo.
AmountValue Integer O valor do recibo.
Date Datetime A data no recibo.
Number Integer O número do recibo.
Status String O status do recibo. Os valores disponíveis são: RECEIPTED, NEEDSRECEIPT e DONOTRECEIPT.

Presentes

Retorna uma lista paginada de presentes

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • Id suporta o = operador.
  • ConstituentId suporta os operadores '=,in'.
  • Date suporta os operadores '>=,<='.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.
  • PostStatus suporta os operadores '=,in'.
  • Type suporta o = operador.
  • ListId suporta o = operador.
  • AppealId suporta os operadores '=,in'.
  • FundId suporta os operadores '=,in'.
  • CampaignId suporta os operadores '=,in'.
  • AcknowledgmentStatus suporta os operadores '=,in'.
  • ReceiptStaus suporta os operadores '=,in'.

Por exemplo:

SELECT * FROM Gifts WHERE ConstituentId IN ('280', '281')

SELECT * FROM Gifts WHERE PostStatus = 'Posted'

SELECT * FROM Gifts WHERE Type IN ('Pledge', 'GiftInKind')
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do presente.
AmountValue Double O valor monetário do presente.
BalanceValue Double O saldo restante no presente.
BatchNumber String O número do lote associado a este presente.
Constituency String O eleitorado do presente.
ConstituentId String O ID de registro do sistema imutável do constituinte associado ao presente.
Date Date A data do presente.
DateAdded Datetime A data em que o presente foi criado.
DateModified Datetime A data em que o presente foi modificado pela última vez.
GiftAidAmountValue Double Este campo calculado calcula o valor total qualificado do imposto recuperado do Gift Aid em todos os gift_splits para este presente.
GiftAidQualificationStatus String Este campo calculado determina o status de qualificação do Gift Aid com base nas informações da declaração de impostos e no formato do banco de dados. Os valores disponíveis são: Qualified, NotQualified e PartlyQualified. Apenas para o Reino Unido.
GiftStatus String O status do presente. Os valores disponíveis são Active, Held, Terminated, Completed e Cancelled.
IsAnonymous Bool Indica se o presente é anônimo.
LinkedGifts String Os identificadores de outros presentes vinculados a este presente.
LookupId String O identificador definido pelo usuário para o presente.
Origin String A origem do presente.
PostDate Datetime A data em que o presente foi postado no razão geral.
PostStatus String O status da publicação contábil geral do presente.
RecurringGiftStatusDateD Integer A data em que o status do presente foi modificado pela última vez.
RecurringGiftStatusDateM Integer A data em que o status do presente foi modificado pela última vez.
RecurringGiftStatusDateY Integer A data em que o status do presente foi modificado pela última vez.
Reference String Notas para rastrear detalhes especiais sobre um presente, como a motivação por trás dele ou uma descrição detalhada de um presente em espécie.
Subtype String O subtipo do dom.
Type String O tipo de presente.
GiftCode String O código do presente.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
ListId String
AppealId String
FundId String
CampaignId String
AcknowledgmentStatus String
ReceiptStaus String

PresentesCampos Personalizados

Recupera campos personalizados para todos os presentes

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

Colunas
Nome Tipo Referências Descrição
Id String O ID de registro do sistema imutável do campo personalizado.
GiftId String O ID de registro do sistema imutável do objeto pai.
Name String A categoria de campo personalizado.
Value String O valor do campo personalizado.
Comment String O comentário no campo personalizado.
DateAdded Datetime A data em que o campo personalizado foi criado.
DateModified Datetime A data em que o campo personalizado foi modificado pela última vez.
Type String O tipo de dados que o campo personalizado representa.

GiftSoftCréditos

Retorna soft credits para um presente.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Nota: GiftId são necessários para consultar GiftSoftCredits.

  • GiftId suporta o = operador.

Por exemplo:

SELECT * FROM GiftSoftCredits WHERE GiftId = '476'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do crédito suave.
AmountValue Double O valor do crédito bonificado.
ConstituentId String O ID de registro do sistema imutável do constituinte associado ao crédito suave.
GiftId String Presentes.ID O ID de registro do sistema imutável do presente associado ao crédito suave.

GiftSplits

Retorna as divisões para um presente.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Nota: GiftId são necessários para consultar GiftSplits.

  • GiftId suporta o = operador.

Por exemplo:

SELECT * FROM GiftSplits WHERE GiftId = '476'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável da divisão do presente.
GiftId String Presentes.ID O ID de registro do sistema imutável do presente associado à divisão do presente.
AmountValue Integer O valor da divisão do presente.
AppealId String O ID de registro do sistema imutável da apelação associada à divisão de presente.
CampaignId String O ID de registro do sistema imutável da campanha associada à divisão de presentes.
FundId String O ID de registro do sistema imutável do fundo associado à divisão do presente.
GiftAidAmount String O valor do imposto recuperado do auxílio-presente para esta divisão do presente. Apenas para o Reino Unido.
GiftAidQualificationStatus String O status de qualificação do auxílio-presente da divisão do presente. Os valores disponíveis são: Qualified e NotQualified. Apenas para o Reino Unido.
PackageId String O ID de registro do sistema imutável do pacote associado à divisão de presente.

Dando

Retorna o primeiro, o mais recente ou o maior presente registrado para um constituinte.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: ConstituentId e GivingSummaryType são necessários para consultar Giving.

  • ConstituentId suporta o = operador.
  • GivingSummaryType suporta o = operador.

Por exemplo:

SELECT * FROM Giving WHERE ConstituentId = '280' AND GivingSummaryType = 'greatest'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do presente.
AmountValue Double O valor do presente.
Date Date A data do presente.
Type String O tipo de presente.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado a esta doação.
GivingSummaryType String O tipo de resumo de fornecimento. Os valores disponíveis são Primeiro, Último e Maior. Os valores permitidos são primeiro, maior, último.

Doando Apelos

Retorna o resumo de apelações do constituinte

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: ConstituentId e GivingSummaryType são necessários para consultar GivingAppeals.

  • ConstituentId suporta o = operador.
  • GivingSummaryType suporta o = operador.

Por exemplo:

SELECT * FROM GivingAppeals WHERE ConstituentId = '280' AND GivingSummaryType = 'first'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável da apelação.
Description String A descrição.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado a esta doação.
GivingSummaryType String O tipo de resumo de fornecimento. Os valores disponíveis são Primeiro, Último e Maior. Os valores permitidos são primeiro, maior, último.

Campanhas de Doação

Retorna o resumo das campanhas de doação para o constituinte

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: ConstituentId e GivingSummaryType são necessários para consultar GivingCampaigns.

  • ConstituentId suporta o = operador.
  • GivingSummaryType suporta o = operador.

Por exemplo:

SELECT * FROM GivingCampaigns WHERE ConstituentId = '280' AND GivingSummaryType = 'greatest'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável da campanha.
Description String A descrição da campanha.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado a esta doação.
GivingSummaryType String O tipo de resumo de fornecimento. Os valores disponíveis são Primeiro, Último e Maior. Os valores permitidos são primeiro, maior, último.

GivingFunds

Retorna o resumo dos fundos de doação para o constituinte

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: ConstituentId e GivingSummaryType são necessários para consultar GivingFunds.

  • ConstituentId suporta o = operador.
  • GivingSummaryType suporta o = operador.

Por exemplo:

SELECT * FROM GivingFunds WHERE ConstituentId = '280' AND GivingSummaryType = 'latest'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do fundo.
Description String A descrição do fundo.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado a esta doação.
GivingSummaryType String O tipo de resumo de fornecimento. Os valores disponíveis são Primeiro, Último e Maior. Os valores permitidos são primeiro, maior, último.

LifetimeGiving

Retorna o tempo de vida dando informações para um constituinte.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Nota: ConstituentId são necessários para consultar LifetimeGiving.

  • ConstituentId suporta o = operador.

Por exemplo:

SELECT * FROM LifetimeGiving WHERE ConstituentId = '280'
Colunas
Nome Tipo Referências Descrição
ConsecutiveYearsGiven Integer Este campo computado calcula o número de anos consecutivos que o constituinte forneceu.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado à doação vitalícia.
TotalCommittedMatchingGiftsValue Double Este campo computado calcula o valor total de compromissos de doação correspondentes atribuídos ao constituinte.
TotalGivingValue Double Este campo computado calcula o valor total dado pelo constituinte.
TotalPledgeBalanceValue Double Este campo computado calcula o saldo do penhor não pago para o constituinte.
TotalReceivedGivingValue Double Este campo computado calcula o valor total recebido dado pelo constituinte.
TotalReceivedMatchingGiftsValue Double Este campo computado calcula o valor total de pagamentos para promessas de doações correspondentes atribuídas ao constituinte.
TotalSoftCreditsValue Double Este campo computado calcula a quantidade total de soft credits aplicados ao constituinte.
TotalYearsGiven Integer Este campo calculado calcula o número total de anos que o constituinte forneceu.

Listas

Retorna uma lista de listas para o tipo de lista fornecido

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • ListType suporta o = operador.

Por exemplo:

SELECT * FROM Lists WHERE ListType = 'Constituent'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável para a lista.
DateModified Datetime A data em que esta lista foi modificada pela última vez.
Description String A descrição da lista
IsPublic Boolean Indica se esta é uma lista pública ou privada.
LastModifiedByUserId String O ID do usuário que modificou a lista pela última vez.
LastModifiedByUserName String O nome do usuário que modificou a lista pela última vez.
Name String O nome da lista.
RecordCount Integer O número total de registros definidos por esta lista com base na última vez que esta lista foi salva.
ListType String Tipo da lista. Os valores permitidos são Constituinte, Gift, Action, Opportunity.

Membros

Retorna a lista de membros.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • ConstituentId suporta o = operador.

Por exemplo:

SELECT * FROM Members WHERE ConstituentId = '280'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do membro.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado ao membro.
Primary Boolean Indica se este é o membro principal da associação.

Associações

Retorna uma lista de associações.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • ConstituentId suporta o = operador.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.

Por exemplo:

SELECT * FROM Memberships WHERE ConstituentId = '280'

SELECT * FROM Memberships WHERE DateAdded >= '2010-06-01 14:03:35'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável da associação.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado à associação.
Category String A categoria de membros.
DateAdded Datetime A data em que a associação foi criada.
DateModified Datetime A data em que a associação foi modificada pela última vez.
DuesValue Integer As taxas de adesão.
Expires Datetime A data em que a associação expira.
Joined Datetime A data em que a associação se torna ativa.
Program String O programa de adesão.
Standing String O status de membro. Os valores disponíveis são New, Active, Lapsed e Dropped.
Subcategory String A subcategoria de membros.

Notas

Retorna uma lista de notas que rastreia detalhes úteis ou importantes, como interesses específicos e instruções especiais para doações

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • Id suporta o = operador.
  • ConstituentId suporta o = operador.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.

Por exemplo:

SELECT * FROM Notes WHERE ConstituentId='280'

SELECT * FROM Notes WHERE DateAdded >= '2010-06-01 14:03:35'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável da nota.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado à nota.
DateD Integer O dia da data da nota.
DateM Integer O mês da data da nota.
DateY Integer O ano da data da nota.
DateAdded Datetime A data em que a nota foi criada.
DateModified Datetime A data em que a nota foi modificada pela última vez.
Summary String O resumo da nota.
Text String O conteúdo da nota.
Type String O tipo de nota.

Presenças Online

Retorna uma lista paginada de presenças on-line que armazenam as contas de mídia social e sites de um constituinte.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • ConstituentId suporta o = operador.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.
  • IncludeInactive suporta o = operador.

Por exemplo:

SELECT * FROM OnlinePresences WHERE ConstituentId = '280'

SELECT * FROM OnlinePresences WHERE DateAdded >= '2010-06-01 14:03:35'

SELECT * FROM OnlinePresences WHERE IncludeInactive = true
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável da presença online.
Address String O endereço da web para a presença online.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado à presença online.
DateAdded Datetime A data em que a presença online foi criada.
DateModified Datetime A data em que a presença online foi modificada pela última vez.
Inactive Boolean Indica se a presença online está inativa.
Primary Boolean Indica se esta é a principal presença online do constituinte.
Type String O tipo de presença online.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean

Oportunidades

Recupera uma lista de oportunidades

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • Id suporta o = operador.
  • ConstituentId suporta os operadores '=,in'.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.
  • IncludeInactive suporta o = operador.

Por exemplo:

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'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável da oportunidade.
AskAmountValue Double O valor monetário solicitado do cliente em potencial para a oportunidade.
AskDate Date A data em que a solicitação foi feita.
CampaignId String Campanhas.ID O ID de registro do sistema imutável da campanha associada à oportunidade. A campanha define os objetivos gerais para arrecadar dinheiro.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado à oportunidade.
DateAdded Datetime A data em que a oportunidade foi criada.
DateModified Datetime A data em que a oportunidade foi modificada pela última vez.
Deadline Datetime A data-alvo para a oportunidade resultar em um presente.
ExpectedAmountValue Double A quantia monetária que é realisticamente esperada como resultado da oportunidade.
ExpectedDate Datetime A data em que se espera que o cliente potencial dê em resposta à oportunidade.
FundId String Fundos.ID O ID de registro do sistema imutável do fundo associado à oportunidade.
FundedAmountValue Double A quantia monetária que o cliente em potencial deu em resposta à oportunidade.
FundedDate Datetime A data em que o cliente em potencial deu em resposta à oportunidade.
Fundraisers String Os constituintes da arrecadação de fundos interagem com outros constituintes e clientes em potencial em nome de sua organização para cultivar relacionamentos e promover oportunidades para garantir doações importantes.
Inactive Boolean Indica se a oportunidade está inativa.
LinkedGifts String O sistema imutável registra IDs dos presentes relacionados à oportunidade.
Name String O nome que identifica a oportunidade em todo o programa, como em listas ou registros constituintes.
Purpose String O uso pretendido para qualquer dinheiro arrecadado como resultado da oportunidade.
Status String O status que indica onde a oportunidade está no processo de solicitação.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean
ListId String

OportunidadesCampos Personalizados

Recupera campos personalizados para uma oportunidade

Colunas
Nome Tipo Referências Descrição
Id String O ID de registro do sistema imutável do campo personalizado.
OpportunityId String O ID de registro do sistema imutável do objeto pai.
Name String A categoria de campo personalizado.
Value String O valor do campo personalizado.
Date Datetime A data em que o campo personalizado foi criado.
DateAdded Datetime A data em que o campo personalizado foi adicionado.
DateModified Datetime A data em que o campo personalizado foi modificado pela última vez.
Type String O tipo de dados que o campo personalizado representa.

OportunidadeAnexos

Retorna uma lista de anexos para uma oportunidade

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: OpportunityId é necessário para consultar OpportunityAttachments.

  • OpportunityId suporta o = operador.

Por exemplo:

SELECT * FROM OpportunityAttachments WHERE OpportunityId = '4'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do anexo.
OpportunityId String Oportunidades.ID O ID da oportunidade.
Content_type String O tipo de conteúdo. Apenas para anexos físicos.
Date Datetime A data do anexo.
FileId String O identificador do arquivo.
FileName String O nome do arquivo. Apenas para anexos físicos.
FileSize Integer O tamanho do arquivo em bytes. Apenas para anexos físicos.
Name String O nome do anexo.
ParentId String O ID de registro do sistema imutável do objeto pai.
Tags String As tags associadas ao anexo.
ThumbnailId String O identificador da miniatura. Para anexos físicos que são apenas imagens.
ThumbnailUrl String O URL de uma miniatura.
Type String O tipo de anexo. Os valores disponíveis são Link e Physical.
Url String A URL do anexo.

Pacotes

Retorna uma lista de pacotes que contém conteúdo e outros itens para os apelos que as organizações usam para solicitar presentes

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • Id suporta o = operador.
  • AppealId suporta os operadores '=,in'.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.
  • IncludeInactive suporta o = operador.

Por exemplo:

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'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do pacote.
AppealId String Apelos de arrecadação de fundos.ID O ID de registro do sistema imutável da apelação associado a este pacote.
Category String A categoria do pacote.
DateAdded Datetime A data em que o pacote foi criado.
DateModified Datetime A data em que o pacote foi modificado pela última vez.
DefaultGiftAmountValue Double O valor padrão para presentes associados a este pacote.
Description String O nome de exibição do pacote.
End Datetime A data final do pacote.
GoalValue Double O objetivo deste pacote.
Inactive Boolean Este campo calculado indica que o pacote está ativo se a data atual for após qualquer início e antes de qualquer término.
LookupId String O identificador definido pelo usuário para o pacote.
Notes String As notas na embalagem.
RecipientCount Integer A quantidade de destinatários do pacote.
Start Datetime A data de início do pacote.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean

Pagamentos de Taxas de Participantes

Retorna os pagamentos de taxas de um participante.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: ParticipantId é necessário para consultar ParticipantFeePayments.

  • ParticipantId suporta o = operador.

Por exemplo:

SELECT * FROM ParticipantFeePayments WHERE ParticipantId = '197'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID da taxa do participante.
ParticipantId String Participantes do evento.ID O ID do participante ao qual a taxa do participante está vinculada.
AppliedAmount Integer O valor aplicado do pagamento da taxa do participante.
GiftId String A ID do presente ao qual a taxa do participante está vinculada.

Taxas do Participante

Retorna uma lista de taxas para um participante.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: ParticipantId é necessário para consultar ParticipantFees.

  • ParticipantId suporta o = operador.

Por exemplo:

SELECT * FROM ParticipantFees WHERE ParticipantId = '197'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID da taxa do participante.
ParticipantId String Participantes do evento.ID A ID do registro ao qual a taxa do participante está vinculada.
DateD Integer O dia na data difusa.
DateM Integer O mês na data difusa.
DateY Integer O ano na data imprecisa.
EventFeeContributionAmount Integer O valor dedutível do imposto para essa taxa.
EventFeeCost Double O custo da taxa.
EventFeeEventId String O ID do evento ao qual a taxa está vinculada.
EventFeeId String O ID da taxa do evento.
EventFeeName String O nome da taxa do evento.
EventFeeNumberSold Integer O número de taxas vendidas.
FeeAmount Double O valor da taxa de participante.
Quantity Integer A quantidade comprada.
TaxReceiptableAmount Integer O valor do imposto recuperável da taxa do participante.

Níveis de Participante

Retorna uma lista de níveis de participação para todos os eventos.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • IncludeInactive suporta o = operador.

Por exemplo:

SELECT * FROM ParticipantLevels WHERE IncludeInactive = true
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID do nível de participação.
IsInactive Boolean Se o nível de participação está inativo. Verdadeiro se inativo.
Name String O nome do nível de participação.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean

Opções do Participante

Retorna as opções de participante para um participante.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Observação: ParticipantId é necessário para consultar ParticipantOptions.

  • ParticipantId suporta o = operador.

Por exemplo:

SELECT * FROM ParticipantOptions WHERE ParticipantId = '197'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String A ID da opção do participante.
ParticipantId String Participantes do evento.ID O ID do participante.
AddedByService String O nome do serviço que adicionou esta opção de participante.
AddedByUser String O ID do usuário que adicionou a opção de participante.
DateAdded Datetime A data em que a opção do participante foi adicionada.
DateUpdated Datetime A data em que a opção do participante foi atualizada.
EventId String O ID do evento.
EventParticipantOptionId String A ID da opção do participante do evento.
OptionValue String A resposta do participante à opção.
UpdatedByService String O nome do serviço que atualizou esta opção de participante.
UpdatedByUser String A ID do usuário que atualizou a opção de participante.

Telefones

Retorna uma lista de telefones para todos os constituintes ou um constituinte específico

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • Id suporta o = operador.
  • ConstituentId suporta os operadores '=,in'.
  • DateAdded suporta os operadores '>='.
  • DateModified suporta os operadores '>='.
  • IncludeInactive suporta os operadores '='.

Por exemplo:

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'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do telefone.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado ao telefone.
DateAdded Datetime A data em que o telefone foi criado.
DateModified Datetime A data em que o telefone foi modificado pela última vez.
DoNotCall Boolean Indica se o constituinte solicita não ser contactado neste número.
Inactive Boolean Indica se o telefone está inativo.
Number String O numero do telefone.
Primary Boolean Indica se este é o telefone principal do constituinte.
Type String O tipo de telefone.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean

AvaliaçãoCategorias

Retorna uma lista de todas as categorias de classificação disponíveis.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • IncludeInactive suporta o = operador.
  • SourceName suporta o = operador.

Por exemplo:

SELECT * FROM RatingCategories WHERE SourceName = 'Econometrics'

SELECT * FROM RatingCategories WHERE IncludeInactive = true
Colunas
Nome Tipo Referências Descrição
Inactive Boolean Indica se a categoria está inativa.
Name String O nome da categoria de classificação.
SourceName String A origem da categoria.
Type String O tipo da categoria de classificação.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean

Avaliações

Retorna uma lista de classificações para um constituinte.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.
Nota: ConstituentId é necessário para consultar Ratings.

  • ConstituentId suporta o = operador.
  • IncludeInactive suporta o = operador.
  • MostRecentlyUsed suporta o = operador.

Por exemplo:

SELECT * FROM Ratings WHERE ConstituentId = '280'

SELECT * FROM Ratings WHERE IncludeInactive = true

SELECT * FROM Ratings WHERE MostRecentlyUsed = true
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável da classificação.
Category String A categoria da classificação.
Comment String Um comentário sobre a classificação.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado à classificação.
Date Datetime A data da classificação.
Inactive Boolean Este campo calculado indica que a classificação está ativa se a categoria estiver ativa.
Source String A fonte da classificação.
Type String Esse campo calculado indica o tipo de dados que a classificação representa com base na propriedade da categoria.
Value String O valor da classificação.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean
MostRecentOnly Boolean

RatingSources

Retorna uma lista de todas as fontes de classificação disponíveis.

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • IncludeInactive suporta o = operador.

Por exemplo:

SELECT * FROM RatingSources WHERE IncludeInactive = true
Colunas
Nome Tipo Referências Descrição
Inactive Boolean Indica se a fonte de classificação está inativa.
Name String O nome da fonte de classificação.
Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Nome Tipo Descrição
IncludeInactive Boolean

Relacionamentos

Retorna uma lista de relacionamentos entre constituintes e outros indivíduos e organizações, como família, amigos e empregadores

Informações Específicas da Tabela
Selecione

O conector usará a API Edge NXT do BlackBaud Raiser para processar as condições da cláusula WHERE construídas com a seguinte coluna e operador. O restante do filtro é executado no lado do cliente dentro do conector.

  • Id suporta o = operador.
  • ConstituentId suporta o = operador.
  • DateAdded suporta '>=,>' operadores.
  • DateModified suporta '>=,>' operadores.

Por exemplo:

SELECT * FROM Relationships WHERE Id = '1'

SELECT * FROM Relationships WHERE ConstituentId = '280'
Colunas
Nome Tipo Referências Descrição
Id [KEY] String O ID de registro do sistema imutável do relacionamento.
Comment String O comentário sobre o relacionamento.
ConstituentId String Constituintes.ID O ID de registro do sistema imutável do constituinte associado ao relacionamento.
DateAdded Datetime A data em que o relacionamento foi criado.
DateModified Datetime A data em que o relacionamento foi modificado pela última vez.
EndD Integer O dia final para o relacionamento.
EndM Integer O mês final para o relacionamento.
EndY Integer O ano do fim do relacionamento.
IsOrganizationContact Boolean Indica se o indivíduo relacionado representa a organização como um contato.
IsPrimaryBusiness Boolean Indica se a organização relacionada é o principal negócio do indivíduo.
IsSpouse Boolean Indica se o constituinte relacionado é o cônjuge do constituinte.
Name String O nome do constituinte relacionado.
OrganizationContactType String Fornece contexto para interações com o indivíduo relacionado que representa a organização como um contato.
Position String A posição do indivíduo na organização.
ReciprocalRelationshipId String O identificador para o registro de relacionamento recíproco.
ReciprocalType String Descreve o relacionamento do constituinte com o constituinte relacionado.
RelationId String O ID de registro do sistema imutável do indivíduo ou organização relacionada.
StartD Integer O dia de início do relacionamento.
StartM Integer O mês de início do relacionamento.
StartY Integer O ano de início do relacionamento.
Type String O tipo de relação que o relacionamento representa.

Procedimentos Armazenados

Procedimentos armazenados* estão disponíveis para complementar os dados disponíveis no Modelo de Dados. Pode ser necessário atualizar os dados disponíveis em uma exibição usando um procedimento armazenado* porque os dados não fornecem atualizações bidirecionais diretas, semelhantes a tabelas. Nessas situações, a recuperação dos dados é feita usando a visualização ou tabela apropriada, enquanto a atualização é feita chamando um procedimento armazenado. Procedimentos armazenados* pega uma lista de parâmetros e retorna um conjunto de dados que contém a coleção de tuplas que constituem a resposta.

Jitterbit Connector para Blackbaud Raisers Edge NXT Stored Procedures

Nome Descrição
AutomateRecurringGift Converte um presente recorrente manual em um presente recorrente automatizado na visualização da web
GetOAuthAccessToken Obtém um token de autenticação de BlackBaudRaiserEdgeNXT.
GetOAuthAuthorizationURL Obtém a URL de autorização que deve ser aberta separadamente pelo usuário para conceder acesso ao seu aplicativo. Necessário apenas ao desenvolver aplicativos da Web. Você solicitará o OAuthAccessToken deste URL.
RefreshOAuthAccessToken Atualiza o token de acesso OAuth usado para autenticação com BlackBaudRaiserEdgeNXT.
UpdateGiftReceipt Edita um recibo de presente
UpdateGiftStatus Edite o status de um presente recorrente.

Presente Recorrente Automatizado

Converte um presente recorrente manual em um presente recorrente automatizado na visualização da web

Entrada
Nome Tipo Obrigatório Descrição
GiftId String Verdade O ID de registro do sistema imutável do presente recorrente a ser convertido.
BBPSConfigurationId String Verdade ID de configuração BBPS para colocar no presente.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Status de execução do procedimento armazenado.

GetOAuthAccessToken

Obtém um token de autenticação de BlackBaudRaiserEdgeNXT.

Entrada
Nome Tipo Obrigatório Descrição
AuthMode String Falso O tipo de modo de autenticação a ser usado. Selecione App para obter tokens de autenticação por meio de um aplicativo de desktop. Selecione Web para obter tokens de autenticação por meio de um aplicativo Web. Os valores permitidos são APP, WEB. O valor padrão é APP.
Scope String Falso Uma lista separada por vírgulas de permissões a serem solicitadas ao usuário. Verifique a Backlog API para obter uma lista de permissões disponíveis.
CallbackUrl String Falso A URL para a qual o usuário será redirecionado após autorizar seu aplicativo. Esse valor deve corresponder à URL de redirecionamento que você especificou nas configurações do aplicativo Backlog. Necessário apenas quando o parâmetro Authmode for Web.
Verifier String Falso O verificador retornou de RaiserEdgeNxt depois que o usuário autorizou seu aplicativo a ter acesso aos dados dele. Esse valor será retornado como um parâmetro para a URL de retorno de chamada.
State String Falso Indica qualquer estado que pode ser útil para sua aplicação após o recebimento da resposta. Seu aplicativo recebe o mesmo valor que enviou, pois esse parâmetro faz uma viagem de ida e volta para o servidor de autorização de pendências e vice-versa. Os usos incluem redirecionar o usuário para o recurso correto em seu site, nonces e mitigações de falsificação de solicitação entre sites.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
OAuthAccessToken String O token de acesso usado para comunicação com BlackBaudRaiserEdgeNXT.
OAuthRefreshToken String O token de atualização OAuth. É o mesmo que o token de acesso no caso de BlackBaudRaiserEdgeNXT.
ExpiresIn String O tempo de vida restante no token de acesso. Um -1 denota que não irá expirar.

GetOAuthAuthorizationURL

Obtém a URL de autorização que deve ser aberta separadamente pelo usuário para conceder acesso ao seu aplicativo. Necessário apenas ao desenvolver aplicativos da Web. Você solicitará o OAuthAccessToken deste URL.

Entrada
Nome Tipo Obrigatório Descrição
CallbackUrl String Falso A URL para a qual o usuário será redirecionado após autorizar seu aplicativo. Esse valor deve corresponder ao URL de redirecionamento nas configurações do aplicativo BlackBaudRaiserEdgeNXT.
Scope String Falso Uma lista separada por vírgulas de escopos a serem solicitados ao usuário. Verifique a documentação da API BlackBaudRaiserEdgeNXT para obter uma lista de permissões disponíveis.
State String Falso Indica qualquer estado que pode ser útil para sua aplicação após o recebimento da resposta. Seu aplicativo recebe o mesmo valor que enviou, pois esse parâmetro faz uma viagem de ida e volta para o servidor de autorização BlackBaudRaiserEdgeNXT e vice-versa. Os usos incluem redirecionar o usuário para o recurso correto em seu site, nonces e mitigações de falsificação de solicitação entre sites.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
URL String O URL de autorização, inserido em um navegador da Web para obter o token do verificador e autorizar seu aplicativo.

RefreshOAuthAccessToken

Atualiza o token de acesso OAuth usado para autenticação com BlackBaudRaiserEdgeNXT.

Entrada
Nome Tipo Obrigatório Descrição
OAuthRefreshToken String Verdade Defina isso para o valor do token que expirou.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
OAuthAccessToken String O token de autenticação retornado de BlackBaudRaiserEdgeNXT. Isso pode ser usado em chamadas subseqüentes para outras operações para este serviço específico.
OAuthRefreshToken String É o mesmo que o token de acesso.
ExpiresIn String O tempo de vida restante no token de acesso.

Atualizar Recibo de Presente

Edita um recibo de presente

Procedimentos Armazenados* Informações Específicas
Processo de Atualização de Recibo de Presente

O Edge NXT do BlackBaud Raiser permite que apenas um pequeno subconjunto de colunas seja usado na consultar Exec. Essas colunas geralmente podem ser usadas com apenas = comparação. As colunas disponíveis para UpdateGiftReceipt são ReceiptId, Amount, Date, Number e Status. Por exemplo:

EXECUTE UpdateGiftReceipt ReceiptId = '372', Amount = 0.0, Date = '2018-12-31T00:00:00', Number = 123456, Status = 'Receipted'
Entrada
Nome Tipo Obrigatório Descrição
ReceiptId String Verdade O ID de registro do sistema imutável do recibo de presente a ser editado. Ele usa o ID do presente pai como seu valor.
Amount Double Verdade O valor do recibo.
Date String Verdade A data do recibo
Number Integer Verdade O número do recibo.
Status String Verdade O status de recebimento do presente. Os valores disponíveis são: RECEIPTED, NEEDSRECEIPT e DONOTRECEIPT. Quando recibo_status é definido como NEEDSRECEIPT ou DONOTRECEIPT, recibo_data deve ser nulo.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Status de execução do procedimento armazenado

UpdateGiftStatus

Edite o status de um presente recorrente.

Procedimentos Armazenados* Informações Específicas
Processo de Atualização do Status do Presente

O Edge NXT do BlackBaud Raiser permite que apenas um pequeno subconjunto de colunas seja usado na consultar Exec. Essas colunas geralmente podem ser usadas com apenas = comparação. As colunas disponíveis para UpdateGiftStatus são GiftId e GiftStatus. Por exemplo:

EXECUTE UpdateGiftStatus GiftId = '281', GiftStatus = 'Held'
Entrada
Nome Tipo Obrigatório Descrição
GiftId String Verdade O ID de registro do sistema imutável do presente recorrente a ser atualizado.
GiftStatus String Verdade O novo status do presente recorrente. Os valores disponíveis são Active, Held, Terminated, Completed e Cancelled.
Colunas do Conjunto de Resultados
Nome Tipo Descrição
Success String Status de execução do procedimento armazenado

Tabelas do Sistema

Você pode consultar as tabelas do sistema descritas nesta seção para acessar informações de esquema, informações sobre a funcionalidade da fonte de dados e estatísticas de operação em lote.

Tabelas de Esquema

As tabelas a seguir retornam os metadados do banco de dados para o Edge NXT do BlackBaud Raiser:

Tabelas de Fonte de Dados

As tabelas a seguir retornam informações sobre como se conectar e consultar a fonte de dados:

  • sys_connection_props: Retorna informações sobre as propriedades de conexão disponíveis.
  • sys_sqlinfo: Descreve as consultas SELECT que o conector pode descarregar para a fonte de dados.

Consultar Tabelas de Informações

A tabela a seguir retorna estatísticas de consultar para consultas de modificação de dados:

  • sys_identity: Retorna informações sobre operações em lote ou atualizações únicas.

Sys_catalogs

Lista os bancos de dados disponíveis.

A consultar a seguir recupera todos os bancos de dados determinados pela string de conexão:

SELECT * FROM sys_catalogs
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados.

Sys_schemas

Lista os esquemas disponíveis.

A consultar a seguir recupera todos os esquemas disponíveis:

SELECT * FROM sys_schemas
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados.
SchemaName String O nome do esquema.

Sys_tables

Lista as tabelas disponíveis.

A consultar a seguir recupera as tabelas e exibições disponíveis:

SELECT * FROM sys_tables
Colunas
Nome Tipo Descrição
CatalogName String O banco de dados que contém a tabela ou exibição.
SchemaName String O esquema que contém a tabela ou exibição.
TableName String O nome da tabela ou exibição.
TableType String O tipo de tabela (tabela ou exibição).
Description String Uma descrição da tabela ou exibição.
IsUpdateable Boolean Se a tabela pode ser atualizada.

Sys_tablecolumns

Descreve as colunas das tabelas e exibições disponíveis.

A consultar a seguir retorna as colunas e os tipos de dados da tabela Constituintes:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Constituents'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a tabela ou exibição.
SchemaName String O esquema que contém a tabela ou exibição.
TableName String O nome da tabela ou exibição que contém a coluna.
ColumnName String O nome da coluna.
DataTypeName String O nome do tipo de dados.
DataType Int32 Um número inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente.
Length Int32 O tamanho de armazenamento da coluna.
DisplaySize Int32 A largura máxima normal da coluna designada em caracteres.
NumericPrecision Int32 O número máximo de dígitos em dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora.
NumericScale Int32 A escala da coluna ou o número de dígitos à direita do ponto decimal.
IsNullable Boolean Se a coluna pode conter null.
Description String Uma breve descrição da coluna.
Ordinal Int32 O número de sequência da coluna.
IsAutoIncrement String Se o valor da coluna é atribuído em incrementos fixos.
IsGeneratedColumn String Se a coluna é gerada.
IsHidden Boolean Se a coluna está oculta.
IsArray Boolean Se a coluna é uma matriz.

Sys_procedures

Lista os procedimentos armazenados disponíveis.

A consultar a seguir recupera os procedimentos armazenados disponíveis:

SELECT * FROM sys_procedures
Colunas
Nome Tipo Descrição
CatalogName String O banco de dados que contém o procedimento armazenado.
SchemaName String O esquema que contém o procedimento armazenado.
ProcedureName String O nome do procedimento armazenado.
Description String Uma descrição do procedimento armazenado.
ProcedureType String O tipo do procedimento, como PROCEDURE ou FUNCTION.

Sys_procedureparameters

Descreve procedimento armazenado* parâmetros.

A consultar a seguir retorna informações sobre todos os parâmetros de entrada para o procedimento armazenado UpdateGiftStatus:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='UpdateGiftStatus' AND Direction=1 OR Direction=2
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém o procedimento armazenado.
SchemaName String O nome do esquema que contém o procedimento armazenado.
ProcedureName String O nome do procedimento armazenado* contendo o parâmetro.
ColumnName String O nome do procedimento armazenado* parâmetro.
Direction Int32 Um número inteiro correspondente ao tipo do parâmetro: entrada (1), entrada/saída (2) ou saída (4). parâmetros de tipo de entrada/saída podem ser parâmetros de entrada e saída.
DataTypeName String O nome do tipo de dados.
DataType Int32 Um número inteiro indicando o tipo de dados. Esse valor é determinado no tempo de execução com base no ambiente.
Length Int32 O número de caracteres permitido para dados de caractere. O número de dígitos permitidos para dados numéricos.
NumericPrecision Int32 A precisão máxima para dados numéricos. O comprimento da coluna em caracteres para caracteres e dados de data e hora.
NumericScale Int32 O número de dígitos à direita do ponto decimal em dados numéricos.
IsNullable Boolean Se o parâmetro pode conter null.
IsRequired Boolean Se o parâmetro é necessário para a execução do procedimento.
IsArray Boolean Se o parâmetro é uma matriz.
Description String A descrição do parâmetro.
Ordinal Int32 O índice do parâmetro.

Sys_keycolumns

Descreve as chaves primárias e estrangeiras. A consultar a seguir recupera a chave primária da tabela Constituintes:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Constituents'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a chave.
SchemaName String O nome do esquema que contém a chave.
TableName String O nome da tabela que contém a chave.
ColumnName String O nome da coluna chave.
IsKey Boolean Se a coluna é uma chave primária na tabela referenciada no campo TableName.
IsForeignKey Boolean Se a coluna é uma chave estrangeira referenciada no campo TableName.
PrimaryKeyName String O nome da chave primária.
ForeignKeyName String O nome da chave estrangeira.
ReferencedCatalogName String O banco de dados que contém a chave primária.
ReferencedSchemaName String O esquema que contém a chave primária.
ReferencedTableName String A tabela que contém a chave primária.
ReferencedColumnName String O nome da coluna da chave primária.

Sys_foreignkeys

Descreve as chaves estrangeiras. A consultar a seguir recupera todas as chaves estrangeiras que se referem a outras tabelas:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém a chave.
SchemaName String O nome do esquema que contém a chave.
TableName String O nome da tabela que contém a chave.
ColumnName String O nome da coluna chave.
PrimaryKeyName String O nome da chave primária.
ForeignKeyName String O nome da chave estrangeira.
ReferencedCatalogName String O banco de dados que contém a chave primária.
ReferencedSchemaName String O esquema que contém a chave primária.
ReferencedTableName String A tabela que contém a chave primária.
ReferencedColumnName String O nome da coluna da chave primária.
ForeignKeyType String Designa se a chave estrangeira é uma chave de importação (aponta para outras tabelas) ou de exportação (referenciada de outras tabelas).

Sys_indexes

Descreve os índices disponíveis. Ao filtrar por índices, você pode escrever consultas mais seletivas com tempos de resposta de consultar mais rápidos.

A consultar a seguir recupera todos os índices que não são chaves primárias:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Colunas
Nome Tipo Descrição
CatalogName String O nome do banco de dados que contém o índice.
SchemaName String O nome do esquema que contém o índice.
TableName String O nome da tabela que contém o índice.
IndexName String O nome do índice.
ColumnName String O nome da coluna associada ao índice.
IsUnique Boolean True se o índice for exclusivo. Falso caso contrário.
IsPrimary Boolean Verdadeiro se o índice for uma chave primária. Falso caso contrário.
Type Int16 Um valor inteiro correspondente ao tipo de índice: estatística (0), agrupado (1), hash (2) ou outro (3).
SortOrder String A ordem de classificação: A para crescente ou D para decrescente.
OrdinalPosition Int16 O número de sequência da coluna no índice.

Sys_connection_props

Retorna informações sobre as propriedades de conexão disponíveis e as definidas na string de conexão.

Ao consultar esta tabela, a string de conexão de configuração deve ser usada:

jdbc:cdata:raiseredgenxt:config:

Esta string de conexão permite que você consultar esta tabela sem uma conexão válida.

A consultar a seguir recupera todas as propriedades de conexão que foram definidas na string de conexão ou definidas por meio de um valor padrão:

SELECT * FROM sys_connection_props WHERE Value <> ''
Colunas
Nome Tipo Descrição
Name String O nome da propriedade de conexão.
ShortDescription String Uma breve descrição.
Type String O tipo de dados da propriedade de conexão.
Default String O valor padrão, se não houver um definido explicitamente.
Values String Uma lista separada por vírgulas de valores possíveis. Um erro de validação é lançado se outro valor for especificado.
Value String O valor que você definiu ou um padrão pré-configurado.
Required Boolean Se a propriedade é necessária para se conectar.
Category String A categoria da propriedade de conexão.
IsSessionProperty String Se a propriedade é uma propriedade de sessão, usada para salvar informações sobre a conexão atual.
Sensitivity String O nível de sensibilidade da propriedade. Isso informa se a propriedade está ofuscada nos formulários de registro e autenticação.
PropertyName String Uma forma truncada em camel case do nome da propriedade de conexão.
Ordinal Int32 O índice do parâmetro.
CatOrdinal Int32 O índice da categoria do parâmetro.
Hierarchy String Mostra as propriedades dependentes associadas que precisam ser definidas juntamente com esta.
Visible Boolean Informa se a propriedade está visível na UI da conexão.
ETC String Diversas informações diversas sobre o imóvel.

Sys_sqlinfo

Descreve o processamento da consultar SELECT que o conector pode transferir para a fonte de dados.

Processamento de Consultas Colaborativas

Ao trabalhar com fontes de dados que não suportam SQL-92, você pode consultar a exibição sys_sqlinfo para determinar os recursos de consultar das APIs subjacentes, expressas na sintaxe SQL. O conector transfere o máximo possível do processamento da instrução SELECT para o servidor e, em seguida, processa o restante da consultar na memória.

Descobrindo os Recursos SELECT da Fonte de Dados

Abaixo está um exemplo de conjunto de dados de recursos SQL. O conjunto de resultados a seguir indica a funcionalidade SELECT que o conector pode descarregar para a fonte de dados ou processar o lado do cliente. Sua fonte de dados pode suportar sintaxe SQL adicional. Alguns aspectos da funcionalidade SELECT são retornados em uma lista separada por vírgulas, se suportados; caso contrário, a coluna contém NO.

Nome Descrição Valores Possíveis
AGGREGATE_FUNCTIONS Funções de agregação suportadas. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Se a função COUNT é suportada. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR O caractere de abertura usado para escapar de um identificador. [
IDENTIFIER_QUOTE_CLOSE_CHAR O caractere de fechamento usado para escapar de um identificador. ]
SUPPORTED_OPERATORS Uma lista de operadores SQL com suporte. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Se GROUP BY é compatível e, em caso afirmativo, o grau de suporte. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Funções de string suportadas. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Funções numéricas suportadas. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Funções de data/hora suportadas. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indica tabelas ignoradas durante a replicação.
REPLICATION_TIMECHECK_COLUMNS Uma matriz de string contendo uma lista de colunas que serão usadas para verificar (na ordem especificada) para usar como uma coluna modificada durante a replicação.
IDENTIFIER_PATTERN Valor de string que indica qual string é válida para um identificador.
SUPPORT_TRANSACTION Indica se o provedor oferece suporte a transações como confirmação e reversão. YES, NO
DIALECT Indica o dialeto SQL a ser usado.
KEY_PROPERTIES Indica as propriedades que identificam o banco de dados uniforme.
SUPPORTS_MULTIPLE_SCHEMAS Indica se vários esquemas podem existir para o provedor. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indica se vários catálogos podem existir para o provedor. YES, NO
DATASYNCVERSION A versão do Data Sync necessária para acessar este driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY A categoria Data Sync deste driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Se a funcionalidade SQL aprimorada além do que é oferecido pela API é suportada. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Se as operações em lote são suportadas. YES, NO
SQL_CAP Todos os recursos SQL suportados para este driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS Um valor de string especifica o cacheOptions preferencial.
ENABLE_EF_ADVANCED_QUERY Indica se o driver oferece suporte direto a consultas avançadas provenientes do Entity Framework. Caso contrário, as consultas serão tratadas no lado do cliente. YES, NO
PSEUDO_COLUMNS Uma matriz de cadeia de caracteres que indica as pseudocolunas disponíveis.
MERGE_ALWAYS Se o valor for verdadeiro, o modo de mesclagem será executado à força no Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY Uma consultar de seleção para retornar a data e hora de início da replicação.
REPLICATION_MIN_FUNCTION Permite que um provedor especifique o nome da fórmula a ser usado para executar um min do lado do servidor.
REPLICATION_START_DATE Permite que um provedor especifique uma data de início de replicação.
REPLICATION_MAX_DATE_QUERY Uma consultar de seleção para retornar a data e hora de término da replicação.
REPLICATION_MAX_FUNCTION Permite que um provedor especifique o nome da fórmula a ser usado para executar um máximo do lado do servidor.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE Uma lista de tabelas que ignorará a divisão da replicação em blocos na replicação inicial.
CHECKCACHE_USE_PARENTID Indica se a instrução CheckCache deve ser executada na coluna de chave pai. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indica procedimentos armazenados* que pode ser usado para gerar arquivos de esquema.

A consultar a seguir recupera os operadores que podem ser usados na cláusula WHERE:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Observe que tabelas individuais podem ter diferentes limitações ou requisitos na cláusula WHERE; consulte o Modelo de Dados para obter mais informações.

Colunas
Nome Tipo Descrição
NAME String Um componente da sintaxe SQL ou um recurso que pode ser processado no servidor.
VALUE String Detalhes sobre a sintaxe SQL ou SQL suportada.

Sys_identity

Retorna informações sobre tentativas de modificação.

A consultar a seguir recupera os IDs das linhas modificadas em uma operação em lote:

SELECT * FROM sys_identity
Colunas
Nome Tipo Descrição
Id String O ID gerado pelo banco de dados retornado de uma operação de modificação de dados.
Batch String Um identificador para o lote. 1 para uma única operação.
Operation String O resultado da operação no lote: INSERTED, UPDATED ou DELETED.
Message String SUCCESS ou uma mensagem de erro se a atualização no lote falhou.

Propriedades de Configurações Avançadas

As propriedades de configurações avançadas são as várias opções que podem ser usadas para estabelecer uma conexão. Esta seção fornece uma lista completa das opções que você pode configurar. Clique nos links para mais detalhes.

OAuth

Propriedade Descrição
InitiateOAuth Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.
OAuthClientId O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthClientSecret O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthAccessToken O token de acesso para conexão usando OAuth.
SubscriptionKey Chave de assinatura que fornece acesso à API. Encontrado em seu perfil de desenvolvedor.
CallbackURL O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.
OAuthVerifier O código do verificador retornado da URL de autorização OAuth.
OAuthRefreshToken O token de atualização OAuth para o token de acesso OAuth correspondente.
OAuthExpiresIn O tempo de vida em segundos do OAuth AccessToken.
OAuthTokenTimestamp O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

SSL

Propriedade Descrição
SSLServerCert O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Esquema

Propriedade Descrição
Location Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.
BrowsableSchemas Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC.
Views Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC.

Diversos

Propriedade Descrição
IncludeCustomFields Defina como verdadeiro para recuperar valores de campos personalizados para Constituintes, Ações, Oportunidades e Presentes.
MaxRows Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Other Essas propriedades ocultas são usadas apenas em casos de uso específicos.
PageSize O número de resultados a serem retornados por página de dados recuperados do Edge NXT do BlackBaud Raiser.
PseudoColumns Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.
Timeout O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

OAuth

Esta seção fornece uma lista completa de propriedades OAuth que você pode configurar.

Propriedade Descrição
InitiateOAuth Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.
OAuthClientId O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthClientSecret O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.
OAuthAccessToken O token de acesso para conexão usando OAuth.
SubscriptionKey Chave de assinatura que fornece acesso à API. Encontrado em seu perfil de desenvolvedor.
CallbackURL O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.
OAuthVerifier O código do verificador retornado da URL de autorização OAuth.
OAuthRefreshToken O token de atualização OAuth para o token de acesso OAuth correspondente.
OAuthExpiresIn O tempo de vida em segundos do OAuth AccessToken.
OAuthTokenTimestamp O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

InitiateOAuth

Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.

Valores Possíveis

OFF, GETANDREFRESH, REFRESH

Tipo de Dados

string

Valor Padrão

"OFF"

Observações

As seguintes opções estão disponíveis:

  1. OFF: Indica que o fluxo OAuth será tratado inteiramente pelo usuário. Um OAuthAccessToken será necessário para autenticação.
  2. GETANDREFRESH: Indica que todo o fluxo OAuth será tratado pelo conector. Se nenhum token existir atualmente, ele será obtido solicitando ao usuário por meio do navegador. Se existir um token, ele será atualizado quando aplicável.
  3. REFRESH: Indica que o conector tratará apenas da atualização do OAuthAccessToken. O usuário nunca será solicitado pelo conector a autenticar por meio do navegador. O usuário deve manipular a obtenção do OAuthAccessToken e OAuthRefreshToken inicialmente.

OAuthClientId

O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId valor, às vezes também chamado de chave do consumidor, e um segredo do cliente, o OAuthClientSecret.

OAuthClientSecret

O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId, também chamada de chave do consumidor. Você também receberá um segredo do cliente, também chamado de segredo do consumidor. Defina o segredo do cliente no OAuthClientSecret propriedade.

OAuthAccessToken

O token de acesso para conexão usando OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

O OAuthAccessToken propriedade é usada para conectar usando OAuth. O OAuthAccessToken é recuperado do servidor OAuth como parte do processo de autenticação. Ele tem um tempo limite dependente do servidor e pode ser reutilizado entre as solicitações.

O token de acesso é usado no lugar do seu nome de usuário e senha. O token de acesso protege suas credenciais, mantendo-as no servidor.

SubscriptionKey

Chave de assinatura que fornece acesso à API. Encontrado em seu perfil de desenvolvedor.

Tipo de Dados

string

Valor Padrão

""

Observações

Para obter uma chave, siga estas etapas:

  • Solicite uma assinatura de uma API na página Produtos ( https://developer.sky.blackbaud.com/products/ ), selecione SKY API Standard Edition.
  • Selecione Subscribe. Uma tela de confirmação é exibida.
  • Para enviar sua solicitação, selecione Confirm. Você receberá uma notificação e-mail quando sua solicitação for aprovada.
  • Depois de aprovado, você pode visualizar a chave de assinatura em seu perfil de desenvolvedor.

URL de Retorno

O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.

Tipo de Dados

string

Valor Padrão

""

Observações

Durante o processo de autenticação, o servidor de autorização OAuth redireciona o usuário para esta URL. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.

OAuthVerifier

O código do verificador retornado da URL de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

O código do verificador retornado da URL de autorização OAuth. Isso pode ser usado em sistemas em que um navegador não pode ser iniciado, como sistemas headless.

Autenticação em Máquinas Sem Cabeça

Consulte para obter o OAuthVerifier valor.

Defina OAuthSettingsLocation juntamente com OAuthVerifier. Quando você conecta, o conector troca o OAuthVerifier para os tokens de autenticação OAuth e os salva, criptografados, no arquivo especificado. Definir InitiateOAuth para GETANDREFRESH automatizar a troca.

Depois que o arquivo de configurações OAuth for gerado, você poderá remover OAuthVerifier nas propriedades de conexão e conecte-se com OAuthSettingsLocation definir.

Para atualizar automaticamente os valores do token OAuth, defina OAuthSettingsLocation e adicionalmente defina InitiateOAuth para ATUALIZAR.

OAuthRefreshToken

O token de atualização OAuth para o token de acesso OAuth correspondente.

Tipo de Dados

string

Valor Padrão

""

Observações

O OAuthRefreshToken a propriedade é usada para atualizar o OAuthAccessToken ao usar a autenticação OAuth.

OAuthExpiresIn

O tempo de vida em segundos do OAuth AccessToken.

Tipo de Dados

string

Valor Padrão

""

Observações

Emparelhe com OAuthTokenTimestamp para determinar quando o AccessToken expirará.

OAuthTokenTimestamp

O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

Tipo de Dados

string

Valor Padrão

""

Observações

Emparelhe com OAuthExpiresIn para determinar quando o AccessToken expirará.

SSL

Esta seção fornece uma lista completa de propriedades SSL que você pode configurar.

Propriedade Descrição
SSLServerCert O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

SSLServerCert

O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Tipo de Dados

string

Valor Padrão

""

Observações

Se estiver usando uma conexão TLS/SSL, esta propriedade pode ser usada para especificar o certificado TLS/SSL a ser aceito do servidor. Qualquer outro certificado que não seja confiável para a máquina é rejeitado.

Esta propriedade pode assumir as seguintes formas:

Descrição Exemplo
Um certificado PEM completo (exemplo abreviado para concisão) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
Um caminho para um arquivo local contendo o certificado C:\cert.cer
A chave pública (exemplo abreviado para concisão) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
O Thumbprint MD5 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) ecadbdda5a1529c58a1e9e09828d70e4
A impressão digital SHA1 (os valores hexadecimais também podem ser separados por espaço ou dois-pontos) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Se não for especificado, qualquer certificado confiável pela máquina será aceito.

Os certificados são validados como confiáveis pela máquina com base no armazenamento confiável do sistema. O armazenamento confiável usado é o valor 'javax.net.ssl.trustStore' especificado para o sistema. Se nenhum valor for especificado para esta propriedade, o armazenamento confiável padrão do Java será usado (por exemplo, JAVA_HOME\lib\security\cacerts).

Use '*' para indicar a aceitação de todos os certificados. Observe que isso não é recomendado devido a questões de segurança.

Esquema

Esta seção fornece uma lista completa de propriedades de esquema que você pode configurar.

Propriedade Descrição
Location Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.
BrowsableSchemas Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tables=TableA, TableB, TableC.
Views Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA, ViewB, ViewC.

Localização

Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.

Tipo de Dados

string

Valor Padrão

"%APPDATA%\\\RaiserEdgeNXT Data Provider\\Schema"

Observações

O caminho para um diretório que contém os arquivos de esquema para o conector (arquivos .rsd para tabelas e exibições, arquivos .rsb para procedimentos armazenados). A localização da pasta pode ser um caminho relativo a partir da localização do executável. O Location a propriedade só é necessária se você quiser personalizar definições (por exemplo, alterar um nome de coluna, ignorar uma coluna e assim por diante) ou estender o modelo de dados com novas tabelas, exibições ou procedimentos armazenados.

Se não for especificado, o local padrão é "%APPDATA%\\RaiserEdgeNXT Data Provider\Schema" com %APPDATA% sendo definido para o diretório de configuração do usuário:

Plataforma %APPDATA%
Windows O valor da variável de ambiente APPDATA
Mac ~/Biblioteca/Suporte de aplicativos
Linux ~/.config

Esquemas Navegáveis

Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar os esquemas de bancos de dados pode ser caro. Fornecer uma lista de esquemas na string de conexão melhora o desempenho.

Tabelas

Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tabelas=TabelaA,TabelaB,TabelaC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar as tabelas de alguns bancos de dados pode ser caro. Fornecer uma lista de tabelas na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.

Especifique as tabelas que deseja em uma lista separada por vírgulas. Cada tabela deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Visualizações

Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA,ViewB,ViewC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar as exibições de alguns bancos de dados pode ser caro. Fornecer uma lista de exibições na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.

Especifique as exibições desejadas em uma lista separada por vírgulas. Cada exibição deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Diversos

Esta seção fornece uma lista completa de diversas propriedades que você pode configurar.

Propriedade Descrição
IncludeCustomFields Defina como verdadeiro para recuperar valores de campos personalizados para Constituintes, Ações, Oportunidades e Presentes.
MaxRows Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.
Other Essas propriedades ocultas são usadas apenas em casos de uso específicos.
PageSize O número de resultados a serem retornados por página de dados recuperados do Edge NXT do BlackBaud Raiser.
PseudoColumns Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.
Timeout O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

IncludeCustomFields

Defina como verdadeiro para recuperar valores de campos personalizados para Constituintes, Ações, Oportunidades e Presentes.

Tipo de Dados

bool

Valor Padrão

false

Observações

Definir isso como verdadeiro afetará significativamente o desempenho da seleção de dados de Constituintes, Ações, Oportunidades e Presentes. A recuperação de campos personalizados requer uma pesquisa por registro, tornando muito caro recuperá-los.

MaxRows

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Tipo de Dados

int

Valor Padrão

-1

Observações

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Outro

Essas propriedades ocultas são usadas apenas em casos de uso específicos.

Tipo de Dados

string

Valor Padrão

""

Observações

As propriedades listadas abaixo estão disponíveis para casos de uso específicos. Os casos de uso e a funcionalidade normais do driver não devem exigir essas propriedades.

Especifique várias propriedades em uma lista separada por ponto e vírgula.

Integração e Formatação
Propriedade Descrição
DefaultColumnSize Define o comprimento padrão dos campos de string quando a fonte de dados não fornece o comprimento da coluna nos metadados. O valor padrão é 2000. Voltar para o início
ConvertDateTimeToGMT Determina se os valores de data e hora devem ser convertidos em GMT, em vez da hora local da máquina.
RecordToFile=filename Registra a transferência de dados do soquete subjacente para o arquivo especificado.

Tamanho da Página

O número de resultados a serem retornados por página de dados recuperados do Edge NXT do BlackBaud Raiser.

Tipo de Dados

string

Valor Padrão

""

Observações

O tamanho da página será determinado automaticamente se você não o definir manualmente. Geralmente não é necessário definir esse valor.

Pseudocolunas

Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.

Tipo de Dados

string

Valor Padrão

""

Observações

Essa configuração é particularmente útil no Entity Framework, que não permite definir um valor para uma pseudocoluna, a menos que seja uma coluna de tabela. O valor dessa configuração de conexão está no formato "Table1=Column1, Table1=Column2, Table2=Column3". Você pode usar o caractere "*" para incluir todas as tabelas e todas as colunas; por exemplo, "*=*".

Tempo Esgotado

O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

Tipo de Dados

int

Valor Padrão

60

Observações

Se Timeout = 0, as operações não expiram. As operações são executadas até serem concluídas com êxito ou até encontrarem uma condição de erro.

Se Timeout expira e a operação ainda não está concluída, o conector lança uma exceção.