Saltar al contenido

Detalles de Conexión de Financial Edge NXT

Introducción

Versión del conector

Esta documentación se basa en la versión 21.0.8257 del conector.

Empezando

Compatibilidad con la versión Blackbaud Financial Edge NXT

El conector aprovecha la API Blackbaud FinancialEdge NXT SKY para permitir el acceso bidireccional a Blackbaud Financial Edge NXT.

Establecer una Conexión

Autenticación en Blackbaud Financial Edge NXT

Blackbaud Financial Edge NXT utiliza el estándar de autenticación OAuth. Blackbaud Financial Edge NXT debe estar habilitado en una cuenta de autorización para recuperar resultados.

Puede conectarse después de configurar las propiedades de conexión requeridas para sus credenciales de usuario y obtener los tokens de acceso requeridos utilizando una herramienta como Postman.

Consulte Uso de la autenticación OAuth para obtener una guía de autenticación y detalles del flujo de autenticación de OAuth.

Uso de la Autenticación OAuth

OAuth requiere el uso de tokens de acceso obtenidos con Postman o una herramienta similar. La autenticación OAuth es compatible como se describe en Conexión en Configurar conexiones OAuth.

Notas Importantes

Procedimientos Almacenados

  • Las funciones de procedimientos almacenados descritas en esta documentación no se admiten actualmente.
  • Debido a que los procedimientos almacenados no se admiten actualmente, cualquier característica que dependa de los procedimientos almacenados tampoco se admite actualmente.

Archivos de Configuración y Sus Rutas

  • Todas las referencias a la adición de archivos de configuración y sus rutas se refieren a archivos y ubicaciones en Harmony Agente donde está instalado el conector. Estas rutas deben ajustarse según corresponda según el agente y el sistema operativo. Si se utilizan varios agentes en un grupo de agentes, se requerirán archivos idénticos en cada agente.

Características Avanzadas

Esta sección detalla una selección de funciones avanzadas del conector Blackbaud Financial Edge NXT.

Vistas definidas por el usuario

El conector le permite definir tablas virtuales, llamadas vistas definidas por el usuario, cuyo contenido se decide mediante una consultar preconfigurada. Estas vistas son útiles cuando no puede controlar directamente las consultas que se envían a los controladores. Consulte Vistas definidas por el usuario para obtener una descripción general de la creación y configuración de vistas personalizadas.

Configuración SSL

Usar Configuración SSL para ajustar cómo el conector maneja las negociaciones de certificados TLS/SSL. Puede elegir entre varios formatos de certificado; ver el SSLServerCert propiedad en "Opciones de cadena de conexión" para obtener más información.

Apoderado

Para configurar el conector mediante Configuración de proxy de Agente Privado, Selecciona el Use Proxy Settings casilla de verificación en la pantalla de configuración de la conexión.

Vistas Definidas por el Usuario

El conector Jitterbit para Blackbaud Financial Edge NXT le permite definir una tabla virtual cuyos contenidos se deciden mediante una consultar preconfigurada. Estas se denominan Vistas definidas por el usuario, que son útiles en situaciones en las que no puede controlar directamente la consultar que se envía al controlador, por ejemplo, cuando se utiliza el controlador de Jitterbit. Las vistas definidas por el usuario se pueden utilizar para definir predicados que siempre se aplican. Si especifica predicados adicionales en la consultar a la vista, se combinan con la consultar ya definida como parte de la vista.

Hay dos formas de crear vistas definidas por el usuario:

  • Cree un archivo de configuración con formato JSON que defina las vistas que desea.
  • Declaraciones DDL.

Definición de Vistas Utilizando un Archivo de Configuración

Las vistas definidas por el usuario se definen en un archivo de configuración con formato JSON llamado UserDefinedViews.json. El conector detecta automáticamente las vistas especificadas en este archivo.

También puede tener múltiples definiciones de vista y controlarlas usando UserDefinedViews propiedad de conexión. Cuando utiliza esta propiedad, el conector solo ve las vistas especificadas.

Este archivo de configuración de vista definida por el usuario tiene el siguiente formato:

  • Cada elemento raíz define el nombre de una vista.
  • Cada elemento raíz contiene un elemento hijo, llamado query, que contiene la consultar SQL personalizada para la vista.

Por ejemplo:

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

Utilizar el UserDefinedViews propiedad de conexión para especificar la ubicación de su archivo de configuración JSON. Por ejemplo:

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

Esquema para Vistas Definidas por el Usuario

Las vistas definidas por el usuario se exponen en UserViews esquema por defecto. Esto se hace para evitar que el nombre de la vista entre en conflicto con una entidad real en el modelo de datos. Puede cambiar el nombre del esquema utilizado para UserViews configurando UserViewsSchemaName propiedad.

Trabajar con Vistas Definidas por el Usuario

Por ejemplo, una instrucción SQL con una vista definida por el usuario llamada UserViews.RCustomers solo enumera clientes en Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Un ejemplo de una consultar al controlador:

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

Dando como resultado la consultar efectiva a la fuente:

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

Ese es un ejemplo muy simple de una consultar a una vista definida por el usuario que es efectivamente una combinación de la consultar de vista y la definición de vista. Es posible componer estas consultas en patrones mucho más complejos. Todas las operaciones de SQL están permitidas en ambas consultas y se combinan cuando corresponde.

Configuración SSL

Personalización de la Configuración SSL

De forma predeterminada, el conector intenta negociar SSL/TLS comparando el certificado del servidor con el almacén de certificados de confianza del sistema.

Para especificar otro certificado, consulte SSLServerCert propiedad de los formatos disponibles para hacerlo.

Modelo de Datos

El Jitterbit Connector para Blackbaud Financial Edge NXT modela los objetos de Blackbaud Financial Edge NXT como vistas relacionales. Un objeto Blackbaud Financial Edge NXT tiene relaciones con otros objetos; en las vistas, estas relaciones se expresan a través de claves foráneas. Las siguientes secciones muestran los objetos de API disponibles y brindan más información sobre la ejecución de SQL en las APIs de Blackbaud Financial Edge NXT.

Los esquemas para la mayoría de los objetos de la base de datos se definen en archivos de configuración simples basados en texto. Para las vistas que pueden tener campos personalizados, las columnas se enumeran dinámicamente. Cuando el usuario autenticado cambie los campos personalizados para algunos objetos, se reflejarán en las vistas respectivas.

El conector descarga la mayor cantidad posible del procesamiento de sentencias SELECT a las APIs de Blackbaud Financial Edge NXT y luego procesa el resto de la consultar en la memoria. Ver SupportEnhancedSQL para obtener más información sobre cómo el conector elude las limitaciones de la API con el procesamiento del lado del cliente en memoria.

Puntos de Vista

Las vistas se componen de columnas y pseudocolumnas. Las vistas son similares a las tablas en la forma en que se representan los datos; sin embargo, las vistas no admiten actualizaciones. Las entidades que se representan como vistas suelen ser entidades de solo lectura. A menudo, un procedimiento almacenado* está disponible para actualizar los datos si dicha funcionalidad es aplicable a la fuente de datos.

Las consultas se pueden ejecutar contra una vista como si fuera una tabla normal, y los datos que regresan son similares en ese sentido. Para obtener más información sobre las tablas y los procedimientos almacenados, vaya a sus entradas correspondientes en este documento de ayuda.

Conector Jitterbit para Vistas Blackbaud Financial Edge NXT

Nombre Descripción
AccountCashflows Devuelve la lista de valores de flujo de caja disponibles
AccountCodes Devuelve los códigos de cuenta.
AccountFundRequirements Devuelve los requisitos para los fondos de la cuenta.
AccountFunds Devuelve los fondos de la cuenta.
Accounts Recuperar y consultar cuentas.
AccountSegments Devuelve el valor del segmento de cuenta especificado.
AccountStructures Devuelve una lista de estructuras de cuenta.
AccountWorkingCapitals Devuelve la lista de valores de capital de trabajo disponibles
BatchValidations Devuelve los resultados de la validación lote.
BudgetAccounts Devuelve detalles para cada período fiscal y cuenta en el escenario.
BudgetDetails Devuelve los detalles del presupuesto especificado.
BudgetFiscalPeriods Devuelve detalles de cada período fiscal en un escenario de presupuesto.
BudgetGrants Devuelve detalles para cada período fiscal y concesión en el escenario.
BudgetLines Devuelve las líneas presupuestarias especificadas.
BudgetProjects Devuelve detalles para cada período fiscal y proyecto en el escenario.
Budgets Devuelve una descripción general de nivel superior de cada escenario de presupuesto.
BudgetScenarios Devuelve detalles para cada ID de escenario.
CashManagementDistributionSetLineItemProjects La distribución del proyecto para las partidas en los conjuntos de distribución de gestión de efectivo.
CashManagementDistributionSets Devuelve la lista de conjuntos de distribución de gestión de efectivo y sus partidas.
Classes La lista de clases
ClientNames Devuelve los nombres de tipo de cliente.
FiscalYears Devuelve la lista de detalles del año fiscal.
GrantCustomFields Devuelve la lista de opciones de campos personalizados de concesión.
GrantStatuses Devuelve la lista de estados de concesión.
GrantTypes Devuelve la lista de tipos de concesión.
JournalCodes Devuelve la lista de todos los códigos de diario disponibles.
JournalEntries Recuperar y consultar entradas de diario.
JournalEntryBatches Devuelve la lista de lotes de entradas de diario.
LedgerSummaries Enumera los resúmenes del libro mayor para el año fiscal y los criterios especificados. Tenga en cuenta que los registros de resumen solo existen para ejercicios cerrados y optimizados. Si se produce alguna actividad en un período fiscal que no se ha cerrado y optimizado desde entonces, no se incluirá en los registros de resumen del libro mayor.
MediaTypes Devuelve una lista de opciones de tipo de medio.
PeriodSummaries Una vez que se completa el proceso de resumen, así es como se devuelven los datos.
PeriodSummariesProcessingInfo Este extremo informa sobre el estado actual de la solicitud de resumen, ya sea que esté completa, aún en ejecución o fallida.
ProjectAttachments Devuelve la lista de archivos adjuntos para el proyecto especificado.
ProjectContactMethods Dirección de información de contactos para proyectos.
ProjectContacts Los contactos para un proyecto.
ProjectDepartments Devuelve la lista de departamentos del proyecto.
ProjectDivisions Devuelve la lista de divisiones del proyecto.
ProjectLocations Devuelve la lista de ubicaciones del proyecto.
Projects Recuperar y consultar proyectos.
ProjectStatuses Devuelve la lista de estados del proyecto.
ProjectTypes Devuelve la lista de tipos de proyectos.
TransactionCodes Devuelve la lista de todos los códigos de transacción disponibles.
TransactionCodeValues Devuelve la lista de todos los valores para el código de transacción especificado.
TransactionDistributions Devuelve una lista de transacciones que coinciden con los criterios de búsqueda
TransactionDistributionSets Devuelve la lista de conjuntos de distribución de transacciones.

CuentaCashflows

Devuelve la lista de valores de flujo de caja disponibles

Columnas
Nombre Tipo Referencias Descripción
CashflowId [KEY] Integer El identificador de flujo de caja.
Description String La descripción de este flujo de efectivo.
Value String El valor de este flujo de caja.

Códigos de Cuenta

Devuelve los códigos de cuenta.

Columnas
Nombre Tipo Referencias Descripción
AccountCodeId [KEY] Integer El identificador de este código de cuenta.
IsControl Boolean Si esta cuenta es una cuenta controlada.
IsContra Boolean Si esto es una cuenta de contra.
Category String La categoría para este código de cuenta.
Description String La descripción de este código de cuenta.
Value Integer El valor de este código de cuenta.
Class String La clase de este código de cuenta.

CuentaFondoRequisitos

Devuelve los requisitos para los fondos de la cuenta.

Columnas
Nombre Tipo Referencias Descripción
FundId [KEY] Integer CuentaFondos.IdFondo El identificador de este fondo.
Name [KEY] String El nombre de este requisito de fondo.
Type String El tipo para este requisito de fondo.
PreserveDetailsDuringClosing Boolean Si o no los requisitos de este fondo conservan los detalles durante el cierre.
RequireToBalance Boolean Si se requiere o no este fondo se requiere para equilibrar.
RequireOnAccountsSpecified String El requerimiento en las cuentas especificadas para este requerimiento de fondos.
Default String El valor predeterminado para este requisito de fondos.

CuentaFondos

Devuelve los fondos de la cuenta.

Columnas
Nombre Tipo Referencias Descripción
FundId [KEY] Integer El identificador de este fondo.
Value String El valor de este fondo.
Description String La descripción de este fondo.
BeginningBalancesLocked Datetime La fecha de cierre de los saldos iniciales para este fondo.
FundBalanceAccount String La cuenta de saldo del fondo para este fondo.

Cuentas

Recuperar y consultar cuentas.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • Id admite el operador '='. Esta columna se filtra con el ID del conjunto de informes del servidor (RSID)e cuando es el único filtro especificado en los criterios.
  • DateModified admite los siguientes operadores: >,>=.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

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

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
AccountId [KEY] Integer El identificador de esta cuenta.
AccountNumber String El número de cuenta para esta cuenta.
Class String La clase para esta cuenta.
Description String La descripción de esta cuenta.
DateModified Datetime La fecha de modificación de la cuenta.
WorkingCapital String El programa de capital de trabajo para esta cuenta.
Cashflow String El flujo de caja de esta cuenta.
PreventPostingDate Datetime Si, y la fecha después de la cual, para evitar la publicación. Rellenar este campo establecerá automáticamente el campo de prevención de entrada de datos en 'verdadero'.
ModifiedBy String El modificador de la cuenta.
DefaultTransactionCodes String Los códigos de transacción predeterminados en esta cuenta.
PreventDataEntry Boolean Si para evitar la entrada de datos. Si se proporciona una fecha para evitar la publicación, este valor se establece en verdadero.
DateAdded Datetime La fecha de creación de la cuenta.
AddedBy String El creador de la cuenta.
CustomFields String Campo personalizado: la lista de campos personalizados admitidos como columnas distintas.

Segmentos de Cuenta

Devuelve el valor del segmento de cuenta especificado.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • SegmentId admite el operador '='. Esta es la única columna admitida.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM AccountSegments WHERE SegmentId = 123

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
SegmentId [KEY] Integer Estructuras de cuenta.Id de segmento El identificador para este segmento de cuenta.
Type [KEY] String El tipo para este segmento de cuenta.
Value String Los valores para este segmento de cuenta.
Description String Las descripciones para este segmento de cuenta.

Estructuras de Cuenta

Devuelve una lista de estructuras de cuenta.

Columnas
Nombre Tipo Referencias Descripción
SegmentId [KEY] Integer El identificador para este segmento de cuenta.
Type String El tipo para este segmento de cuenta.
Length Integer La longitud de este segmento de cuenta.
Separator String El separador para este segmento de cuenta.
Sequence Integer La secuencia para este segmento de cuenta.

CuentaWorkingCapitals

Devuelve la lista de valores de capital de trabajo disponibles

Columnas
Nombre Tipo Referencias Descripción
WorkingCapitalId [KEY] Integer El identificador del valor del capital de trabajo.
Description String La descripción de este valor de capital de trabajo.
Value String El valor de este valor de capital de trabajo.

BatchValidations

Devuelve los resultados de la validación lote.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • BatchId admite el operador '='. Esta es la única columna admitida.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM BatchValidations WHERE BatchId = 123

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
BatchId [KEY] String Lotes de entrada de diario.LoteId Indica si la solicitud fue válida.
IsValid Boolean Indica si la solicitud fue válida.
Errors String La lista de errores recibidos durante la validación.

PresupuestoCuentas

Devuelve detalles para cada período fiscal y cuenta en el escenario.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • BudgetScenarioId, AccountNumber admite el operador '='. No se admite una búsqueda en blanco.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

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

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
BudgetScenarioId [KEY] Integer Presupuestos.BudgetScenarioId El ID de escenario para este presupuesto.
AccountNumber [KEY] String Cuentas.Número de cuenta El número de cuenta para este período.
BudgetCategory String La categoría de presupuesto para este período.
FiscalYear String Años fiscales.Año El año fiscal para este período.
FiscalPeriodId Integer Años fiscales.FiscalPeriodId El período fiscal.
PeriodPercent Double El porcentaje para este período.
PeriodAmount Decimal La cantidad para este período.
TotalAmount Decimal El importe total de este período.

PresupuestoDetalles

Devuelve los detalles del presupuesto especificado.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • BudgetScenarioId admite el operador '='. Esta es la única columna admitida.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM BudgetDetails WHERE BudgetScenarioId = 123

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
BudgetScenarioId [KEY] Integer Presupuestos.BudgetScenarioId El ID de escenario para este presupuesto.
ScenarioId String Presupuestos.ScenarioId El ID de escenario para este escenario de presupuesto.
BudgetType String El tipo de presupuesto para este presupuesto.
Status String El estado de este presupuesto.
Description String La descripción de este presupuesto.
Locked Boolean El estado del bloqueo para este presupuesto.
StartFiscalYear String El año fiscal de inicio para este presupuesto.
EndFiscalYear String El final del año fiscal para este presupuesto.
StartFiscalPeriod Integer El período fiscal de inicio para este presupuesto.
EndFiscalPeriod Integer El final del período fiscal para este presupuesto.
TotalExpense Double El gasto total para este presupuesto.
TotalRevenue Double Los ingresos totales de este presupuesto.
DateAdded Datetime La fecha en que se agregó este presupuesto.
AddedBy String El nombre de quién agregó este presupuesto.
DateModified Datetime La fecha en que se modificó este presupuesto.
ModifiedBy String El nombre de quien modificó este presupuesto.

BudgetFiscalPeriods

Devuelve detalles de cada período fiscal en un escenario de presupuesto.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • BudgetScenarioId admite el operador '='. Esta es la única columna admitida.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM BudgetFiscalPeriods WHERE BudgetScenarioId = 123

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
BudgetScenarioId [KEY] Integer Presupuestos.BudgetScenarioId El ID de escenario para este presupuesto.
Category [KEY] String La categoría de presupuesto para este período.
FiscalYear String Años fiscales.Año El año fiscal de este período.
FiscalPeriodId [KEY] Integer Años fiscales.FiscalPeriodId El período fiscal.
PeriodAmount Decimal La cantidad para este período.
TotalAmount Decimal El importe total de este período.

Presupuesto Subvenciones

Devuelve detalles para cada período fiscal y concesión en el escenario.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • BudgetScenarioId, Grant admite el operador '='. No se admite una búsqueda en blanco.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

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

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
BudgetScenarioId [KEY] Integer Presupuestos.BudgetScenarioId El ID de escenario para este presupuesto.
Grant [KEY] String El nombre de concesión para este período.
AccountNumber [KEY] String Cuentas.Número de cuenta El número de cuenta para este período.
BudgetCategory String La categoría de presupuesto para este período.
FiscalYear String Años fiscales.Año El año fiscal para este período.
FiscalPeriodId Integer Años fiscales.FiscalPeriodId El período fiscal.
PeriodPercent Double El porcentaje para este período.
PeriodAmount Decimal La cantidad para este período.
TotalAmount Decimal El importe total de este período.

LíneasPresupuestarias

Devuelve las líneas presupuestarias especificadas.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • BudgetScenarioId admite el operador '='. Esta es la única columna admitida.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM BudgetLines WHERE BudgetScenarioId = 123

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
BudgetScenarioId [KEY] Integer Presupuestos.BudgetScenarioId El ID de escenario para este presupuesto.
BudgetLineId [KEY] Integer El ID de línea de presupuesto.
AccountNumber String Cuentas.Número de cuenta El número de una cuenta en este presupuesto.
AccountDescription String La descripción de una cuenta en este presupuesto.
UiProjectId String El ID de proyecto definido por el usuario para esta línea presupuestaria.
ProjectDescription String La descripción de un proyecto en esta línea presupuestaria.
Notes String La nota para esta línea presupuestaria.
GrantDescription String La descripción del código de transacción {Grant}.
Total Decimal El importe total de esta línea presupuestaria.
Periods String Las distribuciones del período para esta línea presupuestaria.

PresupuestoProyectos

Devuelve detalles para cada período fiscal y proyecto en el escenario.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • BudgetScenarioId, UiProjectId admite el operador '='. No se admite una búsqueda en blanco.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

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

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
BudgetScenarioId [KEY] Integer Presupuestos.BudgetScenarioId El ID de escenario para este presupuesto.
UiProjectId [KEY] String El identificador visible para el usuario del proyecto.
BudgetCategory String La categoría de presupuesto para este período.
FiscalYear String Años fiscales.Año El año fiscal para este período.
FiscalPeriodId Integer Años fiscales.FiscalPeriodId El período fiscal.
AccountNumber String Cuentas.Número de cuenta El número de cuenta para este período.
PeriodAmount Decimal La cantidad para este período.
TotalAmount Decimal El importe total de este período.
PeriodPercent Double El porcentaje para este período.

Presupuestos

Devuelve una descripción general de nivel superior de cada escenario de presupuesto.

Columnas
Nombre Tipo Referencias Descripción
BudgetScenarioId [KEY] Integer El identificador para este escenario de presupuesto.
ScenarioId String PresupuestoEscenarios.ScenarioId El ID de escenario de este escenario de presupuesto.
Status String El estado de este escenario presupuestario.
Description String La descripción de este escenario de presupuesto.
BudgetType String El tipo para este escenario de presupuesto.
StartDate Datetime La fecha de inicio para este escenario de presupuesto.
EndDate Datetime La fecha de finalización para este escenario de presupuesto.
StartFiscalYear String El año fiscal inicial para este escenario presupuestario.
EndFiscalYear String El final del año fiscal para este escenario presupuestario.
Locked String El estado bloqueado de este escenario de presupuesto.

PresupuestoEscenarios

Devuelve detalles para cada ID de escenario.

Columnas
Nombre Tipo Referencias Descripción
ScenarioId [KEY] Integer El identificador de base de datos para el id de escenario.
Value String Breve descripción.
Inactive Boolean Si el ID del escenario está inactivo o no.
Description String Descripción larga.

CashManagementDistributionSetLineItemProjects

La distribución del proyecto para las partidas en los conjuntos de distribución de gestión de efectivo.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • SetId admite el operador '='. Esta es la única columna admitida.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM CashManagementDistributionSetLineItemProjects WHERE SetId = 123

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
SetId [KEY] Integer Conjuntos de distribución de gestión de efectivo.SetId El identificador del conjunto de distribución de gestión de efectivo.
ProjectId [KEY] Integer El identificador del proyecto para el elemento de línea.
LineNumber Integer El número de línea para el elemento de línea.
Percent Double El porcentaje que representa la distribución de la línea de pedido.
AccountClass String La clase de la cuenta para el elemento de línea.

CashManagementDistributionSets

Devuelve la lista de conjuntos de distribución de gestión de efectivo y sus partidas.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • SetId admite el operador '='. Esta es la única columna admitida.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM CashManagementDistributionSets WHERE SetId = 123

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
SetId [KEY] Integer El identificador del conjunto de distribución de gestión de efectivo.
Name String El nombre del conjunto de distribución de gestión de efectivo.
LineItemPercent Double El porcentaje del conjunto de distribución total que representa la línea de pedido.
LineItemRowNumber Integer El número de fila para el elemento de línea.
LineItemAccountId String El identificador de la cuenta para el elemento de línea.

Clases

La lista de clases

Columnas
Nombre Tipo Referencias Descripción
ClassId [KEY] Integer El identificador de clase.
Value String El valor de esta clase.
Description String La descripción de esta clase.

Nombres de Clientes

Devuelve los nombres de tipo de cliente.

Columnas
Nombre Tipo Referencias Descripción
RecordType String El nombre del tipo de registro.
ClientRecordTypeName String El nombre del cliente para este tipo de registro.

Años Fiscales

Devuelve la lista de detalles del año fiscal.

Columnas
Nombre Tipo Referencias Descripción
FiscalYearId [KEY] Integer El identificador para este año fiscal.
StartDate Datetime La fecha de inicio para este año fiscal.
Status String El estado de este año fiscal.
Year String El año de este año fiscal.
Description String La descripción de este año fiscal.
EndDate Datetime La fecha de finalización de este año fiscal.
FiscalPeriodId [KEY] Integer El identificador de este período fiscal.
FiscalPeriodStartDate Datetime La fecha de inicio de este período fiscal.
FiscalPeriodEndDate Datetime La fecha de finalización de este período fiscal.
FiscalPeriodSequence Integer La secuencia de este período fiscal.
FiscalPeriodClosed Boolean Si se cierra o no este período fiscal.

GrantCustomFields

Devuelve la lista de opciones de campos personalizados de concesión.

Columnas
Nombre Tipo Referencias Descripción
CustomFieldId [KEY] Integer El identificador de este campo personalizado.
Name String El nombre de este campo personalizado.
Type String El tipo (booleano, tabla, etc.) para este campo personalizado.
IsRequired Boolean Si este campo personalizado es obligatorio.
TableValues String Lista de valores de la tabla. Solo aplicable si tipo = 'Tabla'.

GrantStatuses

Devuelve la lista de estados de concesión.

Columnas
Nombre Tipo Referencias Descripción
Id [KEY] Integer El identificador de este valor de búsqueda.
Value String El valor de este valor de búsqueda.
Description String La descripción de este valor de búsqueda.

GrantTypes

Devuelve la lista de tipos de concesión.

Columnas
Nombre Tipo Referencias Descripción
Id [KEY] Integer El identificador de este valor de búsqueda.
Value String El valor de este valor de búsqueda.
Description String La descripción de este valor de búsqueda.

JournalCodes

Devuelve la lista de todos los códigos de diario disponibles.

Columnas
Nombre Tipo Referencias Descripción
JournalCodeId [KEY] Integer El identificador de la revista.
Code String El código abreviado de la revista.
Journal String El nombre completo de la revista.

Entradas de Diario

Recuperar y consultar entradas de diario.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • BatchId admite el operador '='. Esta es la única columna admitida.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM JournalEntries WHERE BatchId = 123

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
JournalEntryId [KEY] Integer El identificador de entrada de diario.
BatchId Integer El identificador de lote.
AccountNumber String El número de cuenta del asiento de diario.
TypeCode String El tipo de transacción del asiento de diario (débito o crédito).
Journal String El nombre completo de la revista.
LineNumber Integer El número de línea del asiento del diario.
Reference String La referencia del asiento de diario.
PostDate Datetime La fecha de publicación de la entrada del diario, en formato ISO 8601: 2016-03-14.
Amount Double El importe del asiento de diario.
Notes String Las notas del asiento del diario.
Encumbrance String El tipo de gravamen del asiento de diario.
Distributions String Las distribuciones de asientos de diario.
CustomFields String Campo personalizado: la lista de campos personalizados admitidos como columnas distintas.

Lotes de Entrada de Diario

Devuelve la lista de lotes de entradas de diario.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • BatchId admite el operador '='. Esta columna se filtra con el ID del conjunto de informes del servidor (RSID)e cuando es el único filtro especificado en los criterios.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

Select * FROM JournalEntryBatches WHERE BatchId = 123

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
BatchId [KEY] Integer El identificador de lote.
UiBatchId String El identificador visible para el usuario del lote.
Description String La descripción del lote.
BatchStatus String El estado del lote.
CreateInterfundSets Boolean Indica si el lote debe o no crear entradas entre fondos cuando se registra.
CreateBankAccountAdjustments Boolean Indica si el lote debe o no crear ajustes en la cuenta bancaria cuando se registra.
DateAdded Datetime La fecha de creación del lote.
AddedBy String El creador del lote.
DateModified Datetime La fecha de modificación del lote.
ModifiedBy String El modificador del lote.

Libro Mayorresúmenes

Enumera los resúmenes del libro mayor para el año fiscal y los criterios especificados. Tenga en cuenta que los registros de resumen solo existen para ejercicios cerrados y optimizados. Si se produce alguna actividad en un período fiscal que no se ha cerrado y optimizado desde entonces, no se incluirá en los registros de resumen del libro mayor.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • FiscalYearId, AccountNumber y UiProjectId admite el operador '='. No se admite una búsqueda en blanco.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

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

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
FiscalYearId String Años fiscales.FiscalYearId El identificador del año fiscal.
FiscalYear String Años fiscales.Año El ejercicio fiscal resumido.
AccountNumber String Cuentas.Número de cuenta El número de cuenta de las transacciones resumidas.
PeriodStartDate Datetime La fecha de inicio del período resumido.
FiscalPeriod String El período fiscal resumido.
EncumberedBeginningBalance Double El saldo de la transacción gravada al comienzo del período resumido.
EncumberedCredit Double La suma de los créditos de transacción gravados en el período resumido.
UiProjectId String El identificador del proyecto de las transacciones resumidas.
PeriodEndDate Datetime La fecha de finalización del período resumido.
TransactionCodes String Los valores del código de transacción de las transacciones resumidas.
Credit Double La suma de los créditos de transacción en el período resumido.
Debit Double La suma de los débitos de transacciones en el período resumido.
EncumberedDebit Double La suma de los débitos de las transacciones gravadas en el período resumido.
BeginningBalance Double El saldo total de la transacción al comienzo del período resumido.

Tipos de Medios

Devuelve una lista de opciones de tipo de medio.

Columnas
Nombre Tipo Referencias Descripción
TypeId [KEY] Integer El identificador para este tipo de medio.
Value String El valor del tipo de medio.
Description String La descripción del tipo de medio.

PeríodoResúmenes

Una vez que se completa el proceso de resumen, así es como se devuelven los datos.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • FiscalYear, FiscalPeriod, AccountNumber y UiProjectId admite el operador '='. No se admite una búsqueda en blanco.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

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

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
FiscalYear String Años fiscales.Año El ejercicio fiscal resumido.
FiscalPeriod String Años fiscales.PeríodoFiscal El período fiscal resumido.
AccountNumber String Cuentas.Número de cuenta El número de cuenta de las transacciones resumidas.
UiProjectId String El identificador del proyecto de las transacciones resumidas.
PeriodStartDate Datetime La fecha de inicio del período resumido.
PeriodEndDate Datetime La fecha de finalización del período resumido.
TransactionCodes String Los valores del código de transacción de las transacciones resumidas.
BeginningBalance Double El saldo total de la transacción al comienzo del período resumido.
Debit Double La suma de los débitos de transacciones en el período resumido.
Credit Double La suma de los créditos de transacción en el período resumido.
EncumberedBeginningBalance Double El saldo de la transacción gravada al comienzo del período resumido.
EncumberedCredit Double La suma de los créditos de transacción gravados en el período resumido.
EncumberedDebit Double La suma de los débitos de las transacciones gravadas en el período resumido.

PeríodoResúmenesProcesamientoInfo

Este extremo informa sobre el estado actual de la solicitud de resumen, ya sea que esté completa, aún en ejecución o fallida.

Columnas
Nombre Tipo Referencias Descripción
ProcessId [KEY] String El identificador de proceso para el proceso de resumen
FiscalPeriodId Integer Años fiscales.FiscalPeriodId El identificador del período fiscal para el proceso de resumen
Status String El estado del proceso sumario
StatusMessage String El mensaje de estado del proceso sumario

Archivos Adjuntos del Proyecto

Devuelve la lista de archivos adjuntos para el proyecto especificado.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • ProjectId admite el operador '='. Esta columna es necesaria para obtener los archivos adjuntos del proyecto.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

SELECT * FROM ProjectAttachments WHERE ProjectId = 1

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
Id Integer El identificador de archivo adjunto
ProjectId Integer El identificador del proyecto para recuperar los archivos adjuntos
Name String El nombre de este archivo adjunto
Url String La URL de este archivo adjunto
Type String El tipo de archivo adjunto. Los valores disponibles son Enlace y Físico
MediaType String Categoría definida por el usuario de este archivo adjunto
DateAttached Datetime La fecha en que se agregó el archivo adjunto

Métodos de Contacto del Proyecto

Dirección de información de contactos para proyectos.

Columnas
Nombre Tipo Referencias Descripción
ProjectId [KEY] Integer ProyectoContactos.IdProyecto El identificador de este proyecto.
ContactId [KEY] Integer ProyectoContactos.ContactId El identificador de este contacto.
ContactMethodId [KEY] Integer El identificador del método de contacto de la dirección.
ContactType String El tipo de contacto (correo, teléfono, etc).
ContactInfo String La información de contacto (dirección de correo, número de teléfono, etc.) para este método.

ProyectoContactos

Los contactos para un proyecto.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • ProjectId admite el operador '='. Esta columna es el único filtro admitido.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

SELECT * FROM ProjectContacts WHERE ProjectId = 1

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
ProjectId [KEY] Integer Proyectos.IdProyecto El identificador de este proyecto.
ContactId [KEY] Integer El identificador de este contacto.
Description String La descripción de esta dirección.
Country String El país de la dirección.
City String La ciudad para la dirección.
County String El condado de esta dirección.
State String El estado o provincia (o suburbio en Nueva Zelanda) de la dirección.
Postal String Se refiere al Código Postal o ZIP de la dirección.
Title String El título del contacto principal.
FirstName String El nombre del contacto principal.
MiddleName String La inicial del medio o el nombre del contacto principal.
LastName String El apellido del contacto principal.
Suffix String El sufijo del contacto principal.
Position String La posición del contacto principal.

ProyectoDepartamentos

Devuelve la lista de departamentos del proyecto.

Columnas
Nombre Tipo Referencias Descripción
Id [KEY] Integer El identificador de este valor de búsqueda.
Value String El valor de este valor de búsqueda.
Description String La descripción de este valor de búsqueda.

ProyectoDivisiones

Devuelve la lista de divisiones del proyecto.

Columnas
Nombre Tipo Referencias Descripción
Id [KEY] Integer El identificador de este valor de búsqueda.
Value String El valor de este valor de búsqueda.
Description String La descripción de este valor de búsqueda.

ProyectoUbicaciones

Devuelve la lista de ubicaciones del proyecto.

Columnas
Nombre Tipo Referencias Descripción
Id [KEY] Integer El identificador de este valor de búsqueda.
Value String El valor de este valor de búsqueda.
Description String La descripción de este valor de búsqueda.

Proyectos

Recuperar y consultar proyectos.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • ProjectId admite el operador '='. Esta columna se filtra con el ID del conjunto de informes del servidor (RSID)e cuando es el único filtro especificado en los criterios.
  • Location,Type,Division y Department admite el operador '='. No se admite una búsqueda en blanco.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

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

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
ProjectId [KEY] Integer El identificador de la base de datos del proyecto.
UiProjectId String El identificador visible para el usuario del proyecto.
Description String La descripción del proyecto.
Location String La ubicación del proyecto.
EndDate Datetime La fecha de finalización del proyecto, en formato ISO 8601: 2016-03-14.
StartDate Datetime La fecha de inicio del proyecto, en formato ISO 8601: 2016-03-14.
Type String El tipo de proyecto.
AddedBy String El creador del proyecto.
PostingDate Datetime La fecha después de la cual evitar la publicación, si corresponde.
PreventPostingAfter Boolean Si impide la entrada de datos, si para evitar la publicación después de una fecha determinada.
Division String La división de proyectos.
PreventDataEntry Boolean Si para evitar la entrada de datos para este proyecto.
ModifiedBy String El modificador del proyecto.
Status String El estado del proyecto.
Department String El departamento de proyectos.
AccountRestrictions String Las provisiones o restricciones de la cuenta para este proyecto.
DateAdded Datetime La fecha de creación del proyecto.
DateModified Datetime La fecha de modificación del proyecto.
CustomFields String Campo personalizado: la lista de campos personalizados admitidos como columnas distintas.

Estados del Proyecto

Devuelve la lista de estados del proyecto.

Columnas
Nombre Tipo Referencias Descripción
Id [KEY] Integer El identificador de este valor de búsqueda.
Value String El valor de este valor de búsqueda.
Description String La descripción de este valor de búsqueda.

Tipos de Proyectos

Devuelve la lista de tipos de proyectos.

Columnas
Nombre Tipo Referencias Descripción
Id [KEY] Integer El identificador de este valor de búsqueda.
Value String El valor de este valor de búsqueda.
Description String La descripción de este valor de búsqueda.

Códigos de Transacción

Devuelve la lista de todos los códigos de transacción disponibles.

Columnas
Nombre Tipo Referencias Descripción
TransactionCodeId [KEY] Integer El identificador del código de transacción.
Name String El nombre del código de la transacción.
UsedForGrants Boolean Si el código de transacción se utiliza para subvenciones.
Description String La descripción del código de transacción.

Valores de Código de Transacción

Devuelve la lista de todos los valores para el código de transacción especificado.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • TransactionCodeId admite el operador '='. Esta columna es el único filtro admitido.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

SELECT * FROM TransactionCodeValues WHERE TransactionCodeId = 1

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
TransactionCodeId Integer Códigos de transacción.TransactionCodeId El identificador del código de transacción.
Id [KEY] Integer El ID del valor del código de transacción.
Name String El nombre del código de la transacción.
Value String El valor del código de transacción.

Distribuciones de Transacciones

Devuelve una lista de transacciones que coinciden con los criterios de búsqueda.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • BatchId, AccountNumber, UiProjectId, TypeCode, Encumbrance, Journal, y PostStatus admite el operador '='. No se admite una búsqueda en blanco.
  • PostDate admite los siguientes operadores: <,<=,=,>=,>.
  • DateModified admite los siguientes operadores: >,>=.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

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

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
DistributionId [KEY] Integer El identificador de distribución.
TransactionId [KEY] Integer El identificador de la transacción.
TransactionAmount Double El monto de la transacción.
BatchId Integer Lotes de entrada de diario.LoteId El identificador de lote
DistributionAmount Double El monto de la distribución.
AccountNumber String Cuentas.Número de cuenta El número de cuenta.
AccountClass String La clase de cuenta.
UiProjectId String El identificador visible para el usuario del proyecto.
PostDate Datetime La fecha de publicación de la transacción.
TypeCode String El tipo de transacción (débito o crédito). Los valores permitidos son Débito, Crédito.
Reference String La referencia de la transacción.
Encumbrance String El tipo de gravamen de la transacción.
Journal String El nombre completo de la revista.
TransactionCodeValues String Los códigos de transacción de distribución.
DateAdded Datetime La fecha de creación de la distribución de la transacción.
AddedBy String El creador de la distribución de transacciones.
DateModified Datetime La fecha modificada de la distribución de la transacción.
ModifiedBy String El modificador de la distribución de transacciones.
PostStatus String El estado de publicación de la distribución de la transacción.

TransactionDistributionSetsTransactionDistributionSets

Devuelve la lista de conjuntos de distribución de transacciones.

El conector utilizará la API Blackbaud Financial Edge NXT para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

  • SetId admite el operador '='. Esta columna es el único filtro admitido.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

SELECT * FROM TransactionDistributionSets WHERE SetId = 1

Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Columnas
Nombre Tipo Referencias Descripción
SetId [KEY] Integer El identificador del conjunto de distribución de transacciones.
Name String El nombre del conjunto de distribución de transacciones.
LineNumber [KEY] Integer El número de línea de artículo.
LineItemPercent Double El porcentaje del conjunto de distribución total que representa la línea de pedido.
LineItemProjectId Integer El identificador del proyecto para el elemento de línea.
LineItemAccountClass String La clase de la cuenta para el elemento de línea.
LineItemTransactionCodeValues String Los valores del código de transacción para el elemento de línea.

Procedimientos Almacenados

Procedimientos almacenados* están disponibles para complementar los datos disponibles del Modelo de datos. Puede ser necesario actualizar los datos disponibles desde una vista usando un procedimiento almacenado* porque los datos no proporcionan actualizaciones bidireccionales directas, similares a tablas. En estas situaciones, la recuperación de los datos se realiza utilizando la vista o tabla adecuada, mientras que la actualización se realiza llamando a un procedimiento almacenado. Procedimientos almacenados* toman una lista de parámetros y devuelven un conjunto de datos que contiene la colección de tuplas que constituyen la respuesta.

Conector Jitterbit para Procedimientos Almacenados Blackbaud Financial Edge NXT

Nombre Descripción
GetOAuthAccessToken Obtiene un token de autenticación de Blackbaud Financial Edge NXT.
GetOAuthAuthorizationURL Obtiene la URL de autorización que el usuario debe abrir por separado para otorgar acceso a su aplicación. Solo se necesita al desarrollar aplicaciones web. Solicitará el token de autenticación de esta URL.
RefreshOAuthAccessToken Actualiza el token de acceso de OAuth utilizado para la autenticación con Blackbaud Financial Edge NXT.

Obtener Token de Acceso de OAuth

Obtiene un token de autenticación de Blackbaud Financial Edge NXT.

Aporte
Nombre Tipo Obligatorio Descripción
AuthMode String Falso El tipo de modo de autenticación a utilizar. Seleccione Aplicación para obtener tokens de autenticación a través de una aplicación de escritorio. Seleccione Web para obtener tokens de autenticación a través de una aplicación web. Los valores permitidos son APP, WEB. El valor predeterminado es APLICACIÓN.
CallbackURL String Falso Determina dónde se envía la respuesta. El valor de este parámetro debe coincidir exactamente con uno de los valores registrados en la configuración de la aplicación (incluidos los esquemas HTTP o HTTPS, mayúsculas y '/' final).
Verifier String Falso El verificador regresó de Blackbaud Financial Edge NXT después de que el usuario haya autorizado su aplicación para tener acceso a sus datos. Este valor se devolverá como parámetro a la URL de devolución de llamada en GetOAuthAuthorizationURL.
State String Falso Este campo indica cualquier estado que pueda ser de utilidad para su solicitud al recibir la respuesta. Su aplicación recibe el mismo valor que envió, ya que este parámetro realiza un viaje de ida y vuelta al servidor de autorización Blackbaud Financial Edge NXT y viceversa. Los usos posibles incluyen redirigir al usuario al recurso correcto en su sitio, usar nonces y mitigar la falsificación de solicitudes entre sitios.
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
OAuthAccessToken String El token de acceso utilizado para la comunicación con Blackbaud Financial Edge NXT.
OAuthRefreshToken String El token de actualización utilizado para el procedimiento RefreshOAuthAccessToken.

Obtener URL de Autorización de OAuth

Obtiene la URL de autorización que el usuario debe abrir por separado para otorgar acceso a su aplicación. Solo se necesita al desarrollar aplicaciones web. Solicitará el token de autenticación de esta URL.

Aporte
Nombre Tipo Obligatorio Descripción
CallbackUrl String Falso La URL a la que se redirigirá al usuario después de autorizar su aplicación. Este valor debe coincidir con la URL de redireccionamiento en la configuración de la aplicación Blackbaud Financial Edge NXT.
State String Falso Este campo indica cualquier estado que pueda ser de utilidad para su solicitud al recibir la respuesta. Su aplicación recibe el mismo valor que envió, ya que este parámetro realiza un viaje de ida y vuelta al servidor de autorización de Blackbaud y viceversa. Los usos posibles incluyen redirigir al usuario al recurso correcto en su sitio, usar nonces y mitigar la falsificación de solicitudes entre sitios.
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
URL String La URL de autorización, ingresada en un navegador web para obtener el token de verificación y autorizar su aplicación.

RefreshOAuthAccessToken

Actualiza el token de acceso de OAuth utilizado para la autenticación con Blackbaud Financial Edge NXT.

Aporte
Nombre Tipo Obligatorio Descripción
OAuthRefreshToken String Cierto El token de actualización devuelto del intercambio de código de autorización original.
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
OAuthAccessToken String El token de autenticación devuelto por Blackbaud Financial Edge NXT. Esto se puede usar en llamadas posteriores a otras operaciones para este servicio en particular.
OAuthRefreshToken String Un token que puede usarse para obtener un nuevo token de acceso.
ExpiresIn String El tiempo de vida restante en el token de acceso.

Tablas del Sistema

Puede consultar las tablas del sistema que se describen en esta sección para acceder a la información del esquema, la información sobre la funcionalidad del origen de datos y las estadísticas de operación lote.

Tablas de Esquema

Las siguientes tablas devuelven metadatos de la base de datos para Blackbaud Financial Edge NXT:

Tablas de Fuentes de Datos

Las siguientes tablas devuelven información sobre cómo conectarse y consultar la fuente de datos:

  • sys_connection_props: Devuelve información sobre las propiedades de conexión disponibles.
  • sys_sqlinfo: describe las consultas SELECT que el conector puede descargar al origen de datos.

Tablas de Información de Consulta

La siguiente tabla devuelve estadísticas de consultar para consultas de modificación de datos:

  • identidad_sys: devuelve información sobre operaciones lote o actualizaciones individuales.

Sys_catalogs

Enumera las bases de datos disponibles.

La siguiente consultar recupera todas las bases de datos determinadas por la cadena de conexión:

SELECT * FROM sys_catalogs
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos.

Sys_schemas

Enumera los esquemas disponibles.

La siguiente consultar recupera todos los esquemas disponibles:

SELECT * FROM sys_schemas
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos.
SchemaName String El nombre del esquema.

Sys_tables

Enumera las tablas disponibles.

La siguiente consultar recupera las tablas y vistas disponibles:

SELECT * FROM sys_tables
Columnas
Nombre Tipo Descripción
CatalogName String La base de datos que contiene la tabla o vista.
SchemaName String El esquema que contiene la tabla o vista.
TableName String El nombre de la tabla o vista.
TableType String El tipo de tabla (tabla o vista).
Description String Una descripción de la tabla o vista.
IsUpdateable Boolean Si la tabla se puede actualizar.

Sys_tablecolumns

Describe las columnas de las tablas y vistas disponibles.

La siguiente consultar devuelve las columnas y los tipos de datos de la tabla Cuentas:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Accounts'
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene la tabla o vista.
SchemaName String El esquema que contiene la tabla o vista.
TableName String El nombre de la tabla o vista que contiene la columna.
ColumnName String El nombre de la columna.
DataTypeName String El nombre del tipo de datos.
DataType Int32 Un número entero que indica el tipo de datos. Este valor se determina en tiempo de ejecución en función del ambiente.
Length Int32 El tamaño de almacenamiento de la columna.
DisplaySize Int32 El ancho máximo normal de la columna designada en caracteres.
NumericPrecision Int32 El número máximo de dígitos en datos numéricos. La longitud de la columna en caracteres para datos de carácter y fecha y hora.
NumericScale Int32 La escala de columna o número de dígitos a la derecha del punto decimal.
IsNullable Boolean Si la columna puede contener nulo.
Description String Una breve descripción de la columna.
Ordinal Int32 El número de secuencia de la columna.
IsAutoIncrement String Si el valor de la columna se asigna en incrementos fijos.
IsGeneratedColumn String Si se genera la columna.
IsHidden Boolean Si la columna está oculta.
IsArray Boolean Si la columna es una matriz.

Sys_procedimientos

Enumera los procedimientos almacenados disponibles.

La siguiente consultar recupera los procedimientos almacenados disponibles:

SELECT * FROM sys_procedures
Columnas
Nombre Tipo Descripción
CatalogName String La base de datos que contiene el procedimiento almacenado.
SchemaName String El esquema que contiene el procedimiento almacenado.
ProcedureName String El nombre del procedimiento almacenado.
Description String Una descripción del procedimiento almacenado.
ProcedureType String El tipo de procedimiento, como PROCEDIMIENTO o FUNCIÓN.

Sys_procedureparameters

Describe procedimiento almacenado* parámetros.

La siguiente consultar devuelve información sobre todos los parámetros de entrada para el procedimiento almacenado SelectEntries:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene el procedimiento almacenado.
SchemaName String El nombre del esquema que contiene el procedimiento almacenado.
ProcedureName String El nombre del procedimiento almacenado* que contiene el parámetro.
ColumnName String El nombre del procedimiento almacenado* parámetro.
Direction Int32 Un número entero correspondiente al tipo de parámetro: entrada (1), entrada/salida (2) o salida (4). Los parámetros de tipo de entrada/salida pueden ser tanto parámetros de entrada como de salida.
DataTypeName String El nombre del tipo de datos.
DataType Int32 Un número entero que indica el tipo de datos. Este valor se determina en tiempo de ejecución en función del ambiente.
Length Int32 El número de caracteres permitidos para los datos de caracteres. El número de dígitos permitidos para datos numéricos.
NumericPrecision Int32 La máxima precisión para datos numéricos. La longitud de la columna en caracteres para datos de carácter y fecha y hora.
NumericScale Int32 El número de dígitos a la derecha del punto decimal en datos numéricos.
IsNullable Boolean Si el parámetro puede contener nulo.
IsRequired Boolean Si el parámetro es necesario para la ejecución del procedimiento.
IsArray Boolean Si el parámetro es una matriz.
Description String La descripción del parámetro.
Ordinal Int32 El índice del parámetro.

Sys_keycolumns

Describe las claves primarias y foráneas. La siguiente consultar recupera la clave principal de la tabla Cuentas:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Accounts'
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene la clave.
SchemaName String El nombre del esquema que contiene la clave.
TableName String El nombre de la tabla que contiene la clave.
ColumnName String El nombre de la columna clave.
IsKey Boolean Si la columna es una clave principal en la tabla a la que se hace referencia en el campo TableName.
IsForeignKey Boolean Si la columna es una clave externa a la que se hace referencia en el campo TableName.
PrimaryKeyName String El nombre de la clave principal.
ForeignKeyName String El nombre de la clave foránea.
ReferencedCatalogName String La base de datos que contiene la clave principal.
ReferencedSchemaName String El esquema que contiene la clave principal.
ReferencedTableName String La tabla que contiene la clave principal.
ReferencedColumnName String El nombre de la columna de la clave principal.

Sys_foreignkeys

Describe las claves foráneas. La siguiente consultar recupera todas las claves foráneas que hacen referencia a otras tablas:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene la clave.
SchemaName String El nombre del esquema que contiene la clave.
TableName String El nombre de la tabla que contiene la clave.
ColumnName String El nombre de la columna clave.
PrimaryKeyName String El nombre de la clave principal.
ForeignKeyName String El nombre de la clave foránea.
ReferencedCatalogName String La base de datos que contiene la clave principal.
ReferencedSchemaName String El esquema que contiene la clave principal.
ReferencedTableName String La tabla que contiene la clave principal.
ReferencedColumnName String El nombre de la columna de la clave principal.
ForeignKeyType String Designa si la clave externa es una clave de importación (apunta a otras tablas) o de exportación (hace referencia desde otras tablas).

Sys_indexes

Describe los índices disponibles. Al filtrar en los índices, puede escribir consultas más selectivas con tiempos de respuesta de consultar más rápidos.

La siguiente consultar recupera todos los índices que no son claves principales:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene el índice.
SchemaName String El nombre del esquema que contiene el índice.
TableName String El nombre de la tabla que contiene el índice.
IndexName String El nombre del índice.
ColumnName String El nombre de la columna asociada con el índice.
IsUnique Boolean True si el índice es único. Falso en caso contrario.
IsPrimary Boolean True si el índice es una clave principal. Falso en caso contrario.
Type Int16 Un valor entero correspondiente al tipo de índice: estadística (0), agrupado (1), hash (2) u otro (3).
SortOrder String El orden de clasificación: A para ascender o D para descender.
OrdinalPosition Int16 El número de secuencia de la columna en el índice.

Sys_connection_props

Devuelve información sobre las propiedades de conexión disponibles y las establecidas en la cadena de conexión.

Al consultar esta tabla, se debe usar la cadena de conexión de configuración:

jdbc:cdata:financialedgenxt:config:

Esta cadena de conexión le permite consultar esta tabla sin una conexión válida.

La siguiente consultar recupera todas las propiedades de conexión que se han establecido en la cadena de conexión o se han establecido a través de un valor predeterminado:

SELECT * FROM sys_connection_props WHERE Value <> ''
Columnas
Nombre Tipo Descripción
Name String El nombre de la propiedad de conexión.
ShortDescription String Una breve descripción.
Type String El tipo de datos de la propiedad de conexión.
Default String El valor predeterminado si no se establece uno explícitamente.
Values String Una lista separada por comas de valores posibles. Se lanza un error de validación si se especifica otro valor.
Value String El valor que establezca o un valor predeterminado preconfigurado.
Required Boolean Si la propiedad es necesaria para conectarse.
Category String La categoría de la propiedad de conexión.
IsSessionProperty String Si la propiedad es una propiedad de sesión, utilizada para guardar información sobre la conexión actual.
Sensitivity String El nivel de sensibilidad de la propiedad. Esto informa si la propiedad está ofuscada en los formularios de registro y autenticación.
PropertyName String Una forma truncada en mayúsculas y minúsculas del nombre de la propiedad de conexión.
Ordinal Int32 El índice del parámetro.
CatOrdinal Int32 El índice de la categoría de parámetro.
Hierarchy String Muestra las propiedades dependientes asociadas que deben configurarse junto con esta.
Visible Boolean Informa si la propiedad está visible en la interfaz de usuario de la conexión.
ETC String Diversa información miscelánea sobre la propiedad.

Sys_sqlinfo

Describe el procesamiento de consultar SELECT que el conector puede descargar al origen de datos.

Procesamiento Colaborativo de Consultas

Al trabajar con fuentes de datos que no admiten SQL-92, puede consultar la vista sys_sqlinfo para determinar las capacidades de consultar de las APIs subyacentes, expresadas en sintaxis SQL. El conector descarga la mayor cantidad posible del procesamiento de sentencias SELECT al servidor y luego procesa el resto de la consultar en la memoria.

Descubrimiento de las Capacidades SELECT de la Fuente de Datos

A continuación se muestra un conjunto de datos de ejemplo de las capacidades de SQL. El siguiente conjunto de resultados indica la funcionalidad SELECT que el conector puede descargar en el origen de datos o en el lado del cliente del proceso. Su fuente de datos puede admitir sintaxis SQL adicional. Algunos aspectos de la funcionalidad SELECT se devuelven en una lista separada por comas si es compatible; de lo contrario, la columna contiene NO.

Nombre Descripción Valores posibles
AGGREGATE_FUNCTIONS Funciones de agregación admitidas. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Si se admite la función COUNT. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR El carácter de apertura utilizado para escapar de un identificador. [
IDENTIFIER_QUOTE_CLOSE_CHAR El carácter de cierre utilizado para escapar de un identificador. ]
SUPPORTED_OPERATORS Una lista de operadores de SQL admitidos. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Si se admite GROUP BY y, de ser así, el grado de compatibilidad. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Funciones de cadena admitidas. 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 Funciones numéricas compatibles. 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 Funciones de fecha/hora admitidas. 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 tablas omitidas durante la replicación.
REPLICATION_TIMECHECK_COLUMNS Una matriz de cadenas que contiene una lista de columnas que se usarán para verificar (en el orden dado) para usar como una columna modificada durante la replicación.
IDENTIFIER_PATTERN Valor de cadena que indica qué cadena es válida para un identificador.
SUPPORT_TRANSACTION Indica si el proveedor admite transacciones como compromiso y reversión. YES, NO
DIALECT Indica el dialecto SQL a usar.
KEY_PROPERTIES Indica las propiedades que identifican la base de datos uniforme.
SUPPORTS_MULTIPLE_SCHEMAS Indica si pueden existir varios esquemas para el proveedor. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indica si pueden existir varios catálogos para el proveedor. YES, NO
DATASYNCVERSION La versión de sincronización de datos necesaria para acceder a este controlador. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY La categoría Sincronización de datos de este controlador. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Si se admite la funcionalidad de SQL mejorada más allá de lo que ofrece la API. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Si se admiten las operaciones lote. YES, NO
SQL_CAP Todas las funciones de SQL admitidas para este controlador. 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 Un valor de cadena especifica las cacheOptions preferidas.
ENABLE_EF_ADVANCED_QUERY Indica si el controlador admite directamente consultas avanzadas provenientes de Entity Framework. De lo contrario, las consultas se manejarán del lado del cliente. YES, NO
PSEUDO_COLUMNS Una matriz de cadenas que indica las pseudocolumnas disponibles.
MERGE_ALWAYS Si el valor es verdadero, el modo de combinación se ejecuta a la fuerza en la sincronización de datos. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY Una consultar de selección para devolver la fecha y hora de inicio de la réplica.
REPLICATION_MIN_FUNCTION Permite que un proveedor especifique el nombre de la fórmula que se usará para ejecutar un min del lado del servidor.
REPLICATION_START_DATE Permite que un proveedor especifique una fecha de inicio de réplica.
REPLICATION_MAX_DATE_QUERY Una consultar de selección para devolver la fecha y hora de finalización de la réplica.
REPLICATION_MAX_FUNCTION Permite que un proveedor especifique el nombre de la fórmula que se usará para ejecutar un máx. del lado del servidor.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE Una lista de tablas que omitirán dividir la réplica en fragmentos en la réplica inicial.
CHECKCACHE_USE_PARENTID Indica si la instrucción CheckCache debe realizarse en la columna de clave principal. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indica procedimientos almacenados* que se puede utilizar para generar archivos de esquema.

La siguiente consultar recupera los operadores que se pueden usar en la cláusula WHERE:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Tenga en cuenta que las tablas individuales pueden tener diferentes limitaciones o requisitos en la cláusula WHERE; consulte el Modelo de datos para obtener más información.

Columnas
Nombre Tipo Descripción
NAME String Un componente de la sintaxis SQL o una capacidad que se puede procesar en el servidor.
VALUE String Detalles sobre el SQL o la sintaxis de SQL admitidos.

Sys_identidad

Devuelve información sobre los intentos de modificación.

La siguiente consultar recupera los Id. de las filas modificadas en una operación lote:

SELECT * FROM sys_identity
Columnas
Nombre Tipo Descripción
Id String El ID generado por la base de datos devuelto de una operación de modificación de datos.
Batch String Un identificador para el lote. 1 para una sola operación.
Operation String El resultado de la operación en el lote: INSERTADO, ACTUALIZADO o ELIMINADO.
Message String ÉXITO o un mensaje de error si falla la actualización en el lote.

Propiedades de Configuraciones Avanzadas

Las propiedades de configuraciones avanzadas son las diversas opciones que se pueden utilizar para establecer una conexión. Esta sección proporciona una lista completa de las opciones que puede configurar. Haga clic en los enlaces para obtener más detalles.

OAuth

Propiedad Descripción
InitiateOAuth Establezca esta propiedad para iniciar el proceso para obtener o actualizar el token de acceso de OAuth cuando se conecte.
OAuthClientId El ID de cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.
OAuthClientSecret El secreto del cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.
OAuthAccessToken El token de acceso para conectarse mediante OAuth.
SubscriptionKey Clave de suscripción que proporciona acceso a la API. Encontrado en tu perfil.
CallbackURL La URL de devolución de llamada de OAuth a la que volver cuando se autentica. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.
OAuthVerifier El código verificador devuelto desde la URL de autorización de OAuth.
OAuthRefreshToken El token de actualización de OAuth para el token de acceso de OAuth correspondiente.
OAuthExpiresIn La vida útil en segundos del AccessToken de OAuth.
OAuthTokenTimestamp La marca de tiempo de la época de Unix en milisegundos cuando se creó el token de acceso actual.

SSL

Propiedad Descripción
SSLServerCert El certificado que se aceptará del servidor al conectarse mediante TLS/SSL.

Esquema

Propiedad Descripción
Location Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados.
BrowsableSchemas Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA, TablaB, TablaC.
Views Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA, VistaB, VistaC.

Misceláneas

Propiedad Descripción
MaxRows Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.
Other Estas propiedades ocultas se usan solo en casos de uso específicos.
PageSize El número de resultados a devolver por página de datos recuperados de Blackbaud Financial Edge NXT.
PseudoColumns Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.
Timeout El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.

OAuth

Esta sección proporciona una lista completa de las propiedades de OAuth que puede configurar.

Propiedad Descripción
InitiateOAuth Establezca esta propiedad para iniciar el proceso para obtener o actualizar el token de acceso de OAuth cuando se conecte.
OAuthClientId El ID de cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.
OAuthClientSecret El secreto del cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.
OAuthAccessToken El token de acceso para conectarse mediante OAuth.
SubscriptionKey Clave de suscripción que proporciona acceso a la API. Encontrado en tu perfil.
CallbackURL La URL de devolución de llamada de OAuth a la que volver cuando se autentica. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.
OAuthVerifier El código verificador devuelto desde la URL de autorización de OAuth.
OAuthRefreshToken El token de actualización de OAuth para el token de acceso de OAuth correspondiente.
OAuthExpiresIn La vida útil en segundos del AccessToken de OAuth.
OAuthTokenTimestamp La marca de tiempo de la época de Unix en milisegundos cuando se creó el token de acceso actual.

Iniciar OAuth

Establezca esta propiedad para iniciar el proceso para obtener o actualizar el token de acceso de OAuth cuando se conecte.

Valores Posibles

OFF, GETANDREFRESH, REFRESH

Tipo de Datos

string

Valor por Defecto

"OFF"

Observaciones

Las siguientes opciones están disponibles:

  1. OFF: Indica que el flujo de OAuth será manejado en su totalidad por el usuario. Se requerirá un OAuthAccessToken para la autenticación.
  2. GETANDREFRESH: indica que el conector manejará todo el flujo de OAuth. Si actualmente no existe ningún token, se obtendrá solicitándolo al usuario a través del navegador. Si existe un token, se actualizará cuando corresponda.
  3. REFRESH: indica que el conector solo manejará la actualización de OAuthAccessToken. El conector nunca le pedirá al usuario que se autentique a través del navegador. El usuario debe manejar la obtención de OAuthAccessToken y OAuthRefreshToken inicialmente.

OAuthClientId

El ID de cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Como parte del registro de una aplicación OAuth, recibirá el OAuthClientId valor, a veces también llamado clave de consumidor, y un secreto de cliente, el OAuthClientSecret.

OAuthClientSecretOAuthClientSecret

El secreto del cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Como parte del registro de una aplicación OAuth, recibirá el OAuthClientId, también denominada clave de consumidor. También recibirá un secreto de cliente, también llamado secreto de consumidor. Establezca el secreto del cliente en OAuthClientSecret propiedad.

Token de Acceso de OAuth

El token de acceso para conectarse mediante OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El OAuthAccessToken la propiedad se usa para conectarse usando OAuth. El OAuthAccessToken se recupera del servidor OAuth como parte del proceso de autenticación. Tiene un tiempo de espera dependiente del servidor y se puede reutilizar entre solicitudes.

El token de acceso se utiliza en lugar de su nombre de usuario y contraseña. El token de acceso protege sus credenciales manteniéndolas en el servidor.

Clave de Suscripción

Clave de suscripción que proporciona acceso a la API. Encontrado en tu perfil.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Clave de suscripción que proporciona acceso a la API. Encontrado en tu perfil.

URL de Devolución de Llamada

La URL de devolución de llamada de OAuth a la que volver cuando se autentica. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Durante el proceso de autenticación, el servidor de autorización de OAuth redirige al usuario a esta URL. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.

OAuthVerifier

El código verificador devuelto desde la URL de autorización de OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El código verificador devuelto desde la URL de autorización de OAuth. Esto se puede usar en sistemas en los que no se puede iniciar un navegador, como los sistemas sin cabeza.

Autenticación en Máquinas Sin Cabeza

Ver para obtener el OAuthVerifier valor.

Establezca OAuthSettingsLocation junto con OAuthVerifier. Cuando se conecta, el conector intercambia el OAuthVerifier para los tokens de autenticación de OAuth y los guarda, encriptados, en el archivo especificado. Establecer Iniciar OAuth para GETANDREFRESH automatizar el intercambio.

Una vez que se haya generado el archivo de configuración de OAuth, puede eliminar OAuthVerifier desde las propiedades de conexión y conéctese con OAuthSettingsLocation colocar.

Para actualizar automáticamente los valores del token de OAuth, establezca OAuthSettingsLocation y además configure InitiateOAuth refrescar.

OAuthRefreshToken

El token de actualización de OAuth para el token de acceso de OAuth correspondiente.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El OAuthRefreshToken la propiedad se usa para actualizar el OAuthAccessToken al usar la autenticación OAuth.

OAuthExpiresIn

La vida útil en segundos del AccessToken de OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Empareje con OAuthTokenTimestamp para determinar cuándo caducará el AccessToken.

OAuthTokenTimestamp

La marca de tiempo de la época de Unix en milisegundos cuando se creó el token de acceso actual.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Emparéjese con OAuthExpiresIn para determinar cuándo expirará AccessToken.

SSL

Esta sección proporciona una lista completa de las propiedades SSL que puede configurar.

Propiedad Descripción
SSLServerCert El certificado que se aceptará del servidor al conectarse mediante TLS/SSL.

SSLServerCert

El certificado que se aceptará del servidor al conectarse mediante TLS/SSL.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Si usa una conexión TLS/SSL, esta propiedad se puede usar para especificar el certificado TLS/SSL que se aceptará del servidor. Se rechaza cualquier otro certificado que no sea de confianza para la máquina.

Esta propiedad puede tomar las siguientes formas:

Descripción Ejemplo
Un certificado PEM completo (ejemplo abreviado por brevedad) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
Una ruta a un archivo local que contiene el certificado C:\cert.cer
La clave pública (ejemplo abreviado por brevedad) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
La huella digital MD5 (los valores hexadecimales también pueden estar separados por espacios o dos puntos) ecadbdda5a1529c58a1e9e09828d70e4
La huella digital SHA1 (los valores hexadecimales también pueden estar separados por espacios o dos puntos) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Si no se especifica, se acepta cualquier certificado en el que confíe la máquina.

La máquina valida los certificados como confiables según el almacén de confianza del sistema. El almacén de confianza utilizado es el valor 'javax.net.ssl.trustStore' especificado para el sistema. Si no se especifica ningún valor para esta propiedad, se utiliza el almacén de confianza predeterminado de Java (por ejemplo, JAVA_HOME\lib\security\cacerts).

Use '*' para indicar que acepta todos los certificados. Tenga en cuenta que esto no se recomienda debido a problemas de seguridad.

Esquema

Esta sección proporciona una lista completa de propiedades de esquema que puede configurar.

Propiedad Descripción
Location Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados.
BrowsableSchemas Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA, TablaB, TablaC.
Views Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA, VistaB, VistaC.

Ubicación

Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados.

Tipo de Datos

string

Valor por Defecto

"%APPDATA%\\\FinancialEdgeNXT Data Provider\\Schema"

Observaciones

La ruta a un directorio que contiene los archivos de esquema para el conector (archivos .rsd para tablas y vistas, archivos .rsb para procedimientos almacenados). La ubicación de la carpeta puede ser una ruta relativa desde la ubicación del ejecutable. El Location La propiedad solo es necesaria si desea personalizar las definiciones (por ejemplo, cambiar el nombre de una columna, ignorar una columna, etc.) o ampliar el modelo de datos con nuevas tablas, vistas o procedimientos almacenados.

Si no se especifica, la ubicación predeterminada es "%APPDATA%\\FinancialEdgeNXT Data Provider\Schema" con %APPDATA% estando configurado en el directorio de configuración del usuario:

Plataforma %APPDATA%
Windows El valor de la variable de ambiente APPDATA
Mac ~/Biblioteca/Soporte de aplicaciones
Linux ~/.config

Esquemas Navegables

Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Enumerar los esquemas de las bases de datos puede resultar costoso. Proporcionar una lista de esquemas en la cadena de conexión mejora el rendimiento.

Mesas

Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA,TablaB,TablaC.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Listar las tablas de algunas bases de datos puede resultar costoso. Proporcionar una lista de tablas en la cadena de conexión mejora el rendimiento del conector.

Esta propiedad también se puede utilizar como una alternativa a la lista automática de vistas si ya sabe con cuáles quiere trabajar y, de lo contrario, habría demasiadas para trabajar.

Especifique las tablas que desea en una lista separada por comas. Cada tabla debe ser un identificador SQL válido con cualquier carácter especial escapado usando corchetes, comillas dobles o acentos graves. Por ejemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Tenga en cuenta que al conectarse a una fuente de datos con varios esquemas o catálogos, deberá proporcionar el nombre completo de la tabla en esta propiedad, como en el último ejemplo aquí, para evitar la ambigüedad entre las tablas que existen en varios catálogos o esquemas.

Puntos de Vista

Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA,VistaB,VistaC.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Listar las vistas de algunas bases de datos puede ser costoso. Proporcionar una lista de vistas en la cadena de conexión mejora el rendimiento del conector.

Esta propiedad también se puede utilizar como una alternativa a la lista automática de vistas si ya sabe con cuáles quiere trabajar y, de lo contrario, habría demasiadas para trabajar.

Especifique las vistas que desee en una lista separada por comas. Cada vista debe ser un identificador SQL válido con cualquier carácter especial escapado usando corchetes, comillas dobles o acentos graves. Por ejemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Tenga en cuenta que al conectarse a una fuente de datos con varios esquemas o catálogos, deberá proporcionar el nombre completo de la tabla en esta propiedad, como en el último ejemplo aquí, para evitar la ambigüedad entre las tablas que existen en varios catálogos o esquemas.

Misceláneas

Esta sección proporciona una lista completa de propiedades misceláneas que puede configurar.

Propiedad Descripción
MaxRows Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.
Other Estas propiedades ocultas se usan solo en casos de uso específicos.
PageSize El número de resultados a devolver por página de datos recuperados de Blackbaud Financial Edge NXT.
PseudoColumns Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.
Timeout El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.

Filas Máximas

Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.

Tipo de Datos

int

Valor por Defecto

-1

Observaciones

Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.

Otro

Estas propiedades ocultas se usan solo en casos de uso específicos.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Las propiedades enumeradas a continuación están disponibles para casos de uso específicos. Los casos de uso y la funcionalidad normales del controlador no deberían requerir estas propiedades.

Especifique varias propiedades en una lista separada por punto y coma.

Integración y Formateo
Propiedad Descripción
DefaultColumnSize Establece la longitud predeterminada de los campos de cadena cuando la fuente de datos no proporciona la longitud de columna en los metadatos. El valor predeterminado es 2000.
ConvertDateTimeToGMT Determina si se convierten los valores de fecha y hora a GMT, en lugar de la hora local de la máquina.
RecordToFile=filename Registra la transferencia de datos del socket subyacente al archivo especificado.

Tamaño de Página

El número de resultados a devolver por página de datos recuperados de Blackbaud Financial Edge NXT.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El tamaño de la página se determinará automáticamente si no lo configura manualmente. Por lo general, no es necesario establecer nunca este valor.

Pseudocolumnas

Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Esta configuración es particularmente útil en Entity Framework, que no le permite establecer un valor para una pseudocolumna a menos que sea una columna de tabla. El valor de esta configuración de conexión tiene el formato "Tabla1=Columna1, Tabla1=Columna2, Tabla2=Columna3". Puede usar el carácter "*" para incluir todas las tablas y todas las columnas; por ejemplo, "*=*".

Se Acabó el Tiempo

El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.

Tipo de Datos

int

Valor por Defecto

60

Observaciones

Si Timeout = 0, las operaciones no expiran. Las operaciones se ejecutan hasta que se completan correctamente o hasta que encuentran una condición de error.

Si Timeout caduca y la operación aún no se ha completado, el conector genera una excepción.