BI Instalação
Este guia tem como objetivo orientar, passo a passo, o processo de instalação do BI da CIGAM, contemplando desde os pré-requisitos até a configuração final do ambiente. O BI CIGAM é composto por diferentes componentes — aplicação desktop, aplicação web, serviço de agendamento e base de dados própria — que devem ser configurados corretamente para garantir o pleno funcionamento da solução.
A instalação foi simplificada nos últimos anos com a disponibilização de uma base padrão do BI, semelhante ao que já ocorre no ERP CIGAM. Essa base inclui cadastros essenciais e até mesmo painéis analíticos pré-configurados, facilitando o início da utilização e reduzindo significativamente o tempo de implantação.
Neste documento, utilizaremos a base padrão como referência para ilustrar cada etapa da instalação. O foco principal será o ambiente com SQL Server, embora as orientações possam ser adaptadas para instalações em Oracle, quando necessário.
Ações recomendadas:
- Para novas instalações: utilize exclusivamente a base padrão BI disponibilizada e siga o roteiro técnico atualizado.
- Para ambientes já instalados: atualize a versão da aplicação do BI do cliente, revise os pontos existentes, conexões e serviço de agendamento, aplicação WEB e Desktop. Para mais informações, consulte Atualização BI CIGAM - Dúvidas Gerais.
- Durante a implementação dos Dashboards: ao surgirem dúvidas relacionadas a regras de negócio, indicadores específicos ou interpretações dos dados apresentados, solicite o apoio dos consultores responsáveis pelos módulos envolvidos (como Vendas, Compras, Contábil, Financeiro, etc.). Eles são fundamentais para garantir a validação correta das informações e evitar distorções nas análises.
Índice
- 1 Requisitos Iniciais
- 2 Criação e Preparação da Base de dados
- 3 Estrutura de Arquivos e Pasta do BI
- 4 Solicitação e Ativação da Licenca
- 5 Acesso ao BI Desktop
- 6 Instalação Serviço BI
- 7 Instalação BI WEB
- 8 Implementação dos Dashboards
- 8.1 Dashboards Compras
- 8.2 Dashboards Contábil
- 8.3 Dashboards Custeio Integrado
- 8.4 Dashboards módulo Estoque/Produção
- 8.5 Dashboards de Vendas
- 8.6 Dashboards de Estratégia e Gestão
- 8.7 Dashboards Financeiro
- 8.8 Dashboards Pedidos
- 8.9 Dashboards Planejamento Orçamentário
- 8.10 Dashboard Ponto de Equilíbrio
- 8.11 Dashboards Produção
- 8.12 Dashboards Projetos
- 8.13 Dashboards Projetos CIGAM
- 8.14 Dashboards RH
- 9 Considerações Importantes
- 10 Suporte e Dúvidas
Requisitos Iniciais
- Servidor Compatível(SQL Server ou Oracle);
- Acesso as Credenciais de Banco
Criação e Preparação da Base de dados
- Servidor com SQL Server ou Oracle homologados para uso do CIGAM, assim como para bases aplicação BI.
- Base ERP CIGAM operante;
- Acesso às credenciais do banco (usuário, senha, host, instância);
- Arquivo da base padrão do BI (formato .bak para SQL ou .dmp para Oracle);
- Acesso ao arquivo Magic.ini do CIGAM;
- Licenca ativa para o BI;
Criação e Restauração da Base de Dados BI
- Crie uma nova base de dados no SQL Server chamada "CIGAM_BI" (padrao, mas pode ter outro nome).
- Descompactar a base padrão do BI.
- SQL: Restaure o .bak
- Se for Oracle: Importe o .dmp
Não utilizar nomes aleatórios como "Base_BI_Teste". Seguir o padrão é importante para facilitar manutenção futura.
Observação:
Ao importar a base padrão, ela virá com duas conexões configuradas:
- Conexão Base Produção CIGAM (Origem);
- Conexão Base BI (Destino);
Atenção – SQL Server e Collation:
No SQL Server, cada banco de dados possui propriedades específicas, como o Collation, que define regras de comparação e ordenação de caracteres. A base CIGAM e a base BI devem utilizar o mesmo collation: Latin1_General_CI_AI.
Assim com a instância SQL também tem este collation,ou seja, se vai informar que será Case Sensitive, vai validar caracteres maiúsculos e minúsculos, entre várias outras propriedades.
É fundamental garantir que:
- O banco BI seja criado com o mesmo collation da base CIGAM: Latin1_General_CI_AI.
- Caso a instância SQL esteja configurada com um collation diferente, o collation deve ser definido manualmente no momento da criação do banco.
Por que isso é importante?
Ao restaurar um backup, o banco já herda o collation original da base de origem. No entanto, se for criada uma base nova (zerada), é necessário informar explicitamente o collation durante a criação. Caso contrário, o banco herdará o collation padrão da instância.
Consequência de collations diferentes:
- Se as bases CIGAM e BI estiverem com collations diferentes, a comunicação entre elas via SQL poderá apresentar erros, exigindo tratamentos manuais no código, o que pode gerar retrabalho ou até corromper dados.
Recomendação: Antes de iniciar a instalação do BI, sempre verifique e confirme o collation da base que será utilizada. Ele deve ser idêntico ao da base CIGAM para garantir a compatibilidade e integridade da comunicação entre os bancos.
Lembrando:
Se o banco utilizado for Oracle, é necessário solicitar ao DBA a base padrão no formato dump, que deve ser importado no banco Oracle. Também deve ser criado um usuário Oracle com o mesmo nome utilizado no SQL Server(CIGAM_BI).
Por que utilizamos duas bases de dados: CIGAM e CIGAM_BI?
No contexto do BI, realizamos diversas consultas SQL, além da construção de painéis e relatórios sobre a base CIGAM_BI, que recebe os dados extraídos da base transacional CIGAM (origem). Como estamos lidando com grandes volumes de dados, essas consultas podem se tornar muito pesadas para o banco.
Se ambas as bases estiverem no mesmo ambiente em que o ERP CIGAM está sendo executado, podem surgir problemas de desempenho, como lentidão no sistema, travamentos ou bloqueios de registros durante a execução de painéis e consultas, afetando diretamente a experiência do usuário final.
Importante:
É possível, e até recomendado em alguns cenários, que a base CIGAM e a base CIGAM_BI estejam em servidores distintos, caso a infraestrutura do cliente permita.
No entanto, também é tecnicamente viável manter as duas bases no mesmo servidor — seja por meio de bancos de dados distintos (SQL Server) ou schemas diferentes (Oracle) — desde que o ambiente esteja dimensionado adequadamente para suportar a carga.
Estrutura de Arquivos e Pasta do BI
- Copie os arquivos da versão mais recente do BI para a pasta C:\CIGAM_BI.
A pasta conterá os executáveis:
- UtilitarioMenu.exe: instalador e atualizador;
- MenuBI.exe: executa o BI Desktop;
Instalação do BI Desktop
- Execute Utilitario(Cigam.Controladoria.Geral.Utilitario.WinForms.exe) e clique em "Instalação".
- Preencha os dados da conexão da base onde o BI CIGAM será instalado (CIGAM_BI):
- Neste exemplo está na própria máquina local;
- Mas caso fosse em um ambiente de produção seria o nome ou IP do servidor SQL:
- Usuário e senha de banco:
- Nome da base (ex: CIGAM_BI):
- Testar Conexão:
- Marcar a Opção Utiliza CIGAM e desmarque a opção "Mesma conexão do CIGAM":
- Informe então a conexão com a base do CIGAM (ERP).Esta opção habilita após desmarcar o check box orientado no passo anterior:
- Nome/IP do servidor,usuário e senha de banco,nome da base CIGAM Produção:
- Magic.ini:
Aponte para o caminho completo do arquivo Magic.ini que tem todos os dados de inicialização do CIGAM, entre eles parâmetros dos nomes lógicos, sendo eles nome lógicos de banco em que podem ter traduções distintas e é este arquivo que irá dizer a traduções das tabelas.
Se houver um servidor de aplicação e o CIGAM estiver instalado em uma unidade de rede mapeada, não utilize a letra da unidade de rede neste campo. Por exemplo, se o CIGAM está localizado em W:\CIGAM11, e todos os usuários acessam por esse caminho mapeado, utilize o caminho completo da rede: \\SERVIDOR\CIGAM11\Magic.ini.
Isso é importante porque o local onde o CIGAM BI será executado pode não ter essa unidade de rede mapeada, o que pode causar erro na execução. Utilizar o caminho (\servidor...), pois garante o acesso independente da sessão ou do mapeamento da unidade.
Na imagem acima como estamos no servidor de aplicação o caminho é C:CIGAM.
Como tratar variação de ambiente no BI?
Quando o cliente utiliza variação de ambiente no ERP CIGAM, é comum surgir a dúvida: como essa variação é levada para o BI?
Resposta:
Ela não é levada. O BI não trabalha com variação de ambiente.
Para entender melhor: no ERP CIGAM, a variação de ambiente é um recurso que permite restringir os dados exibidos para cada usuário. Por exemplo:
- O usuário X acessa apenas os pedidos da UN 001.
- O usuário Y acessa apenas os pedidos da UN 002.
Essa lógica é configurada por meio do arquivo Magic.ini, utilizando o prefixo %CGVARIACAOAMBIENTE% nos nomes lógicos das tabelas que variam conforme o ambiente. Essa é uma particularidade do ERP.
No entanto, o BI não interpreta variações de ambiente automaticamente. Para que ele consiga ler corretamente os dados, é necessário criar um adendo ao arquivo de conexão. Nesse adendo, deve-se explicitamente informar que as tabelas com variação de ambiente devem ser lidas sem aplicar essa variação.
Exemplo:
Se a tabela de pedidos possui variação no ERP, no adendo é preciso indicar que o BI deve acessá-la sem aplicar a variação, ou seja, carregando todas as unidades.
Informe o caminho do adendo (se houver variacoes de ambiente):
IMPORTANTE: O BI sempre lê os dados de forma completa (full). Qualquer tipo de restrição de visualização por unidade, usuário ou perfil deverá ser tratada dentro do próprio BI, por meio de regras de segurança ou filtros personalizados.
Ação necessária:
Caso o cliente utilize variação de ambiente, informe o caminho do adendo ao Magic.ini para que o BI possa interpretar corretamente as tabelas sem aplicar essas variações.
- Informe a chave da API do Google Maps se utilizar funções de geolocalização;
- Clique em "Próximo":
Apresentou a mensagem “O processo de instalação já foi executado anteriormente, utilize opções de “Atualização” ou “Manutenção”.
Como está sendo feito a instalação de uma base padrão, ali já tem o BI instalado. Só executa a rotina de atualização para criar ou atualizar.
Solicitação e Ativação da Licenca
- No UtilitarioMenu.exe, clique em "Solicitar Licenca":
- O sistema preencherá o CNPJ automaticamente (do ambiente do ERP):
- Informe e-mail de contato e descrição:
- Solicite a licença;
- A equipe comercial da CIGAM deverá aprovar a licenca:
- Solicite novamente para importar e validar a licenca na mesma tela de solicitação:
Acesso ao BI Desktop
- Execute MenuBI.exe:
- Login:
IMPORTANTE: Os usuários do BI são independentes dos do CIGAM;
Tipos de Licenca e Controle de Acesso
- Licencas são nomeadas, não simultâneas (diferente do ERP CIGAM);
- Tipos de licenca;
Visualizador: apenas visualiza dashboards;
Desenvolvedor: pode criar/editar dashboards;
Desenvolvedor Inicial: 1 obrigatoriamente incluso;
Servico: usado para tarefas e agendamentos (1 incluso automaticamente);
Receber Alertas Serviço: Permite receber notificações sobre o funcionamento do serviço, mesmo sem acesso direto ao BI, sem relação com a inicialização do serviço;
Mais detalhes acesse:
GDI - Configuração das Conexões
- Acesse a tela GDI do BI;
- Edite as conexões "BASE_BI" e "BASE_CIGAM" com os dados do servidor que foram configurados inicialemento;
- Teste cada conexão para garantir funcionamento;
Instalação Serviço BI
- Acesse novamente o Menu utilitários em Agendamentos:
- E crie o serviço que será aplicado para atualizar os paineis automaticamente através do serviçoCigam.Controladoria.Agendamento.Serviço;
Possíveis Mensagens na Instalação do serviço
- Caso apresente a mensagem: Usuário não possui permissão para acessar o agendamento,necessário o direito de administrar Agendamento.
- Acesse novamente o Menu utilitários em Agendamentos:
- Neste caso é necessário além de ter uma licença de visualizador precisa estar com direito administrador de agendamento:
- Caso apresente a mensagem:Informe os dados do servidor de e-mail:
- Tem dois locais que podem ser configurado os e-mails:
- Utilitários > Manutenção > Servidor e-mail
- Ou através da aplicação BI Desktop no Menu Configurações:
- Se apresentar a mensagem:Não foi encontrada a licença para o Serviço, deseja solicitar agora?
- Neste caso solicitar atualização da licença do serviço do BI com a equipe CIGAM Comercial, ou ainda ele pode automaticamente importar.
- Se você confirmar e apresentar a mensagem abaixo:
"C:\Users\Administrator\Desktop>C:\Windows\Microsoft.NET\Framework64\v4.0.30319\installutil.exe CIGAM.Controladoria.Agendamento.Servico.exe Microsoft (R) .NET Framework Installation utility Version 4.7.3190.0 Copyright (C) Microsoft Corporation. All rights reserved..."
Neste caso está tentando executar o comando do 3º parágrafo (“C:\Users\Administrator\Desktop>sc failure…”), mas não está conseguindo devido a mensagem apresentada no 2º parágrafo(“Exception occurred while initializing the installation…”)
Soluções:
- Executar utilitário como administrador:
Ou se ainda ocorrer, executar via linha de comando:
- Neste caso é necessário pesquisar sobre a mensagem que está sendo informada, Exception 0x80131515 para fazer este tratamento pela aplicação.
- Caso persista, solicitar apoio como a nossa equipe de Sustentação CIGAM.
- Depois do serviço instalado localizar no gerenciador do windows ajustar a inicialização deste serviço como automático.
- Na aba de recovery:
Caso tente iniciar o serviço o banco está fora, ou não iniciou alguma dependência por exemplo que precisa iniciar antes de subir este serviço, tente reiniciar este serviço.
- Após isso, o serviço da aplicação estará em execução:
- E agendamento das tarefas serão inicializadas:
Mais detalhes acesse:Gerenciamento de licença no BI
Instalação BI WEB
- Precisa instalar o IIS no servidor onde será instalado a camada web da aplicação:
- Acesse o CGImplanta:
- Onde será configurado o novo site dentro do IIS.
Observação:A porta que vai instalar 80 é a padrão da navegação http. A 443 é a porta padrão segura pelo https. Após isso confirmar e clicar no botão implantar selecionados:
- Se apresentar a mensagem: Pelo menos uma implantação apresentou erro.Verifique o log para maiores informações.
- Acessando no final do log da implantação informa que o módulo URL Rewrite não está instalado no IIS:
- Pode instalar via linha de comando powershell ou fazendo o download da aplicação direto no site da Microsoft.
- Caso necessário, entre em contato com a nossa equipe de sustentação para obter suporte.
- Após isso a instalação estará configurada no IIS:
- Se ao tentar instalar apresentar a mensagem abaixo:
- Arquivo de configuração C:\inetpub\wwwroot\cigam\bi\config.xml não foi encontrado
- Esta mensagem está informando que no caminho do arquivo não localizou o arquivo config.xml.
- Neste caso pode copiar este arquivo que existe na instalação do BI desktop para o caminho informado na mensagem apresentada no navegador web.
- Importante: toda vez que for atualizar o BI Web, sempre atualizar este arquivo também utilizando o método acima.
- Ou acessar o arquivo web.config:
- Neste parâmetro “ArquivoConfig”:
- Pode setar onde está o arquivo config na instalação do BI Desktop:
Observação: este método só irá funcionar se o usuário do IIS tiver acesso ao diretório do BI Desktop.
- Após isso, acessar o BI Web com usuário e senha para validação.
- Caso apresentar a mensagem: Ocorreu um erro ao obter Tiles.
- Normalmente esta mensagem é Permissão do usuario do IIS a pasta da aplicação de escrita e leitura no diretório do BI.
- Geralmento é utilizado os usuarios IUSR e IIS_IUSRS.
- Além disso configurar no manut do BI a URL da aplicação:
- Após isso, reiniciar o IIS.
- Após será liberado acesso aos consultores de BI para fazer a instalação dos dashboards.
Instalação de Dashboards Padrão
Verificações Iniciais
- Identifique os módulos que o cliente utiliza e confirme se há uso da Gestão de Resultados.
- Verifique as configurações:
- Preencha as configurações:100267 e 100325 com o endereço web (obtido em Configurações > Aba Web na Manutenção do BI)-Quais as configurações para habilitar o botão do BI no CRM?
- Se os painéis já existirem no ambiente, eles devem estar marcados com a flag de “disponível para download”. Confirme se as conexões GDI usam o mesmo endereço do servidor informado na manutenção BI (String conexões). Caso contrário, ajuste para evitar duplicidade de tabelas, fontes e dashboards.
Preparação da Estrutura Inicial
- Acesse o menu Preparar Estrutura Inicial,A primeira ação a ser executada quando estiver utilizando a base Auto implementável:
Selecione:
- Conexão Origem = Base Produção.
- Conexão Destino = Base BI – DW.
- Marque todas as ações iniciais.
Informe:
- Data e hora para execução do legado (dados anteriores ao BI);
Senha padrão para os usuários que serão criados (pode ser alterada depois);
- Para importar apenas os usuários do CIGAM, marque “Copiar usuários Cigam” e desmarque as demais opções.
Validação Usuário de Serviço
- Verifique se o usuário de serviço foi:
- Está ativo;
- Está com licença apropriada;
- Tem direitos atribuídos;
- Está executando (como serviço no Windows, se for ambiente de rede);
Configuração Whatsapp
Será preciso informar dados como o número de telefone do WhatsApp e as credenciais de usuário e senha correspondentes no sistema CIGAM para realizar o login na API CIGAM.
Mais detalhes acesse:Envio de whatsapp pelo alerta BI;
- (Tokens, solicitar para equipe de consultoria).
Validação Configuração de e-mail
- Solicitar ao cliente ou indicar que preencham os campos:
Implementação dos Dashboards
- Antes de começar a implementação, é fundamental verificar quais módulos o cliente possui ativados no CIGAM e quais dashboards precisam estar configurados para esses módulos.
- Para garantir que os dados exibidos estejam corretos, sempre solicite o apoio dos consultores responsáveis por cada módulo no CIGAM, além de validar as informações diretamente com o cliente quando necessário.
- Algumas pastas contêm painéis de implementação — sempre comece por eles, pois servem como base fundamental para a configuração dos demais dashboards.
A seguir, apresentamos orientações específicas para a implementação dos dashboards disponíveis no Menu de Downloads do BI.
Dashboards Compras
- Quando acessar os painéis sempre se atentar nos dashboards de Implementação. Pois este é o primeiro dashboards que precisa ser configurado para posteriormente instalar os demais pois ele é a base para todos os outros painéis.
- Implementação Compras:
- Detalhamento de como implementar: Implementação Compras
- Informação adicional dos demais dashboards : BI Compras
Dashboards Contábil
Implementação Contábil:
- Para os painéis contábeis, siga o passo a passo detalhado para garantir que as configurações estejam corretas.
- Detalhamento da implementação: Implementação Contábil
- Informações adicionais: BI Contábil
Dashboards Custeio Integrado
- Os dashboards de Custeio Integrado envolvem a conciliação entre os módulos de Estoque, Contábil, Custo Estrutural e a Aplicação BI. A instalação deve começar pelo painel Resumo - V2, que tem alto nível de complexidade. É recomendada a implementação com o suporte de consultores especialistas desses três módulos e da equipe de BI.
Materiais de apoio:
Dashboards módulo Estoque/Produção
A maioria dos painéis desta categoria pode ser instalada sem a necessidade de carga de implementação, exceto o dashboard Disponibilidade de Estoque, que requer atenção especial.
- Detalhes sobre disponibilidade: ES - Disponibilidade Estoque
- Informações adicionais: BI Estoque/Produção
Dashboards de Vendas
Todos os Dashboards relacionado a Vendas, estão relacionados diretamente com o painel de Implementação Vendas - GR
Todos os dashboards de vendas dependem do painel Implementação Vendas - GR para seu correto funcionamento.
Após a instalação, alguns cuidados são importantes:
- Sem licença do módulo Gestão do Resultado no ERP CIGAM: As configurações são avaliadas diretamente nos dashboards do Gestão do Resultado dentro da aplicação BI. Nesta situação, não há cálculo de margem. Posso utilizar Gestão de Resultados no BI mesmo que não tenha licença do Módulo Controladoria dentro do ERP CIGAM?
- Com licença do módulo Gestão do Resultado: As configurações podem ser avaliadas tanto no ERP quanto na aplicação BI, usando o dashboard de implementação do Gestão do Resultado. Nesta condição, o cálculo de margem é utilizado e é fundamental verificar a tarefa responsável pela atualização dos dados nos painéis.Mais detalhes: Guia de Boas Práticas para o Sincronismo de Documentos na Aplicação BI CIGAM.
Materiais adicionais:
Dashboards de Estratégia e Gestão
Esse dashboard exibe o desempenho comercial da empresa por mês e unidade de negócio, com foco em resultado, receita, quantidade e margem. Ele permite analisar os dados por representante, cliente, operação e nota fiscal. Há detalhamento por item vendido e uma síntese com indicadores específicos. É usado para decisões gerenciais e acompanhamento da lucratividade. A ausência de dados em algumas métricas indica que ainda não foram carregadas ou configuradas.
Importante: Deve ser instalado somente após a configuração do dashboard Implementação Vendas GR.Mais detalhes em BI Faturamento/Financeiro.
Dashboards Financeiro
- Os dashboards financeiros possuem configurações específicas que devem ser validadas no link BI Financeiro.
- Os dashboards com prefixo “GF” acessam diretamente a base do CIGAM, sem vínculo com tabelas de destino.
Dashboards Pedidos
- Podem ser instalados diretamente, mas o painel Pedidos x Vendas depende do dashboard Implementação Vendas GR para funcionar corretamente. Mais detalhes estão disponíveis em BI Pedidos.
Dashboards Planejamento Orçamentário
- Para utilizar esses dashboards, é necessária a configuração prévia do dashboard Implementação Contábil.
Dashboard Ponto de Equilíbrio
- Este painel depende do dashboard Implementação Vendas GR para seu correto funcionamento. Mais detalhes em BI Faturamento/Financeiro.
Dashboards Produção
- Podem ser instalados diretamente, sem necessidade de painel de implementação. Mais detalhes acesse:BI Estoque/Produção.
Dashboards Projetos
Este dashboard compara o orçamento previsto versus o realizado em projetos, permitindo selecionar versões diferentes para análise detalhada dos custos totais e unitários, incluindo variações absolutas e percentuais. É essencial para controle financeiro e análise de desvios.
- Está diretamente relacionado ao módulo Orçamento de Projetos no ERP CIGAM. C3 OP Orçamento de Projetos
Dashboards Projetos CIGAM
- Dashboard que disponibilizam uma visão de auditoria das atividades realizadas no ERP, com filtros por unidade, tipo e usuário, exibindo quantidades de ações em diversas áreas do sistema e alertas sobre inconsistências. Serve para controle, rastreamento e governança.
- Pode ser instalado diretamente, sem painel específico de implementação.
Dashboards RH
- Requer cadastro de conexão no GDI para a base de dados RH. Na primeira instalação, é necessário configurar a Conexão de Origem RH após o download do dashboard.
Considerações Importantes
- Não instale o BI na mesma base do ERP: causa lentidão, locks e problemas de desempenho.
- Sempre verifique o collation da base BI(Banco de Dados SQL Server).
- Usar adendo para mapear os nomes correto em variação de ambiente do magic.ini.
Suporte e Dúvidas
- Em caso de dificuldades, contatar o suporte CIGAM ou o e-mail treinamento@cigam.com.br;
