Detalhes da Conexão do SuiteCRM

Introdução

Versão do conector

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

Começando

Suporte à versão do SuiteCRM

O conector permite acesso SQL bidirecional em tempo real às instâncias SuiteCRM versão 2 e posteriores.

Estabelecendo uma Conexão

Conectando-se à API SuiteCRM V4.1

Você pode se conectar aos dados do SuiteCRM por meio da API V4.1 simplesmente definindo as seguintes propriedades de conexão:

• Schema: Defina para suitecrmv4.
• URL: Defina isso para o URL associado ao aplicativo SuiteCRM, por exemplo http://suite.crm.com.
• User: Defina isso para o usuário associado à conta SuiteCRM.
• Password: Defina isso como a senha associada à conta SuiteCRM.

Conectando-se à API SuiteCRM V8

Antes de Conectar

Antes de se conectar à API SuiteCRM V8, você precisará primeiro configurá-la em sua instância SuiteCRM. A API pode ser configurada no SuiteCRM versão 7.10+. Para configurar a API, siga as etapas escritas nos documentos SuiteCRM JSON API, encontrados aqui: https://docs.suitecrm.com/developer/api/developer-setup-guide/json-api/#\_before_you_start_calling_endpoints.

A API SuiteCRM V8 usa OAuth2.0 como seu principal método de autenticação usando 2 tipos de tipo de concessão, password ou client credenciais. Consulte Usando autenticação OAuth para obter um guia sobre como se conectar com OAuth.

Usando Autenticação OAuth

Observação: Este método de autenticação está disponível apenas para suitecrmv8 esquema.

A API SuiteCRM V8 usa OAuth2.0 como seu principal método de autenticação usando 2 tipos de tipo de concessão, password ou client credenciais. Para autenticar na API SuiteCRM V8, faça o seguinte. Observe que você precisa ser um administrador para criar credenciais, criar funções, atribuir funções a usuários, etc.

Observação: O fluxo OAuth é o mesmo em uma máquina headless.

Registrar um Aplicativo

Para obter as credenciais do cliente OAuth, a chave do consumidor e o segredo do consumidor:

1. Faça login em sua conta de administrador.
2. No menu suspenso do perfil, selecione Admin > OAuth2 Clients and Tokens e clique New Password Client ou New Client Credentials Client.
3. Insira um nome e um segredo.
4. Clique em Save.

Atribuir Funções para Acesso à API

Normalmente, ao autenticar com um tipo de concessão de credenciais de cliente, você terá acesso total à API. Para autenticação com tipo de concessão de senha, o usuário deve ter permissões para cada módulo/tabela.

O acesso dos usuários a determinados recursos pode ser definido configurando funções REST e atribuindo usuários às funções REST específicas.

Para criar uma papel:

1. No menu suspenso de perfil, selecione Admin > Role Management e clique Create Role.
2. Digite o nome e a descrição e clique em Save. Em seguida, você será redirecionado para o menu de configuração de papel, onde poderá selecionar permissões para qualquer operação em qualquer módulo.
3. Depois de configurar as permissões, você pode clicar em Save.

Para atribuir uma papel a um usuário:

1. No menu suspenso de perfil, selecione Admin > Role Management e clique na papel que deseja atribuir a um usuário.
2. Role para baixo e clique em Select User.
3. Uma janela de pesquisa de usuário será exibida.
4. Selecione os usuários aos quais deseja atribuir a papel e clique em Select > Save.

Concessão de Credenciais do Cliente

Autenticando Usando a Concessão de Credenciais do Cliente

Depois de definir as seguintes propriedades de conexão, você está pronto para se conectar:

• Schema: Defina isso como suitecrmv8.
• OAuthGrantType: Defina para CLIENT.
• OAuthClientId: Defina isso para a chave do cliente que você recebeu.
• OAuthClientSecret: Defina isso para o segredo do cliente que você anotou.
• InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken propriedade de conexão.
• URL: A URL base do seu sistema SuiteCRM. Por exemplo, https://suitecrmhost/.

Concessão de Senha

Autenticação Usando Concessão de Senha

Depois de definir as seguintes propriedades de conexão, você está pronto para se conectar:

• Schema: Defina isso como suitecrmv8.
• OAuthGrantType: Defina para PASSWORD.
• OAuthClientId: Defina isso para a chave do cliente que você recebeu.
• OAuthClientSecret: Defina isso para o segredo do cliente que você anotou.
• User: Defina isso para o nome de usuário associado ao usuário.
• Password: Defina isso para a senha associada ao usuário.
• InitiateOAuth: Defina como GETANDREFRESH. Você pode usar InitiateOAuth para evitar repetir a troca de OAuth e configurar manualmente o OAuthAccessToken propriedade de conexão.
• URL: A URL base do seu sistema SuiteCRM. Por exemplo, https://suitecrmhost/.

Anotações Importantes

Procedimentos Armazenados

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

Arquivos de Configuração e Seus Caminhos

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

Características Avançadas

Esta seção detalha uma seleção de recursos avançados do conector SuiteCRM.

Visualizações definidas pelo usuário

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

Configuração SSL

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

Procurador

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

Visualizações Definidas pelo Usuário

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

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

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

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

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

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

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

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

Por exemplo:

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

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

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

Esquema para Exibições Definidas pelo Usuário

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

Trabalhando com Exibições Definidas pelo Usuário

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

SELECT * FROM Customers WHERE City = 'Raleigh';

Exemplo de consultar ao driver:

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

Resultando na consultar efetiva à fonte:

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

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

Configuração SSL

Personalizando a Configuração SSL

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

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

Modelo de Dados

O Jitterbit Connector para SuiteCRM modela os módulos SuiteCRM como relacionais.

Mesas

As definições de tabela são recuperadas dinamicamente. O conector se conecta ao SuiteCRM e obtém a lista de tabelas e os metadados das tabelas chamando os serviços da Web apropriados.

Quaisquer alterações feitas em sua conta SuiteCRM, como adicionar uma nova tabela ou adicionar novas colunas ou alterar o tipo de dados de uma coluna, serão refletidas imediatamente quando você se conectar usando o conector.

O conector também pode expor módulos personalizados em sua conta SuiteCRM que não são mencionados no arquivo. Você pode consultar esses módulos personalizados como em qualquer outra tabela. Além disso, você pode consultar campos personalizados de módulos padrão.

Esta seção mostra as definições de tabela de amostra incluídas no ambiente de desenvolvimento SuiteCRM.

Processamento de consulta colaborativa

O conector transfere o máximo possível do processamento da instrução SELECT para o SuiteCRM e, em seguida, processa o restante da consultar na memória; As limitações e os requisitos da API estão documentados nesta seção.

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

O Conector Jitterbit para SuiteCRM modela sua conta como bancos de dados relacionais por meio de duas APIs, a API SuiteCRM V4.1 e a API SuiteCRM V8. Os modelos de dados descritos neste capítulo fornecem exemplos de como pode ser o seu ambiente SuiteCRM. O modelo de dados real será obtido dinamicamente com base em sua conta SuiteCRM.

Características principais

• O conector modela Produtos SuiteCRM, Clientes, Inventário e muito mais como tabelas relacionais, permitindo que você escreva SQL para consultar dados SuiteCRM.
• Procedimentos armazenados* permitem que você execute operações no SuiteCRM, incluindo download e upload de objetos.
• A conectividade ao vivo com esses objetos significa que quaisquer alterações em sua conta SuiteCRM são refletidas imediatamente ao usar o conector.

Processamento de consulta colaborativa

O conector transfere o máximo possível do processamento da instrução SELECT para o SuiteCRM e, em seguida, processa o restante da consultar na memória. As limitações e requisitos da API também estão documentados nesta seção.

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

Modelo de dados SuiteCRM V4.1

Consulte Modelo de dados SuiteCRM V4.1 para as entidades disponíveis ao conectar-se a instâncias SuiteCRM 1.

Modelo de dados SuiteCRM V8

Consulte Modelo de dados SuiteCRM V8 para as entidades disponíveis ao conectar-se a instâncias do SuiteCRM 2.

Modelo de Dados SuiteCRM V4.1

Jitterbit Connector for SuiteCRM modela módulos SuiteCRM como banco de dados relacional.

Tabelas

As definições de tabela são recuperadas dinamicamente. O conector se conecta ao SuiteCRM e obtém a lista de tabelas e os metadados das tabelas chamando os serviços da Web apropriados.

Quaisquer alterações feitas em sua conta SuiteCRM, como adicionar uma nova tabela ou adicionar novas colunas ou alterar o tipo de dados de uma coluna, serão refletidas imediatamente quando você se conectar usando o conector.

O conector também pode expor módulos personalizados em sua conta SuiteCRM que não são mencionados no arquivo. Você pode consultar esses módulos personalizados como em qualquer outra tabela. Além disso, você pode consultar campos personalizados de módulos padrão.

Esta seção mostra as definições de tabela de amostra incluídas no ambiente de desenvolvimento SuiteCRM.

Processamento de Consultas Colaborativas

O conector transfere o máximo possível do processamento da instrução SELECT para o SuiteCRM e, em seguida, processa o restante da consultar na memória; As limitações e os requisitos da API estão documentados nesta seção.

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

Tabelas

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

Geralmente, consultar tabelas do SuiteCRM é 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 SuiteCRM

Contas

Crie, atualize, exclua e consultar contas criadas no SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Accounts usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM Accounts WHERE Name LIKE '%test%' AND [Date Created]>'2017-10-09'

Inserir

Crie uma conta SuiteCRM especificando qualquer coluna gravável.

INSERT INTO Accounts(Name,[Email Address],Industry) VALUES('Test Account','example@test.com','Energy')

Atualizar

Você pode atualizar qualquer coluna de Conta que seja gravável, especificando o Id.

UPDATE Accounts SET Description='Updated', Employees='20-50' where id='Test123' 

Excluir

Remova uma conta especificando o ID da conta.

DELETE FROM Accounts WHERE Id='account21'

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.

ACLRoles

Crie, atualize, exclua e consultar a tabela ACLRoles no SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela ACLRoles usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM ACLRoles WHERE Name LIKE '%test%' 

Inserir

Crie um ACLRole especificando qualquer coluna gravável.

INSERT INTO ACLRoles(Name,Description) VALUES('New Role','Role description')

Atualizar

Você pode atualizar qualquer coluna ACLRole que seja gravável, especificando o Id.

UPDATE ACLRoles SET Name='Updated' WHERE Id='Test123' 

Excluir

Remova um ACLRole especificando o Id.

DELETE FROM ACLRoles WHERE Id='10003'

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.

Alertas

Crie, atualize, exclua e consultar os Alertas da sua conta SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Alerts usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM Alerts WHERE Name LIKE '%test%' 

Inserir

Crie alertas especificando qualquer coluna gravável.

INSERT INTO Alerts(Name,Type,[Target Module]) VALUES('Urgent','Important','Opportunities')

Atualizar

Você pode atualizar qualquer coluna de Alerta gravável, especificando o Id.

UPDATE Alerts SET [Is read]=true where id='Test123' 

Excluir

Remova um alerta especificando o ID.

DELETE FROM Alerts WHERE Id='1000'

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.

Insetos

Crie, atualize, exclua e consultar os bugs no SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Bugs usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM Bugs WHERE Subject LIKE '%test%' 

Inserir

Crie um Bug especificando qualquer coluna gravável.

INSERT INTO Bugs(Subject,Status) VALUES('Critical bug','Open')

Atualizar

Você pode atualizar qualquer coluna de entrada de Bug que seja gravável, especificando o Id.

UPDATE Bugs SET Status='Closed' where id='Test123' 

Excluir

Exclua um Bug especificando o Id.

DELETE FROM Bugs WHERE Id='10003'

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.

Horário Comercial

Crie, atualize, exclua e consultar informações de horário comercial no SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela de horário comercial usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM [Horário Comercial] WHERE [Horário de Fechamento] LIKE '23:%' 

Inserir

Crie uma entidade de horário comercial especificando qualquer coluna gravável.

INSERT INTO [Business Hours](Nome, [Horário de Funcionamento], [Horário de Fechamento]) VALUES('Part Timer Hours','9:00','16:00')

Atualizar

Você pode atualizar qualquer coluna de horário comercial gravável, especificando o ID.

UPDATE [Horário Comercial] SET [Opening Hours]='13' where id='Test123' 

Excluir

Exclua uma entrada de horário comercial especificando o ID.

DELETE FROM [Horário Comercial] WHERE Id='10003'

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.

Chamadas

Crie, atualize, exclua e consultar chamadas no SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Calls usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM Calls WHERE [Duration Minutes]<35 

Inserir

Crie uma chamada especificando qualquer coluna gravável.

INSERT INTO Calls(Name,[Duration hours],[Duration minutes]) VALUES('CISCO Call',1,12)

Atualizar

Você pode atualizar qualquer coluna Call que seja gravável, especificando o Id.

UPDATE Calls SET [Repeat Count]='2' where id='Test123' 

Excluir

Exclua uma chamada especificando o ID.

DELETE FROM Calls WHERE Id='10003'

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.

ChamadasReagendar

Crie, atualize, exclua e consultar informações de chamadas reagendadas para as chamadas do SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Reagendamento de Chamadas usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM [Reagendamento de Chamadas] WHERE Reason LIKE '%Delay%' 

Inserir

Crie um reagendamento de chamadas especificando qualquer coluna gravável.

INSERT INTO [Calls Reschedule](Nome, [Id da chamada], [Motivo]) VALUES('CISCO Call Rescheduled','2420','Unresponsive')

Atualizar

Você pode atualizar qualquer coluna de reprogramação de chamadas que seja gravável, especificando o ID.

UPDATE [Reagendamento de Chamadas] SET Reason='Delay' where id='Test123' 

Excluir

Exclua um reagendamento de chamadas especificando o ID.

DELETE FROM [Reagendamento de Chamadas] WHERE Id='10003'

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.

Log da Campanha

Crie, atualize, exclua e consultar logs relacionados a campanhas SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela de log de campanha usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM [Registro da campanha] WHERE Campaign_Id='campaign1' 

Inserir

Crie um log de campanha especificando qualquer coluna gravável.

INSERT INTO [Campaign Log](Nome,Campaign_Id) VALUES('Test Log','Campaign2')

Atualizar

Você pode atualizar qualquer coluna de log de campanha que seja gravável, especificando o ID.

UPDATE [Registro da campanha] SET Archived=true where id='Test123' 

Excluir

Exclua um log de campanha especificando o ID.

DELETE FROM [Registro da campanha] WHERE Id='10003'

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.

Campanhas

Crie, atualize, exclua e consultar as campanhas do projeto SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Campanhas usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM Campaigns WHERE Budget<10000 

Inserir

Crie uma campanha especificando qualquer coluna gravável.

INSERT INTO Campaigns(Name,[Expected Cost],[Actual Cost]) VALUES('Suite Campaign',30000,29400)

Atualizar

Você pode atualizar qualquer coluna de Campanha que seja gravável, especificando o Id.

UPDATE Campaigns SET Budget=30000 where id='Test123' 

Excluir

Exclua uma campanha especificando o ID.

DELETE FROM Campaigns WHERE Id='10003'

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.

CasoEventos

Crie, atualize, exclua e consultar os eventos relacionados aos casos SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Case Events usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM [Eventos de caso] WHERE LBL_CASE_ID='caseId1' 

Inserir

Crie um evento de caso especificando qualquer coluna gravável.

INSERT INTO [Case Events](Nome, LBL_CASE_ID) VALUES('Major Event','caseId4')

Atualizar

Você pode atualizar qualquer coluna de eventos de caso que seja gravável, especificando o ID.

UPDATE [Eventos de caso] SET LBL_CASE_ID='caseId2' where id='Test123' 

Excluir

Exclua um evento de caso especificando o ID.

DELETE FROM [Eventos de caso] WHERE Id='10003'

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.

Casos

Crie, atualize, exclua e consultar os casos do SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Cases usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM Cases WHERE Priority like 'P2' 

Inserir

Crie um Caso especificando qualquer coluna gravável.

INSERT INTO Cases(Subject,Type,Number) VALUES('New Tracker','Adminitration',71)

Atualizar

Você pode atualizar qualquer coluna Case que seja gravável, especificando o Id.

UPDATE Cases SET Status='Closed_Closed' WHERE id='Test123' 

Excluir

Exclua um caso especificando o ID.

DELETE FROM Cases WHERE Id='10003'

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.

Atualizações de Casos

Criar, atualizar, excluir e consultar atualizações feitas nos casos SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Case Updates usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM [Atualizações de caso] WHERE LBL_CASE_ID='caseId2' 

Inserir

Crie uma atualização de caso especificando qualquer coluna gravável.

INSERT INTO [Case Update](Nome, LBL_CASE_ID, LBL_CONTACT_ID) VALUES('Minor Update','caseId4','contactID44')

Atualizar

Você pode atualizar qualquer coluna de eventos de caso que seja gravável, especificando o ID.

UPDATE [Atualização de caso] SET Internal_Update='Some minor changes' where id='Test123' 

Excluir

Exclua uma atualização de caso especificando o ID.

DELETE FROM [Atualizações de caso] WHERE Id='10003'

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.

Contatos

Crie, atualize, exclua e consultar os contatos no SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela de contatos usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM Contacts WHERE Title like 'PhD' 

Inserir

Crie um contato especificando qualquer coluna gravável.

INSERT INTO Contacts([First name],[Last name]) VALUES('Heisen','Schulz')

Atualizar

Você pode atualizar qualquer coluna de contato que seja gravável, especificando o Id.

UPDATE Contacts SET Home='004284294' where id='Test123' 

Excluir

Exclua um contato especificando o ID.

DELETE FROM Contacts WHERE Id=10003

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.

Contratos

Crie, atualize, exclua e consultar contratos no SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Contratos usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM Contracts WHERE [Valor do contrato] < 20000 

Inserir

Crie um contrato especificando qualquer coluna gravável.

INSERT INTO Contracts([Contract Title],[Contract Value],Discount) VALUES('Sokovia Contract',45000,3)

Atualizar

Você pode atualizar qualquer coluna de Contrato que seja gravável, especificando o Id.

UPDATE Contracts SET Currency='GBP' where id='Test123' 

Excluir

Exclua um Contrato especificando o Id.

DELETE FROM Contracts WHERE Id=10003

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.

Moedas

Crie, atualize, exclua e consultar moedas usadas nos rastreamentos financeiros do SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Moedas usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM Currencies WHERE [Taxa de conversão] > 2.34 

Inserir

Crie uma Moeda especificando qualquer coluna gravável.

INSERT INTO Currencies([Iso 4217 Code],[Currency Name]) VALUES('CAD','Canadian Dollar')

Atualizar

Você pode atualizar qualquer coluna de Moeda gravável, especificando o Id.

UPDATE Currencies SET [Conversion Rate]=1.18 where id='Test123' 

Excluir

Exclua uma moeda especificando o ID.

DELETE FROM Currencies WHERE Id='Test123'

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.

Revisão de Documentos

Consulte e exclua revisões de documentos SuiteCRM carregados

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela DocumentRevisions usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM [Revisões de Documentos] WHERE [Related Document]='DocId' 

Inserir

INSERT não é compatível com esta tabela.

Atualizar

UPDATE não é compatível com esta tabela.

Excluir

Exclua uma revisão de documento especificando o ID.

DELETE FROM [Revisões de Documentos] WHERE Id='10003'

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.

Documentos

Crie, atualize, exclua e consultar documentos do SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Documentos usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM Documents WHERE [Nome do Documento] LIKE '%.txt' 

Inserir

Crie um documento especificando qualquer coluna gravável.

INSERT INTO Documents(Name,[Document Source URL]) VALUES('New Document','http://fileorigin.com/testfile.txt')

Atualizar

Você pode atualizar qualquer coluna de Documento gravável, especificando o Id.

UPDATE Documents SET [Status Id]='Expired' where id='Test123' 

Excluir

Exclua um documento especificando o ID.

DELETE FROM Documents WHERE Id='10003'

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.

EAPM

Crie, atualize, exclua e consultar as entradas EAPM (External API Module) no SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela EAPM usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM EAPM WHERE Application LIKE 'Suite%' 

Inserir

Crie uma entrada EAPM especificando qualquer coluna gravável.

INSERT INTO EAPM([App User Name],Application) VALUES('Saved app','Test Application')

Atualizar

Você pode atualizar qualquer coluna EAPM gravável, especificando o Id.

UPDATE EAPM SET Connected=True where id='Test123' 

Excluir

Exclua uma entrada EAPM especificando o ID.

DELETE FROM EAPM WHERE Id='10003'

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.

Endereço de Email

Crie, atualize, exclua e consultar endereços e-mail salvos no SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Endereço E-mail usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM [Endereço E-mail] WHERE [E-mail inválido] = True 

Inserir

Crie um endereço E-mail especificando qualquer coluna gravável.

INSERT INTO [Email Address]([endereço E-mail ]) VALUES('example@email.com')

Atualizar

Você pode atualizar qualquer coluna de endereço E-mail que seja gravável, especificando o ID.

UPDATE [Endereço E-mail] SET [Opted out]=True where id='Test123' 

Excluir

Exclua um endereço E-mail especificando o ID.

DELETE FROM [Endereço E-mail] WHERE Id='10003'

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.

E-mails

Crie, atualize, exclua e consultar e-mails enviados ou recebidos

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela E-mails usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM Emails WHERE Intent LIKE '%Testing%' 

Inserir

Crie um E-mail especificando qualquer coluna gravável.

INSERT INTO Emails(Name,From_Addr_Name,CC_Addrs_Names) VALUES('Example','Contact','Included')

Atualizar

Você pode atualizar qualquer coluna E-mail que seja gravável, especificando o Id.

UPDATE Emails SET Flagged=True where id='Test123'

Excluir

Exclua um E-mail especificando o ID.

DELETE FROM Emails WHERE Id='10003'

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.

Modelos de E-mail

Crie, atualize, exclua e consultar modelos e-mail a serem usados para e-mails

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela de modelos E-mail usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM [Modelos E-mail] WHERE Published = True 

Inserir

Crie um modelo E-mail especificando qualquer coluna gravável.

INSERT INTO [Email Templates](Nome, Descrição) VALUES('Example','Creating an example email')

Atualizar

Você pode atualizar qualquer coluna de modelo E-mail gravável, especificando o ID.

UPDATE [Modelos E-mail] SET [Text Only]=True where id='Test123' 

Excluir

Exclua um modelo E-mail especificando o ID.

DELETE FROM Emails WHERE Id='10003'

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.

Funcionários

Crie, atualize, exclua e consultar funcionários cadastrados no projeto SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Employees usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM Employees WHERE Department = 'HR'

Inserir

Crie um Funcionário especificando qualquer coluna gravável.

INSERT INTO Employees([First Name],[Last name],Title) VALUES('Trucie','Dart','Eng.')

Atualizar

Você pode atualizar qualquer coluna Employee que seja gravável, especificando o Id.

UPDATE Employees SET Description='Updated description' where id='Test123' 

Excluir

Remova um funcionário especificando o ID.

DELETE FROM Employees WHERE Id=10003

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.

Eventos

Crie, atualize, exclua e consultar eventos registrados no projeto SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Events usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM Events WHERE Locations LIKE '%San Francisco%' AND [Data de início] < '2017-02-02'

Inserir

Crie uma entrada de evento especificando qualquer coluna gravável.

INSERT INTO Events(Name,[Start Date],[End Date]) VALUES('Inauguration','2017-06-13','2017-06-14')

Atualizar

Você pode atualizar qualquer coluna de Evento que seja gravável, especificando o Id.

UPDATE Events SET Budget=30000 where id='Test123' 

Excluir

Exclua um evento especificando o ID.

DELETE FROM Events WHERE Id='10003'

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.

Email de Entrada

Crie, atualize, exclua e consultar e-mails de entrada do SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Inbound E-mail usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM [E-mail recebido] WHERE [Pastas monitoradas] LIKE '%MANAGEMENT%' 

Inserir

Crie um E-mail de entrada especificando qualquer coluna gravável.

INSERT INTO [Inbound Email](Nome, [ID da pasta do grupo]) VALUES('Fast replies','groupId123')

Atualizar

Você pode atualizar qualquer coluna E-mail de entrada que seja gravável, especificando o ID.

UPDATE [E-mail recebido] SET [Auto-Reply Template]='emailTemplateId2' where id='Test123' 

Excluir

Exclua um E-mail de entrada especificando o ID.

DELETE FROM [E-mail recebido] WHERE Id='10003'

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.

Índice

Crie, atualize, exclua e consultar os índices disponíveis no SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Index usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM Index WHERE Location LIKE '%ACCOUNT%' 

Inserir

Crie um índice especificando qualquer coluna gravável.

INSERT INTO Index(Name,Location) VALUES('Empty Index','Home')

Atualizar

Você pode atualizar qualquer coluna de índice gravável, especificando o Id.

UPDATE Index SET Location='Index' where id='Test123' 

Excluir

Exclua um índice especificando o ID.

DELETE FROM Index WHERE Id='10003'

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.

IndexEvent

Crie, atualize, exclua e consultar as entradas de evento de índice no SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Index Event usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM [Evento de índice] WHERE Name LIKE '%ERROR%' 

Inserir

Crie uma entrada de evento de índice especificando qualquer coluna gravável.

INSERT INTO [Index Event](Nome, [Módulo de registro]) VALUES('Created first index','indexId2','Index Name 2')

Atualizar

Você pode atualizar qualquer coluna de evento de índice gravável, especificando o Id.

UPDATE [Evento de índice] SET Success=false,Error='Unexpected error' where id='Test123' 

Excluir

Exclua uma entrada de evento de índice especificando o ID.

DELETE FROM [Evento de índice] WHERE Id='10003'

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.

Faturas

Crie, atualize, exclua e consultar as faturas salvas no SuiteCRM

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Faturas usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM Invoices WHERE [Total geral] < 3200 

Inserir

Crie uma fatura especificando qualquer coluna gravável.

INSERT INTO Invoices(Title,Account,Tax,[Due Date]) VALUES('Major purchase','BillingAccount Of Employee',20,'2017-04-07')

Atualizar

Você pode atualizar qualquer coluna de fatura que seja gravável, especificando o Id.

UPDATE Invoices SET Shipping=140 where id='Test123' 

Excluir

Exclua uma fatura especificando o ID.

DELETE FROM Invoices WHERE Id='10003'

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.

Pistas

Crie, atualize, exclua e consultar os Leads cadastrados

Informações Específicas da Tabela

Selecione

Você pode consultar a tabela Leads usando qualquer critério na cláusula WHERE. O conector usará a API SuiteCRM para filtrar os resultados.

SELECT * FROM Leads WHERE [Lead Source]='Word of Mouth'

Inserir

Crie um Lead especificando qualquer coluna gravável.

INSERT INTO Leads([First Name],[Last Name],[Referred by]) VALUES('New','Lead','Adminitrator')

Atualizar

Você pode atualizar qualquer coluna de Lead gravável, especificando o Id.

UPDATE Leads SET Converted=True  where id='Test123' 

Excluir

Remova um Lead especificando o Id.

DELETE FROM Leads WHERE Id=10003

Colunas