CLI Dattos: comandos e capacidades
CLI Dattos: comandos e capacidades
Este artigo é a referência dos comandos da CLI Dattos, organizados por área. Todos aceitam --help para a documentação completa de flags, e dattos status-glossary explica o significado de qualquer status retornado pela plataforma. Para instalação e autenticação, veja "CLI Dattos: instalação e primeiros passos".
Escopo atual: a CLI cobre a Automação de Processos (fluxos, execuções, conciliação, relatórios), a Gestão de Tarefas e a administração da plataforma. O módulo Comprovação de Contas ainda não está disponível por CLI — a cobertura está prevista na evolução do produto. Requer Dattos 16.4 ou superior.
Fluxos e execução (dattos etl)
O grupo central da CLI — cobre o ciclo de vida dos fluxos de preparação de dados e conciliação:
Criar e construir com o Dattos AI:
etl create --name <nome>cria a análise;etl add-source --etl <id> --file <arquivo>adiciona fontes (xlsx, csv, pdf, xml);etl pipeline create "<descrição em linguagem natural>" --etl <id>constrói o fluxo completo com inteligência artificial (aceita--rules <documento>com as regras de negócio). O atalhoetl newfaz tudo em uma chamada.Executar:
etl start <id> --date <AAAA-MM-DD>dispara a execução para uma data de referência;--filesobe o arquivo antes,--waitacompanha até concluir,--incrementalpreserva os dados já carregados.Acompanhar e gerenciar:
etl execution-status <id> --date <data>,etl list,etl get <id>,etl resolve <código>(traduz código para identificadores),etl datasources <id>,etl publish <id>(promove o rascunho a versão publicada) eetl activate/etl deactivate.Backup e restauração:
etl download <id>baixa o blueprint.xdttdo fluxo;etl upload <id> --file <blueprint>restaura.Calendário:
etl set-calendartroca o calendário de execução do fluxo.Construção avançada: para montar o fluxo etapa a etapa por programação, existem
etl add-step,etl connect,etl configure-step,etl set-params,etl add-matching,etl components(catálogo e parâmetros de cada etapa),etl formulas(referência da Fórmula Dattos),etl sql-help,etl step-data(amostra da saída de uma etapa) eetl refresh-sample.
Não existe exclusão definitiva de fluxo. O comando etl deactivate é o equivalente ao excluir: esconde o fluxo das listagens e é reversível com etl activate.
Consulta de resultados
dattos loads:loads get <análise> <data>retorna o carregamento e seus conjuntos de dados;loads list-dateslista as datas de referência com dados;loads viewslista as visões disponíveis.dattos datasets:datasets search <análise> <load> <dataset>consulta as linhas do resultado, com paginação e filtros em JSON.dattos matching:matching statustraz os totais da conciliação (conciliados, pendentes),matching summaryo resumo por coluna ematching getos registros. As regras ficam emmatching rules(add,update,delete,active), o catálogo emmatching configs list, os responsáveis emmatching responsible liste o avanço no fluxo de aprovação emmatching stage.
Exportação (dattos reports)
reports generate <análise> --load-id <id> --dataset-id <id> --format csv|xlsx— geração assíncrona.reports statusacompanha ereports download <análise> <reportId> --output <arquivo>baixa o resultado.
Limite de formato: acima de 1 milhão de linhas, a exportação está disponível apenas em CSV.
Gestão de Tarefas (dattos tasks)
Leitura e escrita completas sobre o módulo de tarefas:
Listar e filtrar:
tasks listcombina filtros de pasta, responsável, etiqueta e prazo, com paginação.Detalhar:
tasks get <id>traz o detalhe completo, incluindo contadores de comentários e anexos.Criar:
tasks createaceita título, datas e recorrência — diária, semanal, mensal ou anual, com variações como "somente dias úteis", "3 dias úteis antes do fim do mês" ou "segunda semana do mês".Atualizar e mover:
tasks updatealtera campos; a mudança de estágio é sempre portasks move(nos dois sentidos).Registrar:
tasks commentadiciona comentário etasks attachanexa arquivo ou URL.Exportar:
tasks report --output <arquivo.xlsx>baixa o relatório de tarefas.
Dois filtros que se parecem, mas não são o mesmo. O estágio é o passo manual da tarefa (pendente, em andamento, concluído, cancelado). O status é calculado pela plataforma a partir dos prazos (atrasada, no prazo, concluída no prazo, concluída com atraso, concluída com antecipação, cancelada).
Administração
dattos users: listar, criar, atualizar, bloquear e excluir usuários;users set-rolesdefine os perfis;users sessionseusers kill-sessiontratam das sessões ativas.dattos roles: gestão dos perfis de privacidade — CRUD, escopo de pastas (roles folders) e níveis de aprovação de conciliação (roles approval-levels).dattos connectors: conectores de banco de dados — criar, testar (connectors test), ativar/desativar.dattos calendars: consulta dos calendários de execução.dattos batch: operações em massa —batch batch-startexecuta várias análises em sequência;batch batch-create --file <usuarios.json>cria usuários em lote.dattos folders: navegação, seleção do contexto de pasta e criação de pastas.
Atenção com `users set-roles` e `roles folders set`: os dois substituem a lista inteira, não acrescentam. Para incluir um item preservando os demais, use roles folders add (e remove para retirar).
Utilitários
dattos doctor [--deep]— diagnóstico de configuração, conectividade, autenticação, versão da instância e pasta ativa.dattos config profile list|switch— perfis para múltiplas instâncias/ambientes.dattos cache clear— limpa o cache local de consultas (TTL de 5 minutos; operações de escrita invalidam automaticamente).dattos mcp install <ferramenta>— configura o servidor MCP local nos assistentes de inteligência artificial. Para o caminho hospedado, que é o recomendado, veja o artigo de MCP.dattos versionedattos status-glossary.
Comportamento e limites
Arquivos aceitos no upload:
.csv,.edi,.ofx,.pdf,.rem,.ret,.txt,.xlsx,.xls,.xlsb,.xml.Exclusões pedem confirmação: comandos destrutivos (
users delete,roles delete,connectors delete,matching rules delete,users kill-session) exigem a flag--yes.Limite de requisições: ao receber HTTP 429, a CLI reexecuta automaticamente até 3 vezes com espera progressiva (5s, 10s, 20s).
Tempo limite: 30s nas chamadas comuns; 120s em upload e download; 10 minutos nos fluxos de inteligência artificial (streaming).
Códigos de saída:
0sucesso,1erro da API,2autenticação/configuração — os erros saem em JSON no stderr comnext_stepecorrelation_idpara suporte.