Detalles de Conexión de la Active Campaign¶

Introducción¶

Versión del conector

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

Empezando¶

Compatibilidad con la versión de Active Campaign

El conector aprovecha la API de Active Campaign para habilitar el acceso bidireccional a Active Campaign.

Establecer una Conexión¶

Conexión a ActiveCampaign¶

ActiveCampaign admite la autenticación con la clave API. Para conectarse a ActiveCampaign, configure lo siguiente:

• URL: Esto se puede encontrar en su cuenta en el My Settings página debajo de Developer pestaña. Por ejemplo: *https://{yourAccountName}.api-us1.com*
• APIKey: Esto se puede encontrar en su cuenta en el Settings página debajo de Developer pestaña. Cada usuario de su cuenta de ActiveCampaign tiene su propia clave API única.

Modelo de Datos¶

Descripción general

El conector modela recursos de ActiveCampaign como contactos, cuentas como tablas relacionales, lo que le permite escribir SQL para consultar datos de ActiveCampaign.

La conectividad en vivo con estos objetos significa que cualquier cambio en su cuenta de ActiveCampaign se refleja de inmediato al usar el conector.

Puntos de vista

Puntos de vista son tablas que no se pueden modificar. Por lo general, los datos que son de solo lectura y no se pueden actualizar se muestran como vistas.

Vistas dinámicas

Junto con las vistas estáticas predeterminadas, el conector también permite realizar consultas en vistas dinámicas.

Estas son vistas que se crean en función de las "listas" (también llamadas "audiencias") en su cuenta de ActiveCampaign.
Por ejemplo, suponga que tiene estas 3 listas en su cuenta: Lista maestra de contactos, Nueva audiencia, Lista VIP.

El conector enumera 3 vistas basadas en ellas: List_MasterList, List_New Audience, List_VIP List.
Las vistas devuelven datos sobre cada contacto que es miembro de esa lista específica.

Mesas

Mesas describe las tablas disponibles. Las tablas se definen estáticamente para modelar recursos como cuentas, negocios, grupos de negocios, etapas de negocios, tareas, etc.

El conector también admite tablas de consulta como AccountCustomFieldData, DealCustomFieldData, ContactCustomFieldData, que representan información de datos de campos personalizados.

Además, el conector admite la actualización, la inserción de datos de campos personalizados desde el recurso principal (disponible para las tablas Cuentas, Contactos, Tratos) donde los campos personalizados se agregan dinámicamente como columnas de recursos principales. Consulte la sección de tablas específicas para obtener más información.

Mesas¶

El conector modela los datos en ActiveCampaign en una lista de tablas que se pueden consultar mediante instrucciones SQL estándar.

Generalmente, consultar tablas de ActiveCampaign es lo mismo que consultar una tabla en una base de datos relacional. A veces hay casos especiales, por ejemplo, incluir una determinada columna en la cláusula WHERE puede ser necesario para obtener datos para ciertas columnas de la tabla. Esto suele ser necesario para situaciones en las que se debe realizar una solicitud separada para cada fila para obtener ciertas columnas. Estos tipos de situaciones están claramente documentados en la parte superior de la página de la tabla vinculada a continuación.

Conector Jitterbit para Tablas ActiveCampaign¶

CuentaContactos¶

Información de uso para la operación AccountContacts.rsd.

Información Específica de la Tabla¶

Seleccionar¶

El conector usa la API de ActiveCampaign para procesar algunos de los filtros.

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

SELECT * FROM AccountContacts WHERE Id = 10003

SELECT * FROM AccountContacts WHERE AccountId = 1 AND ContactId = 100

Insertar¶

Insertar una asociación cuenta-contacto requiere especificar un valor para las columnas AccountId y ContactId.

INSERT INTO AccountContacts (AccountId, ContactId) VALUES (2, 300)

INSERT INTO AccountContacts (AccountId, ContactId, Jobtitle) VALUES (2, 300, 'nurse')

Actualizar¶

El controlador admite la actualización de la información de contacto de la cuenta.

UPDATE AccountContacts SET ContactId = 3, JobTitle = 'updatedJobTitle' WHERE Id = 1

UPDATE AccountContacts SET JobTitle = 'updatedJobTitle' WHERE AccountId = 1

Borrar¶

Elimine todas las asociaciones de contactos de cuenta o una asociación especificando el ID de la asociación.

DELETE FROM AccountContacts WHERE ID = 10003

Columnas¶

AccountCustomFieldData¶

Cree, modifique, elimine y consultar los datos de campos personalizados de acuerdos disponibles en ActiveCampaign.

Información Específica de la Tabla¶

Seleccionar¶

El conector usa la API de ActiveCampaign para procesar algunos de los filtros.

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

SELECT * FROM AccountCustomFieldData WHERE Id = 10003

SELECT * FROM AccountCustomFieldData WHERE AccountId = 1

Insertar¶

Insertar los datos de un campo personalizado de cuenta requiere especificar un valor para las columnas AccountId, CustomFieldId, FieldValue.

Además, el conector admite la inserción de datos de campos personalizados de cuenta desde la tabla Cuentas. Vea Cuentas para más información.

INSERT INTO AccountCustomFieldData (FieldValue, CustomFieldId, AccountId) VALUES ('custom field value',1,5)

Actualizar¶

El conector admite la actualización de la información de datos de campos personalizados de la cuenta. Actualizar los datos de un campo personalizado de cuenta requiere especificar un valor para las columnas ID y CustomFieldId.

Además, es posible actualizar los datos de los campos personalizados de la cuenta desde la tabla Cuentas.

UPDATE AccountCustomFieldData SET FieldValue = 'Custom Field Value' WHERE ID = 13 AND CustomFieldId = 1

Borrar¶

El conector admite la eliminación de datos de campos personalizados de cuentas.

DELETE FROM AccountcustomFieldData WHERE ID = 10

Columnas¶

Cuentas¶

Vea muchos o todos los contactos incluyendo sus ID o varios filtros.

Información Específica de la Tabla¶

Seleccionar¶

El conector usa la API de ActiveCampaign para procesar algunos de los filtros.

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

SELECT * FROM Accounts WHERE Id = 10003

SELECT * FROM Accounts WHERE Name = 'testAccount'

Como nota, debido a problemas de rendimiento del lado del servidor, incluso cuando la propiedad IncludeCustomFields se establece en TRUE, los campos personalizados aparecerán solo en el esquema de la tabla con valores nulos. Para recuperar los valores de los campos personalizados, consulte AccountCustomFieldData mesa.

Insertar¶

Insertar una cuenta requiere especificar el nombre de la cuenta.

INSERT INTO Accounts (Name) VALUES ('testAccount2')

INSERT INTO Accounts (Name,AccountUrl) VALUES ('account','http://accountUrl.com/')

Además, el conector admite la inserción de datos de cuentas y campos personalizados de cuentas desde la tabla Cuentas. Todas las columnas de campos personalizados comienzan con CF_.

INSERT INTO Accounts (Name,CF_Description,CF_Hidden,CF_Number) VALUES ('testAccount3','custom field value','custom field value',123)

Actualizar¶

El conector admite la actualización de la información de la cuenta.

Además, es posible actualizar los datos de los campos personalizados de la cuenta desde la tabla Cuentas.

UPDATE Accounts SET Name = 'updatedName',AccountUrl = 'http://updatedAccountUrl.com/' WHERE Id = 1

UPDATE Accounts SET Name = 'updatedName',CF_Description = 'custom field value', CF_Hidden = 'custom field value' WHERE ID = 1

Borrar¶

Elimine todas las cuentas o una cuenta especificando el ID de la cuenta.

DELETE FROM Accounts WHERE ID = 10003

Columnas¶

ContactoCustomFieldData¶

Cree, modifique, elimine y consultar los datos de campos personalizados de contactos disponibles en ActiveCampaign.

Información Específica de la Tabla¶

Seleccionar¶

El conector usa la API de ActiveCampaign para procesar algunos de los filtros.

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

SELECT * FROM ContactCustomFieldData WHERE Id = 10003

SELECT * FROM ContactCustomFieldData WHERE FieldValue = 'custom field value'

Insertar¶

Insertar los datos de un campo personalizado de contacto requiere especificar un valor para las columnas ContactId, FieldId, FieldValue.

Además, el conector admite la inserción de datos de campos personalizados de contacto desde la tabla Contactos. Vea Contactos para más información.

INSERT INTO ContactCustomFieldData (FieldValue, FieldId, ContactId) VALUES ('custom field value',1,5)

Actualizar¶

El conector admite la actualización de la información de datos de campos personalizados de contactos. La actualización de los datos del campo personalizado de contacto requiere la especificación de un valor para las columnas Id, ContactId y FieldId.

Además, es posible actualizar los datos de los campos personalizados de contacto desde la tabla Contactos.

UPDATE ContactCustomFieldData SET FieldValue = 'custom field value' WHERE ID = 8 AND ContactId = 3 AND FieldId = 2"

Borrar¶

El conector admite la eliminación de datos de campos personalizados de contactos.

DELETE FROM ContactCustomFieldData WHERE ID = 10

Columnas¶

Contactos¶

Vea muchos o todos los contactos incluyendo sus ID o varios filtros.

Información Específica de la Tabla¶

Seleccionar¶

El conector usa la API de ActiveCampaign para procesar algunos de los filtros.

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

SELECT * FROM Contacts WHERE Id = 10

SELECT * FROM Contacts WHERE Udate >= '2019-06-30T10:44:34-05:00'

SELECT * FROM Contacts WHERE Udate <= '2021-06-30T10:44:34-05:00'

SELECT * FROM Contacts WHERE Cdate >= '2019-06-30T10:44:34-05:00' AND Cdate <= '2021-06-30T10:44:34-05:00'

Como nota, debido a problemas de rendimiento del lado del servidor, incluso cuando la propiedad IncludeCustomFields se establece en TRUE, los campos personalizados aparecerán solo en el esquema de la tabla con valores nulos. Para recuperar los valores de los campos personalizados, consulte ContactCustomFieldData mesa.

Insertar¶

Insertar un contacto requiere especificar el correo de contacto.

INSERT INTO Contacts (Email) VALUES ('testcontact@test.com')

INSERT INTO Contacts (Email,FirstName,LastName,Phone) VALUES ('test@test.com','test','test','contactphonenumber')

Además, el conector admite la inserción de datos de contacto y campos personalizados de contacto desde la tabla Contactos. Todas las columnas de campos personalizados comienzan con CF_.

INSERT INTO Contacts (Name,CF_Description,CF_Hidden,CF_Number) VALUES ('testcontact3','custom field value','custom field value',123)

Actualizar¶

El conector admite la actualización de la información de contacto.

Además, es posible actualizar los datos de los campos personalizados de contacto desde la tabla Contactos.

UPDATE Contacts SET FirstName = 'updatedName' WHERE Id = 1

UPDATE Contacts SET CF_CustomField1 = 'custom field value', CF_CustomField2 = 'custom field value' WHERE ID = 1

Contactos de Importación Masiva¶

El conector admite cargar una gran cantidad de contactos en su cuenta. Esta operación incluye:

• Creación de nuevos contactos.
• Actualización de contactos existentes
• Suscripción y baja de listas

Los contactos se importan en lotes de hasta 250 elementos. No se recomienda utilizar el importador para una pequeña cantidad de contactos. Puede importar contactos de la siguiente manera:

INSERT INTO Contacts#Temp (Email) VALUES ('email1@test.com')

INSERT INTO Contacts#Temp (Email) VALUES ('email2@test.com')

UPSERT INTO Contacts (Email) SELECT Email FROM Contacts#Temp

Además, el conector admite BULK INSERT para la tabla de contactos. Tenga en cuenta que esta operación generará un costo en el rendimiento ya que el conector valida si los contactos enviados existen antes de importarlos.

INSERT INTO Contacts#Temp (Email) VALUES ('email1@test.com')

INSERT INTO Contacts#Temp (Email) VALUES ('email2@test.com')

INSERT INTO Contacts (Email) SELECT Email FROM Contacts#Temp

Para suscribir y cancelar la suscripción de contactos de una lista específica, establezca un valor para las columnas SubscribeTo y/o UnsubcribeFrom que aceptan una lista separada por comas de ID de lista. Por ejemplo:

INSERT INTO Contacts#Temp (Email, SubscribeTo, UnsubcribeFrom) VALUES ('email1@test.com','1,2','6,12')

INSERT INTO Contacts#Temp (Email, SubscribeTo, UnsubcribeFrom) VALUES ('email2@test.com','3,7','6,1')
UPSERT INTO Contacts (Email, SubscribeTo, UnsubcribeFrom) SELECT Email, SubscribeTo, UnsubcribeFrom FROM Contacts#Temp

Los contactos deben cumplir todos los criterios siguientes para poder crearlos o actualizarlos con esta API:

• Los contactos importados no pueden exceder el límite de su cuenta
• El contacto debe tener una dirección de correo
• La dirección de correo del contacto no debe estar en una lista de exclusión
• El correo del contacto no debe estar en una lista de direcciones de correo rebotadas
• El contacto no debe haberse dado de baja de una lista a la que la importación lo agregaría.

Si los contactos no cumplen con todos estos requisitos, el importador los omitirá.

Borrar¶

Elimine todos los contactos o un contacto especificando la ID del contacto.

DELETE FROM Contacts WHERE ID = 10003

Columnas¶

DealCustomFieldData¶

Cree, modifique, elimine y consultar los datos de campos personalizados de acuerdos disponibles en ActiveCampaign.

Información Específica de la Tabla¶

Seleccionar¶

El conector usa la API de ActiveCampaign para procesar algunos de los filtros.

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

SELECT * FROM DealCustomFieldData WHERE Id = 10003

SELECT * FROM DealCustomFieldData WHERE DealId = 1

Insertar¶

Insertar los datos de un campo personalizado de trato requiere especificar un valor para las columnas DealId, CustomFieldId y FieldValue.

Además, el conector admite la inserción de datos de campos personalizados de negocios desde la tabla Negocios. Vea Ofertas para más información.

INSERT INTO DealCustomFieldData (FieldValue, CustomFieldId, DealId) VALUES ('custom field value',1,5)

Actualizar¶

El conector admite la actualización de la información de datos de campos personalizados de acuerdos. La actualización de los datos del campo personalizado del trato requiere la especificación de un valor para las columnas Id, DealId y CustomFieldId.

Además, es posible actualizar los datos de los campos personalizados de ofertas desde la tabla Ofertas.

UPDATE DealCustomFieldData SET FieldValue = 'custom field value' WHERE ID = 8 AND DealId = 3 AND CustomFieldId = 2

Borrar¶

El conector admite la eliminación de datos de campos personalizados de negocios.

DELETE FROM DealCustomFieldData WHERE ID = 10

Columnas¶

Grupos de Ofertas¶

Enumera todas las cuentas existentes.

Información Específica de la Tabla¶

Seleccionar¶

El conector usa la API de ActiveCampaign para procesar algunos de los filtros.

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

SELECT * FROM DealGroups WHERE Id = 10003

SELECT * FROM DealGroups WHERE Title = 'title'

Insertar¶

Insertar una canalización/grupo de negocios requiere especificar un valor para las columnas Moneda, Título.

INSERT INTO DealGroups (Currency, Title) VALUES (2,300)

INSERT INTO DealGroups (Currency, Title, AutoAssign, AllUsers, AllGroups) VALUES ('USD','title',1,0,1)

Actualizar¶

El conector admite la actualización de la información de canalización/grupo de acuerdos.

UPDATE DealGroups SET AllUsers = 0, AllGroups = 1, Currency = 'EUR' WHERE Id = 1

Borrar¶

Elimine todas las canalizaciones o una canalización especificando el ID del grupo de trato.

DELETE FROM DealGroups WHERE ID = 10003

Columnas¶

Ofertas¶

Información de uso para la operación Deals.rsd.

Información Específica de la Tabla¶

Seleccionar¶

El conector usa la API de ActiveCampaign para procesar algunos de los filtros.

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

SELECT * FROM Deals WHERE Id = 10

SELECT * FROM Deals WHERE GroupId = 1

SELECT * FROM Deals WHERE OwnerId = 1

SELECT * FROM Deals WHERE Stage = 1 AND Title = 'title'

Como nota, debido a problemas de rendimiento del lado del servidor, incluso cuando la propiedad IncludeCustomFields se establece en TRUE, los campos personalizados aparecerán solo en el esquema de la tabla con valores nulos. Para recuperar los valores de los campos personalizados, consulte DealCustomFieldData mesa.

Insertar¶

Para insertar un trato, es necesario especificar un valor para las columnas GroupId, Stage, OwnerId, Title, Value, Currency y un valor para las columnas AccountId o ContactId.

INSERT INTO Deals (AccountId, GroupId, Stage, OwnerId, Title, Value, Currency) VALUES (1,1,1,1,'title',100,'USD')

INSERT INTO Deals (Email, FirstName, LastName, Phone) VALUES ('test@test.com' ,'test', 'test', 'dealphonenumber')

Además, el conector admite la inserción de datos de tratos y campos personalizados de tratos de la tabla Tratos. Todas las columnas de campos personalizados comienzan con CF_.

INSERT INTO Deals (AccountId, GroupId, Stage, OwnerId, Title, Value, Currency, CF_CustomField1,CF_CustomField2, CF_CustomField3) VALUES (1,1,1,1,'title',100,'USD','value','value','value')

Actualizar¶

El conector admite la actualización de la información del trato.

Además, es posible actualizar los datos de los campos personalizados de ofertas desde la tabla Ofertas.

UPDATE Deals SET Title = 'updatedTitle' WHERE Id = 1

UPDATE Deals SET CF_CustomField1 = 'custom field value', CF_CustomField2 = 'custom field value' WHERE ID = 1

Borrar¶

Elimine todas las ofertas o una oferta especificando el ID de la oferta.

DELETE FROM Deals

DELETE FROM Deals WHERE ID = 10003

Columnas¶

DealStages¶

Información de uso para la operación DealStages.rsd.

Información Específica de la Tabla¶

Seleccionar¶

El conector usa la API de ActiveCampaign para procesar algunos de los filtros.

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

SELECT * FROM DealStages WHERE Id = 10003

SELECT * FROM DealStages WHERE Title = 'title' AND GroupId = 1

Insertar¶

Insertar una etapa requiere especificar un valor para las columnas GroupId, Title.

INSERT INTO DealStages (GroupId, Title) VALUES (2,'title')

INSERT INTO DealStages (Title, GroupId, OrderId, CardRegion3, Color, Width) VALUES ('TestStage',1,2,'hide-avatar','434343','280')

Actualizar¶

El conector admite la actualización de la información de etapa/dealstage.

UPDATE DealStages SET Title = 'updatedTitle' WHERE Id = 1

Borrar¶

Elimine todas las etapas o una etapa especificando el ID de la etapa.

DELETE FROM DealStages WHERE ID = 10003

Columnas¶

Tareas¶

Enumera todas las cuentas existentes.

Información Específica de la Tabla¶

Seleccionar¶

El conector usa la API de ActiveCampaign para procesar algunos de los filtros.

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

SELECT * FROM Tasks WHERE Id = 10003

SELECT * FROM Tasks WHERE DealTaskType = 1 

SELECT * FROM Tasks WHERE DueDate >= '2019-06-30T10:44:34-05:00'

SELECT * FROM Tasks WHERE DueDate <= '2021-06-30T10:44:34-05:00'

SELECT * FROM Tasks WHERE OutcomeId = 1 AND RelId = 1 AND Status = 1

Insertar¶

Insertar una etapa requiere especificar un valor para las columnas DealTaskType, DueDate, Relid.

INSERT INTO Tasks (DealTaskType, DueDate, Relid) VALUES (2, '2021-06-30T10:44:34-05:00', 7)

Actualizar¶

El conector admite la actualización de la información de etapa/dealstage.

UPDATE Tasks SET Title = 'updatedTitle' WHERE Id = 1

Borrar¶

Elimine todas las etapas o una etapa especificando el ID de la etapa.

DELETE FROM Tasks WHERE ID = 10003

Columnas¶

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.

Se admiten las vistas dinámicas, como las consultas expuestas como vistas y las vistas para buscar combinaciones específicas de elementos de trabajo project_team.

Conector Jitterbit para Vistas de ActiveCampaign¶

Direcciones¶

Información de uso para la operación Direcciones.rsd.

Información Específica de la Tabla¶

Seleccionar¶

El conector usa la API de ActiveCampaign para procesar algunos de los filtros.

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

SELECT * FROM AccountContacts WHERE Id = 10003

Columnas¶

Automatizaciones¶

Información de uso para la operación Automations.rsd.

Columnas¶

Campañas¶

Consulta la información de las campañas en ActiveCampaign.

Información Específica de la Tabla¶

Seleccionar¶

El conector usa la API de ActiveCampaign para procesar algunos de los filtros.

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

SELECT * FROM Campaigns WHERE Id = 10003

Columnas¶

ContactoAutomatizaciones¶

Vea muchos o todos los contactos incluyendo sus ID o varios filtros.

Información Específica de la Tabla¶

Seleccionar¶

El conector usa la API de ActiveCampaign para procesar algunos de los filtros.

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

SELECT * FROM ContactAutomations WHERE Id = 10003

Columnas¶

Listas de Contactos¶

Recupere ContactList para cada grupo de contactos o para el grupo de contactos específico.

Información Específica de la Tabla¶

Seleccionar¶

La recuperación de información de ContactLists requiere especificar un ContactId.

SELECT * FROM ContactLists WHERE ContactId = 1000

Columnas¶

ContactoEtiquetas¶

Recuperar etiquetas agregadas para cada contacto o para la identificación de contacto específica

Información Específica de la Tabla¶

Seleccionar¶

La recuperación de información para ContactTags requiere especificar un ContactId.

SELECT * FROM ContactTags WHERE ContactId = 1

Columnas¶

Liza¶

Información de uso para la operación Lists.rsd.

Información Específica de la Tabla¶

Seleccionar¶

El conector usa la API de ActiveCampaign para procesar algunos de los filtros.

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

SELECT * FROM Lists WHERE Id = 1

SELECT * FROM Lists WHERE Name = 'list1'

Además, el conector admite la recuperación de información sobre los miembros de las listas en su cuenta al admitirlos dinámicamente como VISTAS. Seleccionar de una lista dinámica devolverá información sobre todos los contactos que son miembros de esa lista. Los nombres de las listas siempre comienzan con "List_".

Columnas¶

Puntuaciones¶

Vea muchos o todos los contactos incluyendo sus ID o varios filtros.

Información Específica de la Tabla¶

Seleccionar¶

El conector usa la API de ActiveCampaign para procesar algunos de los filtros.

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

SELECT * FROM Scores WHERE Id = 10

Columnas¶

Etiquetas¶

Vea muchas o todas las etiquetas incluyendo sus ID o varios filtros.

Información Específica de la Tabla¶

Seleccionar¶

El conector usa la API de ActiveCampaign para procesar algunos de los filtros.

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

SELECT * FROM Tags WHERE Id = 10003

Columnas¶

Registros de Seguimiento¶

Recuperar registros de seguimiento para el contacto específico o todos los contactos

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Usuarios¶

Información de uso para la operación Users.rsd.

Información Específica de la Tabla¶

Seleccionar¶

El conector usa la API de ActiveCampaign para procesar algunos de los filtros.

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

SELECT * FROM Users WHERE Id = 10003

Columnas¶

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 ActiveCampaign:

• sys_catalogs: enumera las bases de datos disponibles.
• sys_schemas: enumera los esquemas disponibles.
• sys_tablas: enumera las tablas y vistas disponibles.
• sys_tablecolumns: Describe las columnas de las tablas y vistas disponibles.
• procedimientos_sys: describe los procedimientos almacenados disponibles.
• parámetros_procedimiento_sys: Describe procedimiento almacenado* parámetros.
• sys_keycolumns: describe las claves principal y externa.
• índices_sys: Describe los índices disponibles.

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 Consultas¶

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¶

Sys_schemas¶

Enumera los esquemas disponibles.

La siguiente consultar recupera todos los esquemas disponibles:

SELECT * FROM sys_schemas

Columnas¶

Sys_tables¶

Enumera las tablas disponibles.

La siguiente consultar recupera las tablas y vistas disponibles:

SELECT * FROM sys_tables

Columnas¶

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 Contactos:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Contacts' 

Columnas¶

Sys_procedimientos¶

Enumera los procedimientos almacenados disponibles.

La siguiente consultar recupera los procedimientos almacenados disponibles:

SELECT * FROM sys_procedures

Columnas¶

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¶

Sys_keycolumns¶

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

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Contacts'

Columnas¶

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¶

Sys_primarykeys¶

Describe las claves primarias. La siguiente consultar recupera las claves principales de todas las tablas y vistas:

SELECT * FROM sys_primarykeys

Columnas¶

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¶

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:activecampaign: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¶

Sys_sqlinfo¶

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

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.

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¶

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¶

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.

Autenticación

SSL

Esquema

Misceláneas

Autenticación¶

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

Clave API¶

La APIKey obtenida de la interfaz de usuario de ActiveCampaign.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

La clave API se puede encontrar en su cuenta en la página Configuración en la pestaña"Desarrollador". Cada usuario de su cuenta de ActiveCampaign tiene su propia clave API única.

URL¶

URL base que se utiliza para acceder a la API.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

La URL se puede encontrar en su cuenta en la página Mi configuración en la pestaña"Desarrollador". Por ejemplo: *https://{yourAccountName}.api-us1.com*

SSL¶

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

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:

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.

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%\\\ActiveCampaign 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%\\ ActiveCampaign Data Provider\Schema" con %APPDATA% estando configurado en el directorio de configuración del usuario:

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.

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¶

Tamaño de Página¶

El número máximo de resultados que se devolverán por página desde ActiveCampaign.

Tipo de Datos¶

int

Valor por Defecto¶

100

Observaciones¶

El Pagesize la propiedad afecta la cantidad máxima de resultados que se devolverán por página desde ActiveCampaign. ActiveCampaign permite devolver un máximo de 100 registros en cada página.

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.

Vistas Definidas por el Usuario¶

Una ruta de archivo que apunta al archivo de configuración JSON que contiene sus vistas personalizadas.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

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 Contacts 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"