Bot de Automação de Relatórios Financeiros

[Michelemelo-collab]

README — Bot de Automação de Relatórios Financeiros

---

Descrição

Repositório: Bot de Automação de Relatórios Financeiros
Propósito: Automatizar a coleta, consolidação e envio de relatórios financeiros; servir como projeto de portfólio para Analista de Automação / RPA.

---

Status do Projeto

Status: Em desenvolvimento
Objetivo: Demonstrar habilidades em UiPath, integração com C# e SQL Server, documentação e boas práticas de GitHub.

---

Funcionalidades Principais

• Coleta de dados de planilhas e/ou fontes web
• Consolidação e transformação de dados em Excel/PDF
• Geração automática de relatório com formatação definida
• Envio de relatório por e-mail com anexo
• Logs de execução e tratamento de exceções
• Configuração para execução via Orchestrator (opcional)

---

Pré Requisitos

• Conta GitHub
• UiPath Studio Community Edition
• UiPath Orchestrator (opcional para deploy)
• Visual Studio Code ou Visual Studio (para C#)
• SQL Server Express e SSMS (se usar banco de dados)
• .NET SDK (versão compatível com os scripts C#)

---

Instalação e Como Rodar

Clonar repositório

git clone https://github.com/seu-usuario/bot-relatorios-financeiros.git
cd bot-relatorios-financeiros

Executar localmente (UiPath)

• Abrir a pasta do projeto no UiPath Studio
• Configurar Config.xlsx com caminhos, credenciais e parâmetros
• Executar o fluxo principal Main.xaml em modo Debug ou Publish

Executar scripts C#

dotnet run --project scripts/auxiliar/ScriptAuxiliar.csproj

---

Estrutura do Repositório

• /docs - BPMN, requisitos, runbooks e notas de negócio
• /projetos/uipath - Projeto UiPath (.xaml, assets, dependências)
• /scripts - Scripts auxiliares em C# e utilitários
• /sql - Scripts de criação e consultas para SQL Server (se aplicável)
• /assets - Vídeo demo, prints e exemplos de saída
• /tests - Casos de teste e dados de validação
• README.md - Este arquivo

---

Configuração e Parâmetros

• Config.xlsx (pasta /projetos/uipath/config)
  • InputPath — caminho da planilha de entrada
  • OutputPath — pasta onde o relatório será salvo
  • EmailTo — destinatário padrão
  • RetryCount — tentativas em caso de falha
  • LogLevel — nível de logs (INFO/DEBUG/ERROR)

---

Entregáveis e Critérios de Aceitação

Entregáveis

• Projeto UiPath funcional em /projetos/uipath
• Script C# auxiliar em /scripts (se aplicável)
• README.md do projeto com instruções completas
• Vídeo demo em /assets/demo.mp4 (1–2 minutos)
• BPMN e documentação de negócio em /docs

Critérios de Aceitação

• Bot executa o fluxo completo sem intervenção manual em cenário padrão
• Relatório gerado com dados corretos e formato esperado
• Logs registram início, fim e erros com detalhes suficientes
• Tratamento de exceções implementado com notificações básicas

---

Boas Práticas de Git

Branches

• main — versão estável para portfólio
• dev — integração de features
• feat/* — novas funcionalidades
• fix/* — correções

Mensagens de commit

• feat: adicionar leitura de Excel e mapeamento de colunas
• fix: corrigir tratamento de exceção ao acessar site
• docs: atualizar Config.xlsx com novos parâmetros

---

Testes e Validação

• Casos de teste em /tests com dados de entrada e saída esperada
• Teste manual: executar fluxo com dataset de exemplo e validar relatório gerado
• Teste de integração: executar script C# e validar comunicação com banco/API

---

Como Contribuir

1. Abra uma issue descrevendo sugestão ou bug
2. Crie branch a partir de dev com nome claro feat/nome ou fix/nome
3. Faça commits pequenos e descritivos
4. Abra pull request com descrição das mudanças e passos para testar

---

Licença

Licença: MIT
Adicionar arquivo LICENSE na raiz com o texto da licença.

---

Contato

Autor: Michele
LinkedIn: adicionar link no perfil GitHub
E-mail: adicionar contato profissional no perfil GitHub

---

Checklist antes de publicar no portfólio

• README do projeto completo e claro
• Config.xlsx com valores de exemplo (sem credenciais reais)
• Vídeo demo em /assets
• BPMN e documentação de negócio em /docs
• Scripts e dependências listadas
• Licença adicionada

---

Pronto para usar: copie este README para o diretório do projeto e ajuste os campos de configuração, links e nomes conforme seu repositório.