TOTVS CAROL - Carol Plataforma - Como exportar dados da Plataforma Carol via Python usando PyCarol

Tempo aproximado para leitura: 00:15:00 min

Dúvida
Como exportar dados da Plataforma Carol via Python usando PyCarol?

Ambiente
TOTVS CAROL - Carol Plataforma - Todas as versões

Solução
Para exportar dados do BIG QUERY da Plataforma Carol usando Python (PyCarol) basta seguir os passos abaixo e os arquivos de modelo anexos neste artigo. Clique aqui para mais informações sobre o PyCarol.

Para essa ação vamos usar o VsCode bastando instalar as extensões necessárias. São sugeridas as seguintes:



Crie um arquivo nomeado de carol.json (modelo anexo) e informe suas credenciais de LOGIN da Plataforma CAROL no formato abaixo:

{

   "login":"seu.email@totvs.com.br",

   "password":"suasenha"

}

São os mesmos usados para acessar seu Ambiente/Tenant na Plataforma Carol:



Depois abram no VsCode e executem o código do arquivo chamado: export.ipynb (modelo anexo).

Pontos de atenção:
1- Verifique o diretório onde está o arquivo JSON com suas credenciais.



2- No código do arquivo export.ipynb informe qual a Organização e Ambiente/Tenant que deseja acessar os dados. Caso tenha dúvidas no conceito de Organização e Ambiente/ Tenant, sugiro que Clique Aqui e assista os vídeos disponibilizados pelo time de suporte. Essa informação também pode ser coletada na tela de Login do Ambiente/Tenant.

3- Verifique a Query que deseja utilizar para extrair os dados, no exemplo abaixo eu pego todos os campos da Staging Table PFUNC com dados consolidados. Mas existem infinitas possibilidades, de Joins, entre outros.



Para saber o nome completo das Tabelas existentes dentro do Big Query de cada Ambiente/Tentant você pode usar a extensão da Carol BigQuery no VsCode e/ou usar a opção de Editor através do Explorer da Plataforma Carol e executar o comando "SELECT * FROM INFORMATION_SCHEMA.TABLES".

Para mais comandos e documentos sobre o Big Query acesse a documentação do Google Big Query "Visualização de TABLES".

Para mais informações sobre a extensão Carol BigQuery do VsCode acesse a documentação disponível junto da extensão no VsCode.



4- Verifique o diretório e o nome do arquivo que será gravado com o resultado da Query.



5- O arquivo .CSV vai vir com os dados em uma única coluna e separados por vírgula, basta usar o Excel para separar os dados.



Atenção: Ao executar o código, caso ocorra o erro "ModuleNotFoundError: No module named 'openpyxl" indica que o módulo openpyxl não está instalado no seu ambiente Python. Esse módulo é comumente usado para trabalhar com arquivos do Excel no Python.

Para corrigir esse erro, é necessário instalar o módulo openpyxl. Você pode fazer isso executando o seguinte comando no terminal do seu ambiente Python:

 pip install openpyxl

Saiba Mais
CLIQUE AQUI para acessar mais artigos e FAQs do suporte relacionados a TOTVS Carol
CLIQUE AQUI para acessar a documentação técnica da TOTVS Carol no TDN
Plataforma Carol - Manual do Usuário