GE - Como Fazer - Configuração da Cia IA do CIGAM

De CIGAM WIKI

Voltar

Como Fazer > Utilidades/Diversos > Configuração da Cia IA do CIGAM

Como a Cia funciona?

[editar]

A Cia, a IA do CIGAM, é composta por uma aplicação e um serviço, ambos hospedados na Nuvem CIGAM e executados como um SaaS (Software como Serviço). O SaaS é um modelo de aplicação acessada diretamente pelos usuários finais através do navegador de internet.
A execução através do modelo SaaS garante que toda a infraestrutura necessária permaneça sob responsabilidade da CIGAM na Nuvem CIGAM, oferecendo:

  • Atualizações em tempo real, sem necessidade de intervenção do cliente.
  • Treinamento de forma compartilhada, adicionando novas funcionalidades, otimizando performance e resultados.

Versões de navegadores
Para garantir o pleno funcionamento da Cia, é aconselhável utilizar os navegadores Google Chrome ou Microsoft Edge, sempre atualizados para a última versão disponível, pois são os navegadores homologados pela CIGAM. Além disso, recomenda-se que a extensão associada ao arquivo .html esteja configurada, por padrão, para abrir em um desses navegadores. Essa configuração assegura que relatórios, portais e páginas sejam carregados corretamente, proporcionando maior compatibilidade, segurança e desempenho. Para mais informações, acesse: Versões de navegadores

Importância do uso do HTTPS
A Cia sempre notificará o usuário caso ele esteja utilizando o protocolo HTTP, recomendando o uso do protocolo HTTPS. Isso ocorre por dois motivos principais:

1. Segurança: O HTTPS criptografa os dados transmitidos, garantindo maior proteção contra interceptações e ataques.
2. Funcionalidades: O HTTPS permite que a Cia utilize recursos adicionais, como o microfone para reconhecimento de voz, aplicativo para dispositivos móveis, etc. Caso o usuário esteja em HTTP, a Cia automaticamente desativa essas funcionalidades por questões de segurança.
Para mais informações sobre a importância do uso do HTTPS, acesse: Importância do uso do HTTPS

Integração com o ecossistema CIGAM
A Cia será executada como uma página web no navegador de internet, acessando todo o ecossistema do CIGAM através das credenciais do usuário logado, da mesma forma que o usuário acessaria se estivesse logado diretamente no CIGAM.

Cia para dispositivos móveis
A Cia também oferece suporte para dispositivos móveis, proporcionando acesso prático e otimizado. Para utilizar a Cia em um dispositivo móvel, basta acessar o endereço normalmente pelo seu navegador. Ao entrar, será exibida uma mensagem convidando o usuário a instalar o aplicativo. A instalação também pode ser realizada diretamente através do ícone de engrenagem, no menu de configurações.

É importante destacar que a instalação do aplicativo no dispositivo móvel só será possível se o ambiente estiver configurado para utilizar HTTPS. Caso contrário, o usuário só poderá acessar a Cia diretamente pelo próprio navegador móvel, porém com algumas restrições de funcionalidades.

Configurações de CORS

[editar]

A forma como a Cia é executada, operando como um SaaS, pode causar restrições relacionadas ao CORS (Compartilhamento de Recursos entre Origens Diferentes). O CORS é um mecanismo de segurança implementado pelos navegadores para proteger os usuários, restringindo solicitações de recursos entre diferentes domínios não permitidos. Essas restrições podem causar erros ao tentar acessar cookies e outras informações.

Cookies são pequenos arquivos armazenados no computador ou dispositivo do usuário que contém informações sobre a atividade do usuário em sites para melhorar a experiência de navegação.

Para o navegador, domínios diferentes são tratados de forma separada por questões de segurança. A Cia estará hospedada em um domínio (da CIGAM Corp. na Nuvem CIGAM). E o CIGAM Web do usuário estará em outro domínio, que pode ser em um servidor on-premise (local) ou em qualquer Nuvem, inclusive na Nuvem CIGAM.

Voltar ao início

Ambientes com acesso externo às aplicações

[editar]

Esse seria o ambiente ideal para utilizar a Cia, o qual possui acesso externo às aplicações do CIGAM, como Portais, APIs, etc.. Esse ambiente é acessível via internet e deve possuir HTTPS configurado com um domínio público.

Como configurar o web server (Microsoft IIS)?

[editar]

Para permitir que a Cia acesse as aplicações do ambiente com acesso externo, é necessário configurar o Web Server no Microsoft IIS. O principal ajuste será a inclusão do cabeçalho de resposta denominado CSP (Content-Security-Policy). O CSP define diretrizes que instruem o navegador sobre as fontes permitidas para diferentes tipos de conteúdo em uma página da web. Essa configuração pode ser realizada das seguintes formas:

Configuração via arquivo web.config

[editar]

A maneira mais simples e rápida de realizar essa configuração é por meio da criação ou edição do arquivo Web.config, que funciona como um "manual de instruções" para o sistema. Sempre que você ajusta configurações no Microsoft IIS, esse arquivo pode ser criado ou modificado automaticamente.

No entanto, é importante destacar que o arquivo Web.config pode não existir em alguns ambientes. Isso ocorre porque, até então, não utilizávamos esse tipo de configuração como padrão em todos os portais. Portanto, caso o arquivo não esteja presente, será necessário criá-lo manualmente.

Esse arquivo deve ser criado (ou editado) na pasta raiz do site que engloba todas as aplicações, permitindo que a Cia tenha acesso a todos os domínios e aplicações de forma unificada. Por ser um arquivo geral, o Web.config afeta todas as aplicações vinculadas à raiz do site. Portanto, a configuração nesse local garante abrangência e evita a necessidade de repetir ajustes em cada aplicação individualmente.

Se o Web.config já existir, não é necessário substituí-lo. Basta adicionar ou ajustar as permissões necessárias, tomando cuidado para não alterar outras configurações já existentes, a fim de evitar impactos indesejados no ambiente.

Se estiver trabalhando com sites separados, além das URLs da Cia, é necessário incluir os endereços de todas as demais aplicações. Caso contrário, elas não poderão ser carregadas corretamente nos demais Portais e aplicações, pois a configuração padrão permite apenas 'self', ou seja, restringe o acesso a aplicações do mesmo site e da Cia.

Lembre-se de que, mesmo que a maioria dos Portais e aplicações estejam todos no mesmo site, se você tiver um Portal em React, ele provavelmente estará hospedado em um site separado. Por isso, é fundamental incluir a URL desse Portal nas configurações. Caso contrário, ele poderá enfrentar restrições ao carregar outras aplicações, causando falhas na exibição dos conteúdos integrados.

Importante: Essas configurações devem ser feitas apenas para os ambientes que tiverem HTTPS configurados.


Exemplo com as pastas das aplicações do CIGAM Web em C:\inetpub\wwwroot\cigam no Web Server IIS:

Web Config
Web Config


Também é possível copiar e utilizar o código abaixo para facilitar a configuração:

   <?xml version="1.0" encoding="UTF-8"?>
   <configuration>
   <system.web>
       <httpCookies requireSSL="true" sameSite="None" />
       <sessionState cookieSameSite="None"/>
   </system.web>
   <system.webServer>
       <httpProtocol>
           <customHeaders>
               <add name="Content-Security-Policy" value="frame-ancestors 'self' https://services.cigam.cloud http://services.cigam.cloud;" />
           </customHeaders>
       </httpProtocol>
   </system.webServer>
   </configuration>

Como dar acesso através do IIS?

[editar]

Para configurar o CSP diretamente no IIS, siga os passos abaixo:

1. Acesse o Gerenciador de Serviços de Informações da Internet (IIS) e localize o site que deseja liberar o acesso.

2. Abra a opção Cabeçalhos de Resposta HTTP no painel do IIS, selecione o site desejado e clique em Cabeçalhos de Resposta HTTP.


3. Adicione o cabeçalho Content-Security-Policy na seção Ações, localizada à direita, clique em Adicionar.


4. Na caixa de diálogo que será exibida, preencha os seguintes campos:


Lembre-se que caso esteja com um ambiente com sites separados, além dessas URLs da Cia, é necessário incluir os endereços dos demais sites.

Como configurar o acesso aos cookies no IIS?

[editar]

Para permitir que a Cia acesse os Cookies das aplicações, será necessário ajustar algumas permissões. Siga os passos abaixo:

  • Acesse o Editor de Configurações no painel do IIS, localize a opção Editor de Configurações dentro da seção Gerenciamento.



  • Ajuste as configurações em httpCookies:
    • Navegue até a seção system.web e localize a configuração httpCookies.
    • Defina os seguintes valores:
    • requireSSL: True
    • sameSite: None


  • Configuração de sessionState:
    • Ainda em system.web, localize a configuração sessionState.
    • Altere o valor da propriedade cookieSameSite para None.



Essas configurações garantem que os cookies sejam transmitidos com segurança e permitam o uso adequado em aplicações externas, atendendo aos requisitos da Cia.

Voltar ao início

Ambientes internos sem acesso externo às aplicações

[editar]

Este ambiente possui acesso restrito à rede interna da empresa e utiliza o protocolo HTTP. Por esse motivo, algumas funcionalidades da Cia serão desabilitadas automaticamente — como recursos que exigem permissões avançadas do navegador, como o uso do microfone, ou o acesso dinâmico a iframes (componentes que permitem exibir conteúdos de outros sistemas dentro da mesma tela, como Portais).

Importante: Você não precisa se preocupar. A Cia detecta automaticamente essas limitações e desativa ou oculta as funcionalidades afetadas, garantindo que a experiência continue fluida e segura. Sempre que necessário, você será notificado com orientações claras sobre o que fazer.

Para mais informações sobre a importância do uso do HTTPS, acesse: Importância do uso do HTTPS

Voltar ao início

Configurações para Cia no CIGAM

[editar]

Algumas configurações e parametrizações no CIGAM são necessários para garantir o funcionamento adequado da Cia, conforme o seu ambiente. Verifique se todas as aplicações estão em um único site ou distribuídas em mais de um e configure-as conforme a necessidade.

Ambiente padrão com único site

[editar]

Normalmente, os Portais, API, BI, entre outras aplicações são instalados no mesmo local, ou seja, com mesmo site, domínio e porta. Esse é o ambiente mais fácil de configurar, exigindo apenas os seguintes ajustes:



Ambiente com mais de um site

[editar]

Em alguns casos, às aplicações podem estar instalados em locais diferentes, ou seja, em sites, domínios ou portas distintas. Nesses cenários, é necessário realizar configurações específicas para que a Cia consiga se comunicar corretamente com cada um deles.

  • Quando o ambiente possui aplicações distribuídas em sites separados, podemos utilizar a configuração GE - AM - 3159 - Local de Instalação dos Portais Base para definir o endereço onde a API está hospedada. Para os demais Portais e aplicações, é possível utilizar nomes lógicos no arquivo Magic.ini, informando cada um dos endereços. Alternativamente, todas as aplicações podem ser configuradas apenas por meio de nomes lógicos, sem a necessidade de utilizar essa configuração. Para mais informações sobre como configurar nomes lógicos, consulte a documentação: GE - Como Fazer - Configuração do menu mosaico nos Portais Web



Autenticação em duas etapas e configurações de envio de e-mail

[editar]

Independente do ambiente, para acessar a Cia, é obrigatório que o usuário que for utilizar, tenha habilitado a autenticação em duas etapas para realizar o login. Se precisar de ajuda para configurar, consulte a documentação: GE Autenticação em duas etapas

E caso o envio de e-mails ainda não esteja configurado, será necessário configurar, pois a autenticação em duas etapas depende dessa configuração. Se precisar de ajuda para configurar o envio de e-mails, consulte: GE - Como Fazer - Configuração de Envio de E-mail no CIGAM

Configuração do BI para integração com a Cia

[editar]

Se o ambiente possuir um BI instalado e for utilizado pela Cia, é necessário garantir que a URL da API CIGAM esteja devidamente configurada. Caso ainda não esteja informada, adicione a URL nas configurações:


Voltar ao início

Garantindo permissão de acesso aos cookies de terceiros no navegador

[editar]

Por padrão, os navegadores geralmente têm a permissão para Cookies de terceiros habilitada. No entanto, é importante verificar e assegurar essa configuração. Abaixo estão os passos para os navegadores Microsoft Edge e Google Chrome:

  • Microsoft Edge
    • Em Português:
      • Acesse Configurações → Cookies e permissões de sites → Gerenciar e excluir cookies e dados do site.
      • Desabilite a opção "Bloquear cookies de terceiros".
    • Em Inglês:
      • Acesse Settings → Cookies and Site Permissions → Manage and delete cookies and site data.
      • Desabilite a opção "Block third-party cookies".



  • Google Chrome:
    • Em Português:
      • Vá para Configurações → Privacidade e segurança → Cookies de terceiros.
      • Habilite a opção "Permitir cookies de terceiros".
    • Em Inglês:
      • Vá para Settings → Privacy and security → Third-party cookies.
      • Habilite a opção "Allow third-party cookies".

Voltar ao início

Disponível em “https://www.cigam.com.br/wiki/index.php?title=GE_-_Como_Fazer_-_Configuração_da_Cia_IA_do_CIGAM&oldid=148854”