Detalhes da Conexão da Active Campaign¶

Introdução¶

Versão do conector

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

Começando¶

Suporte à versão Active Campaign

O conector utiliza a API Active Campaign para habilitar o acesso bidirecional a Active Campaign.

Estabelecendo uma Conexão¶

Conectando-se à ActiveCampaign¶

ActiveCampaign oferece suporte à autenticação com a chave de API. Para se conectar a ActiveCampaign, defina o seguinte:

• URL: Isso pode ser encontrado em sua conta no My Settings página sob o Developer aba. Por exemplo: *https://{yourAccountName}.api-us1.com*
• APIKey: Isso pode ser encontrado em sua conta no Settings página sob o Developer aba. Cada usuário em sua conta ActiveCampaign tem sua própria chave de API exclusiva.

Modelo de Dados¶

Visão geral

O conector modela recursos Active Campaign como Contatos, Contas como tabelas relacionais, permitindo que você escreva SQL para consultar dados ActiveCampaign.

A conectividade ao vivo com esses objetos significa que quaisquer alterações em sua conta ActiveCampaign são refletidas imediatamente ao usar o conector.

Visualizações

Visualizações são tabelas que não podem ser modificadas. Normalmente, os dados que são somente leitura e não podem ser atualizados são exibidos como visualizações.

Visualizações Dinâmicas

Juntamente com as exibições estáticas padrão, o conector também permite consultar exibições dinâmicas.

Essas são visualizações criadas com base nas "listas" (também chamadas de "públicos") em sua conta da ActiveCampaign.
Por exemplo, suponha que você tenha essas 3 listas em sua conta: Lista de contatos principal, Novo público, Lista VIP.

O conector lista 3 visualizações baseadas nelas: List_MasterList, List_New Audience, List_VIP List.
As exibições retornam dados sobre cada contato que é membro dessa lista específica.

Mesas

Tabelas descreve as tabelas disponíveis. As tabelas são definidas estaticamente para modelar recursos como Accounts, Deals, DealGroups, DealStages, Tasks, etc.

O conector também oferece suporte a tabelas de consulta como AccountCustomFieldData, DealCustomFieldData, ContactCustomFieldData, que representam informações de dados de campos personalizados.

Além disso, o conector oferece suporte à atualização, inserindo dados de campos personalizados do recurso principal (disponível para as tabelas Contas, Contatos, Negócios) onde os campos personalizados são anexados dinamicamente como colunas do recurso principal. Consulte a seção específica da tabela para obter mais informações.

Tabelas¶

O conector modela os dados no ActiveCampaign em uma lista de tabelas que podem ser consultadas usando instruções SQL padrão.

Geralmente, consultar tabelas ActiveCampaign é o mesmo que consultar uma tabela em um banco de dados relacional. Às vezes, há casos especiais, por exemplo, incluir uma determinada coluna na cláusula WHERE pode ser necessário para obter dados para determinadas colunas na tabela. Isso geralmente é necessário para situações em que uma solicitação separada deve ser feita para cada linha para obter determinadas colunas. Esses tipos de situações estão claramente documentados na parte superior da página da tabela vinculada abaixo.

Conector Jitterbit para Tabelas ActiveCampaign¶

ContaContatos¶

Informações de uso para a operação AccountContacts.rsd.

Informações Específicas da Tabela¶

Selecione¶

O conector usa a API ActiveCampaign para processar alguns dos filtros.

Por exemplo, as seguintes consultas são processadas no lado do servidor:

SELECT * FROM AccountContacts WHERE Id = 10003

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

Inserir¶

A inserção de uma associação conta-contato requer a especificação de um valor para as colunas AccountId e ContactId.

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

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

Atualizar¶

O driver oferece suporte à atualização das informações de contato da conta.

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

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

Excluir¶

Remova todas as associações de conta-contatos ou uma associação especificando o ID da associação.

DELETE FROM AccountContacts WHERE ID = 10003

Colunas¶

AccountCustomFieldData¶

Crie, modifique, exclua e consultar os dados do campo personalizado de negócios disponíveis no ActiveCampaign.

Informações Específicas da Tabela¶

Selecione¶

O conector usa a API ActiveCampaign para processar alguns dos filtros.

Por exemplo, as seguintes consultas são processadas no lado do servidor:

SELECT * FROM AccountCustomFieldData WHERE Id = 10003

SELECT * FROM AccountCustomFieldData WHERE AccountId = 1

Inserir¶

A inserção de dados de um campo personalizado de conta requer a especificação de um valor para as colunas AccountId, CustomFieldId e FieldValue.

Além disso, o conector oferece suporte à inserção de dados de campos personalizados de conta da tabela Contas. Consulte Contas Para maiores informações.

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

Atualizar¶

O conector oferece suporte à atualização de informações de dados de campo personalizado da conta. Atualizar os dados de um campo personalizado de conta requer a especificação de um valor para as colunas ID e CustomFieldId.

Além disso, é possível atualizar os dados dos campos personalizados da conta na tabela Contas.

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

Excluir¶

O conector suporta a remoção de dados de campos personalizados das contas.

DELETE FROM AccountcustomFieldData WHERE ID = 10

Colunas¶

Contas¶

Visualize muitos ou todos os contatos incluindo seus IDs ou vários filtros.

Informações Específicas da Tabela¶

Selecione¶

O conector usa a API ActiveCampaign para processar alguns dos filtros.

Por exemplo, as seguintes consultas são processadas no lado do servidor:

SELECT * FROM Accounts WHERE Id = 10003

SELECT * FROM Accounts WHERE Name = 'testAccount'

Como observação, devido a problemas de desempenho do lado do servidor, mesmo quando a propriedade IncludeCustomFields estiver definida como TRUE, os campos personalizados aparecerão apenas no esquema da tabela com valores nulos. Para recuperar os valores dos campos personalizados, consulte AccountCustomFieldData mesa.

Inserir¶

A inserção de uma conta requer a especificação do nome da conta.

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

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

Além disso, o conector oferece suporte à inserção de dados de conta e campos personalizados da tabela Contas. Todas as colunas de campos personalizados começam com CF_.

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

Atualizar¶

O conector oferece suporte à atualização de informações da conta.

Além disso, é possível atualizar os dados dos campos personalizados da conta na tabela Contas.

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

Excluir¶

Remova todas as contas ou uma conta especificando o ID da conta.

DELETE FROM Accounts WHERE ID = 10003

Colunas¶

ContactCustomFieldData¶

Crie, modifique, exclua e consultar os dados de campo personalizados de contato disponíveis no ActiveCampaign.

Informações Específicas da Tabela¶

Selecione¶

O conector usa a API ActiveCampaign para processar alguns dos filtros.

Por exemplo, as seguintes consultas são processadas no lado do servidor:

SELECT * FROM ContactCustomFieldData WHERE Id = 10003

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

Inserir¶

A inserção de dados de um campo personalizado de contato requer a especificação de um valor para as colunas ContactId, FieldId e FieldValue.

Além disso, o conector oferece suporte à inserção de dados de campos personalizados de contato da tabela de contatos. Consulte Contatos Para maiores informações.

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

Atualizar¶

O conector oferece suporte à atualização de informações de dados de campo personalizado de contato. A atualização dos dados do campo personalizado de contato requer a especificação de um valor para as colunas Id, ContactId e FieldId.

Além disso, é possível atualizar os dados dos campos personalizados de contato da tabela Contatos.

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

Excluir¶

O conector suporta a remoção de dados de campo personalizado de contato.

DELETE FROM ContactCustomFieldData WHERE ID = 10

Colunas¶

Contatos¶

Visualize muitos ou todos os contatos incluindo seus IDs ou vários filtros.

Informações Específicas da Tabela¶

Selecione¶

O conector usa a API ActiveCampaign para processar alguns dos filtros.

Por exemplo, as seguintes consultas são processadas no lado do 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 observação, devido a problemas de desempenho do lado do servidor, mesmo quando a propriedade IncludeCustomFields estiver definida como TRUE, os campos personalizados aparecerão apenas no esquema da tabela com valores nulos. Para recuperar os valores dos campos personalizados, consulte o ContactCustomFieldData mesa.

Inserir¶

A inserção de um contato requer a especificação do e-mail do contato.

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

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

Além disso, o conector suporta a inserção de dados de contato e campos personalizados de contato da tabela de contatos. Todas as colunas de campos personalizados começam com CF_.

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

Atualizar¶

O conector oferece suporte à atualização de informações de contato.

Além disso, é possível atualizar os dados dos campos personalizados de contato da tabela Contatos.

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

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

Contatos de Importação em Massa¶

O conector suporta o upload de um grande número de contatos em sua conta. Esta operação inclui:

• Criação de novos contatos
• Atualização de contatos existentes
• Inscrever-se e cancelar a inscrição em listas

Os contatos são importados em lotes de até 250 itens. O importador não é recomendado para um pequeno número de contatos. Você pode importar contatos como abaixo:

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

Além disso, o conector suporta BULK INSERT para a tabela de contatos. Observe que esta operação causará um custo no desempenho, pois o conector valida se os contatos enviados existem antes de importá-los.

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 inscrever e cancelar contatos de uma lista específica, defina um valor para as colunas SubscribeTo e/ou UnsubcribeFrom que aceitam uma lista separada por vírgulas de IDs de lista. Por exemplo:

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

Os contatos devem atender a todos os critérios a seguir para serem criados ou atualizados com esta API:

• Os contatos importados não podem exceder o limite da sua conta
• O contato deve ter um endereço e-mail
• O endereço e-mail do contato não deve estar em uma lista de exclusão
• O e-mail do contato não deve estar em uma lista de endereços e-mail devolvidos
• O contato não deve ter cancelado a inscrição em uma lista à qual a importação os adicionaria

Se os contatos não atenderem a todos esses requisitos, eles serão ignorados pelo importador.

Excluir¶

Remova todos os contatos ou um contato especificando a ID do contato.

DELETE FROM Contacts WHERE ID = 10003

Colunas¶

DealCustomFieldData¶

Crie, modifique, exclua e consultar os dados do campo personalizado de negócios disponíveis no ActiveCampaign.

Informações Específicas da Tabela¶

Selecione¶

O conector usa a API ActiveCampaign para processar alguns dos filtros.

Por exemplo, as seguintes consultas são processadas no lado do servidor:

SELECT * FROM DealCustomFieldData WHERE Id = 10003

SELECT * FROM DealCustomFieldData WHERE DealId = 1

Inserir¶

A inserção de dados de um campo personalizado de negócio requer a especificação de um valor para as colunas DealId, CustomFieldId e FieldValue.

Além disso, o conector oferece suporte à inserção de dados de campos personalizados de negócios da tabela Negócios. Veja Ofertas Para maiores informações.

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

Atualizar¶

O conector oferece suporte à atualização das informações de dados do campo personalizado do negócio. A atualização dos dados do campo personalizado do negócio requer a especificação de um valor para as colunas Id, DealId e CustomFieldId.

Além disso, é possível atualizar os dados dos campos personalizados do negócio na tabela Negócios.

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

Excluir¶

O conector suporta a remoção de dados do campo personalizado do negócio.

DELETE FROM DealCustomFieldData WHERE ID = 10

Colunas¶

Grupos de Negócios¶

Lista todas as contas existentes.

Informações Específicas da Tabela¶

Selecione¶

O conector usa a API ActiveCampaign para processar alguns dos filtros.

Por exemplo, as seguintes consultas são processadas no lado do servidor:

SELECT * FROM DealGroups WHERE Id = 10003

SELECT * FROM DealGroups WHERE Title = 'title'

Inserir¶

A inserção de um pipeline/dealgroup requer a especificação de um valor para as colunas Moeda e Título.

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

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

Atualizar¶

O conector oferece suporte à atualização de informações de pipeline/dealgroup.

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

Excluir¶

Remova todos os pipelines ou um pipeline especificando o ID do grupo de negócios.

DELETE FROM DealGroups WHERE ID = 10003

Colunas¶

Ofertas¶

Informações de uso para a operação Deals.rsd.

Informações Específicas da Tabela¶

Selecione¶

O conector usa a API ActiveCampaign para processar alguns dos filtros.

Por exemplo, as seguintes consultas são processadas no lado do 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 observação, devido a problemas de desempenho do lado do servidor, mesmo quando a propriedade IncludeCustomFields estiver definida como TRUE, os campos personalizados aparecerão apenas no esquema da tabela com valores nulos. Para recuperar os valores dos campos personalizados, consulte DealCustomFieldData mesa.

Inserir¶

A inserção de um negócio requer a especificação de um valor para as colunas GroupId, Stage, OwnerId, Title, Value, Currency e um valor para a coluna AccountId ou 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')

Além disso, o conector oferece suporte à inserção de negócios e dados de campos personalizados de negócios da tabela Negócios. Todas as colunas de campos personalizados começam com 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')

Atualizar¶

O conector oferece suporte à atualização de informações do negócio.

Além disso, é possível atualizar os dados dos campos personalizados do negócio na tabela Negócios.

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

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

Excluir¶

Remova todos os negócios ou um negócio especificando o ID do negócio.

DELETE FROM Deals

DELETE FROM Deals WHERE ID = 10003

Colunas¶

DealStages¶

Informações de uso para a operação DealStages.rsd.

Informações Específicas da Tabela¶

Selecione¶

O conector usa a API ActiveCampaign para processar alguns dos filtros.

Por exemplo, as seguintes consultas são processadas no lado do servidor:

SELECT * FROM DealStages WHERE Id = 10003

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

Inserir¶

A inserção de um estágio requer a especificação de um valor para as colunas GroupId e 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')

Atualizar¶

O conector oferece suporte à atualização de informações de estágio/dealstage.

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

Excluir¶

Remova todos os estágios ou um estágio especificando o ID do estágio.

DELETE FROM DealStages WHERE ID = 10003

Colunas¶

Tarefas¶

Lista todas as contas existentes.

Informações Específicas da Tabela¶

Selecione¶

O conector usa a API ActiveCampaign para processar alguns dos filtros.

Por exemplo, as seguintes consultas são processadas no lado do 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

Inserir¶

A inserção de um estágio requer a especificação de um valor para as colunas DealTaskType, DueDate, Relid.

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

Atualizar¶

O conector oferece suporte à atualização de informações de estágio/dealstage.

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

Excluir¶

Remova todos os estágios ou um estágio especificando o ID do estágio.

DELETE FROM Tasks WHERE ID = 10003

Colunas¶

Visualizações¶

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

As consultas podem ser executadas em uma exibição como se fosse uma tabela normal, e os dados retornados são semelhantes nesse aspecto.

Visualizações dinâmicas, como consultas expostas como visualizações e visualizações para procurar combinações específicas de itens de trabalho project_team são suportadas.

Conector Jitterbit para Exibições ActiveCampaign¶

Endereços¶

Informações de uso para a operação Addresses.rsd.

Informações Específicas da Tabela¶

Selecione¶

O conector usa a API ActiveCampaign para processar alguns dos filtros.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM AccountContacts WHERE Id = 10003

Colunas¶

Automações¶

Informações de uso para a operação Automations.rsd.

Colunas¶

Campanhas¶

Consulte as informações das campanhas em ActiveCampaign.

Informações Específicas da Tabela¶

Selecione¶

O conector usa a API ActiveCampaign para processar alguns dos filtros.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM Campaigns WHERE Id = 10003

Colunas¶

ContatoAutomações¶

Visualize muitos ou todos os contatos incluindo seus IDs ou vários filtros.

Informações Específicas da Tabela¶

Selecione¶

O conector usa a API ActiveCampaign para processar alguns dos filtros.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM ContactAutomations WHERE Id = 10003

Colunas¶

Listas de Contatos¶

Recupere ContactList para cada grupo de contato ou para o grupo de contato específico.

Informações Específicas da Tabela¶

Selecione¶

A recuperação de informações de ContactLists requer a especificação de um ContactId.

SELECT * FROM ContactLists WHERE ContactId = 1000

Colunas¶

ContactTags¶

Recupere tags adicionadas para cada contato ou para o ID de contato específico

Informações Específicas da Tabela¶

Selecione¶

A recuperação de informações para ContactTags requer a especificação de um ContactId.

SELECT * FROM ContactTags WHERE ContactId = 1

Colunas¶

Listas¶

Informações de uso para a operação Lists.rsd.

Informações Específicas da Tabela¶

Selecione¶

O conector usa a API ActiveCampaign para processar alguns dos filtros.

Por exemplo, as seguintes consultas são processadas no lado do servidor:

SELECT * FROM Lists WHERE Id = 1

SELECT * FROM Lists WHERE Name = 'list1'

Além disso, o conector suporta a recuperação de informações sobre membros de listas em sua conta, suportando-os dinamicamente como VIEWS. A seleção de uma lista dinâmica retornará informações sobre todos os contatos que são membros dessa lista. Os nomes das listas sempre começam com "List_".

Colunas¶

Pontuações¶

Visualize muitos ou todos os contatos incluindo seus IDs ou vários filtros.

Informações Específicas da Tabela¶

Selecione¶

O conector usa a API ActiveCampaign para processar alguns dos filtros.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM Scores WHERE Id = 10

Colunas¶

Tag¶

Visualize muitas ou todas as tags incluindo seus IDs ou vários filtros.

Informações Específicas da Tabela¶

Selecione¶

O conector usa a API ActiveCampaign para processar alguns dos filtros.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM Tags WHERE Id = 10003

Colunas¶

Registros de Rastreamento¶

Recupere trackingLogs para o contato específico ou todos os contatos

Colunas¶

Pseudo-colunas¶

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

Usuários¶

Informações de uso para a operação Users.rsd.

Informações Específicas da Tabela¶

Selecione¶

O conector usa a API ActiveCampaign para processar alguns dos filtros.

Por exemplo, a seguinte consultar é processada no lado do servidor:

SELECT * FROM Users WHERE Id = 10003

Colunas¶

Tabelas do Sistema¶

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

Tabelas de Esquema¶

As tabelas a seguir retornam metadados do banco de dados para ActiveCampaign:

• sys_catalogs: Lista os bancos de dados disponíveis.
• sys_schemas: Lista os esquemas disponíveis.
• sys_tables: Lista as tabelas e exibições disponíveis.
• sys_tablecolumns: Descreve as colunas das tabelas e exibições disponíveis.
• sys_procedures: Descreve os procedimentos armazenados disponíveis.
• sys_procedureparameters: Descreve procedimento armazenado* parâmetros.
• sys_keycolumns: Descreve as chaves primárias e estrangeiras.
• sys_indexes: Descreve os índices disponíveis.

Tabelas de Fonte de Dados¶

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

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

Consultar Tabelas de Informações¶

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

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

Sys_catalogs¶

Lista os bancos de dados disponíveis.

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

SELECT * FROM sys_catalogs

Colunas¶

Sys_schemas¶

Lista os esquemas disponíveis.

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

SELECT * FROM sys_schemas

Colunas¶

Sys_tables¶

Lista as tabelas disponíveis.

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

SELECT * FROM sys_tables

Colunas¶

Sys_tablecolumns¶

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

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

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

Colunas¶

Sys_procedures¶

Lista os procedimentos armazenados disponíveis.

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

SELECT * FROM sys_procedures

Colunas¶

Sys_procedureparameters¶

Descreve procedimento armazenado* parâmetros.

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

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2

Colunas¶

Sys_keycolumns¶

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

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

Colunas¶

Sys_foreignkeys¶

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

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Colunas¶

Sys_primarykeys¶

Descreve as chaves primárias. A consultar a seguir recupera as chaves primárias de todas as tabelas e exibições:

SELECT * FROM sys_primarykeys

Colunas¶

Sys_indexes¶

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

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

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Colunas¶

Sys_connection_props¶

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

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

jdbc:cdata:activecampaign:config:

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

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Colunas¶

Sys_sqlinfo¶

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

Descobrindo os Recursos SELECT da Fonte de Dados¶

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

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

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

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

Colunas¶

Sys_identity¶

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

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

SELECT * FROM sys_identity

Colunas¶

Propriedades de Configurações Avançadas¶

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

Autenticação

SSL

Esquema

Diversos

Autenticação¶

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

Chave API¶

A APIKey obtida da IU do ActiveCampaign.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

A chave de API pode ser encontrada em sua conta na página Configurações na aba"Desenvolvedor". Cada usuário em sua conta ActiveCampaign tem sua própria chave de API exclusiva.

URL¶

URL base que é usado para acessar a API.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

O URL pode ser encontrado em sua conta na página Minhas configurações na aba"Desenvolvedor". Por exemplo: *https://{yourAccountName}.api-us1.com*

SSL¶

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

SSLServerCert¶

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

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

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

Esta propriedade pode assumir as seguintes formas:

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

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

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

Esquema¶

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

Localização¶

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

Tipo de Dados¶

string

Valor Padrão¶

"%APPDATA%\\\ActiveCampaign Data Provider\\Schema"

Observações¶

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

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

Esquemas Navegáveis¶

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

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

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

Tabelas¶

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

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

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

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

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

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

Visualizações¶

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

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

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

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

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

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

Diversos¶

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

MaxRows¶

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

Tipo de Dados¶

int

Valor Padrão¶

-1

Observações¶

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

Outro¶

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

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

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

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

Integração e Formatação¶

Tamanho da Página¶

O número máximo de resultados a serem retornados por página de ActiveCampaign.

Tipo de Dados¶

int

Valor Padrão¶

100

Observações¶

O Pagesize a propriedade afeta o número máximo de resultados a serem retornados por página da ActiveCampaign. A ActiveCampaign permite que no máximo 100 registros sejam retornados em cada página.

Pseudocolunas¶

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

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

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

Tempo Esgotado¶

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

Tipo de Dados¶

int

Valor Padrão¶

60

Observações¶

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

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

Visualizações Definidas pelo Usuário¶

Um caminho de arquivo apontando para o arquivo de configuração JSON que contém suas exibições personalizadas.

Tipo de Dados¶

string

Valor Padrão¶

""

Observações¶

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

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

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

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

Por exemplo:

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

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

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