TOTVS CAROL - Carol Connect (2C) - Como criar uma conexão com um banco de dados

Tempo aproximado para leitura: 00:05:00 min

Dúvida
Como criar uma conexão com um banco de dados?

Ambiente
TOTVS CAROL - Carol Connect (2C) - Todas as versões

Solução
A Carol Connect (2C) é um aplicação que funciona como ponte de comunicação entre seu banco de dados e a Plataforma Carol.
Por isso, essa conexão criada no Carol Connect (2C) é utilizada para envio dos dados do seu banco de dados local ou Cloud para Plataforma Carol onde eles podem ser utilizados para aplicativos como o Clock In, entre outros.

Para criar essa conexão acesse a página de configuração do Carol Connect (2C), através do endereço padrão: localhost:8880, porém dependendo da configuração executada pela empresa, o IP e porta padrão podem ter sido alterados. Para dúvidas sobre o acesso consulte o artigo: TOTVS CAROL - Carol Connect (2C) - É possível alterar a porta ou endereço de acesso da Carol Connect (2C)?

É recomendado utilizar um usuário exclusivo para Carol Connect(2C), evitando assim o problema de concorrência de token.  Para dúvidas de como criar um usuário exclusivo na Plataforma Carol, consulte o artigo:

TOTVS CAROL - Carol Plataforma - Como criar um usuário exclusivo para o Carol Connect(2C) ?

Ao acessar o endereço da aplicação, preencha sua Organização e no campo username e password, utilize o usuário de um administrador da Plataforma Carol. 



IMPORTANTE: A organização sempre será o nome do seu domínio carol. No caso abaixo, o domínio é o masteringcarol.

OBSERVAÇÃO: Conforme mencionado acima, o ideal é que o usuário e senha para a aplicação do Carol Connect (2C), seja por intermédio de um usuário exclusivo.

Ao acessar a página inicial de Database Manager, clique sobre qualquer uma das opções "+ Add database".



Depois selecione o tipo de base de dados que deseja criar a conexão, neste exemplo é o SQL SERVER.

Nos campos ao lado direito do tipo de base, teremos o campo Connection Name pode ser qualquer descrição, ele é um simples "apelido" para essa conexão dentro do 2C.

No Carol Environment, você deve selecionar para qual ambiente da Plataforma você quer enviar os dados, há situações que pode ter mais de um ambiente, conforme imagem anexada abaixo.



OBSERVAÇÃO: Se a sua organização, possui apenas um ambiente, ele já virá preenchido com o único ambiente existente. 

Para encontrar o nome do seu ambiente, basta verificar o que vem após o carol.ai da sua URL de organização. No exemplo abaixo, a organização é a masteringcarol, e a parte sublinhada é o ambiente/environment.

O próximo campo é o Carol Connector, esse campo, é o responsável por receber os dados do seu banco de dados, por isso ATENÇÃO, você deve sempre selecionar a opção vinculada ao seu ERP, ou seja, se seu ERP for Protheus, você selecionar o conector TOTVS PROTHEUS, se for RM, o conector será TOTVS RM e etc.

Exemplo dos Connectors dentro da Plataforma Carol:

IMPORTANTE: Os Conectores Clock in Mobile e Clock in Web, recebem os dados que chegam por intermédio de dispositivos móveis, e dispositivos desktop respectivamente. Por isso, se você associar o Connector errado o dado pode chegar na Plataforma Carol, mas não será processado corretamente e, será necessário refazer essa configuração do zero.

TOTVS CAROL - Carol Connect (2C) - Como corrigir o apontamento do Connector após a sincronização

Seguindo a conexão, o próximo campo, Carol Authentication, será necessário selecionar a opção "Generate conector token", essa ação irá buscar o usuário que utilizou para acessar e configurar o 2C, mas é importante que este usuário tenha o perfil de Tenant Admin na Plataforma Carol.

Caso o usuário não seja Tenant Admin, ou queira alterar o usuário responsável, é possível clicar em Reset connector token para atualizar essa informação.







Após preencher os dados acima, e clicar em "Next: Configure" serão apresentados os campos para informar as configurações de conexão com o Banco de Dados do qual necessita enviar os dados para plataforma. Essa configuração muda de acordo com o tipo de Banco de dados (Oracle, SQL, etc). O ideal é que seja feito junto com o DBA da empresa, pois normalmente ele é o detentor das informações do seu banco de dados.



IMPORTANTE: Avaliar com a infraestrutura interna ou TOTVS Cloud as permissões para o usuário do banco de dados que será utilizado para configurar o 2C:

IMPORTANTE: Para Banco de Dados Oracle, dependendo do usuário do banco de dados configurado você pode precisar ajustar no arquivo application.yml o parâmetro oracleUseOwnerAsQueueSchema: para true ou false.

A tela seguinte a adição das informações do banco de dados apresentará duas opções:

A primeira opção será "Enable Matching Entities", ao selecionar essa opção, todas as tabelas compatíveis com seu conector serão ativadas e, isso não permitirá que você adicione uma condição/filtro na sincronização de dados para a Plataforma Carol.

IMPORTANTE: Se ao lado de matching entities não apresentar o número de tabelas compatíveis, será necessáiro revisar todos os passos acima, pois pode ser que tenha informado o Connector incorreto, ou que o usuário do banco de dados informado, não possua permissões para acessar o diretório e/ou não tem a staging table na Plataforma Carol.

A partir do momento que clicar no botão Enable, o 2C deve enviar a primeira carga de dados
e será considerado como padrão o sincronismo online, porém, muita atenção, dependendo das permissões do usuário do Banco de Dados ou se for um diretório não irá funcionar o sincronismo online, então ajuste sua estratégia de sincronização para BATCH ou outras, em caso de dúvidas acesse o artigo abaixo:

TOTVS CAROL - Carol Connect (2C) - Como definir a estratégia de sincronização de dados para Plataforma Carol?

Abaixo um exemplo das tabelas que foram habilitadas para o envio dos dados para a Plataforma Carol:

A segunda opção será "Select entities", essa opção trará todas as tabelas desativadas e permitirá que você selecione as tabelas que deseja ativar para o envio de dados a Plataforma Carol, além de permitir que adicione uma condição/filtro para a sincronização de dados será possível definir a estratégia desta sincronização.

Para adicionar uma condição/filtro em uma tabela, visite a documentação: TOTVS CAROL - Carol Connect (2C) - Como filtrar os dados que serão enviados para Plataforma Carol

Após a ativação das tabelas, os dados serão enviados e sincronizados com a Plataforma Carol.
Para entender como a integração dos dados enviados para o Backoffice, acompanhe a documentação - TOTVS CAROL - Carol Plataforma - Como funciona a integração de dados com o Backoffice?

Saiba Mais
CLIQUE AQUI para acessar mais artigos e FAQs sobre a TOTVS Carol
CLIQUE AQUI para acessar a documentação técnica da TOTVS Carol no TDN
CLIQUE AQUI para acessar a documentação técnica da TOTVS Carol do LABS