CIGAM WIKI - Contribuições do usuário [pt-br]

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

2026-10-15T19:56:57Z

Vinicius.moder: /* Desktop */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como Fazer Utilidades/Diversos_2]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como_Fazer - Configuração da Cia IA do CIGAM|Configuração da Cia IA do CIGAM]]

=Como a Cia - IA do CIGAM funciona?=
<p align="justify">
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.
<br>
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:
<br>
* Atualizações em tempo real, sem necessidade de intervenção do cliente.<br/>
* Treinamento de forma compartilhada, adicionando novas funcionalidades, otimizando performance e resultados.<br/>
</p>
Todas as configurações necessárias estão descritas em [[#Cia Web (SaaS)|Cia Web (SaaS)]]. As seções [[#Portais|Portais]] e [[#Desktop|Desktop]] indicam quais dessas configurações se aplicam a cada forma de acesso.<br>

=Cia Web (SaaS)=
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.
<br><br>
As configurações desta seção garantem o funcionamento da Cia Web, que é a aplicação onde todos os recursos da Cia são disponibilizados.
<br><br>
Como os Portais e a aplicação Desktop abrem a mesma Cia Web, essas configurações também se aplicam a eles, conforme indicado nas respectivas seções.<br>

==Versões de navegadores==
<p align="justify">
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.
<br><br>
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.
<br><br>
Para mais informações, acesse: [[Requisitos_de_Software#Versões_de_Navegadores|Versões de navegadores]]
</p>

==Importância do uso do HTTPS==
<p align="justify">
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:
<br><br>
1. Segurança: O HTTPS criptografa os dados transmitidos, garantindo maior proteção contra interceptações e ataques.<br>
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.<br>
<br>
Para mais informações sobre a importância do uso do HTTPS, acesse: [[GE - Importância do uso do HTTPS|Importância do uso do HTTPS]]
</p>

==Autenticação em duas etapas e configurações de envio de e-mail==
<p align="justify">
Para acessar a Cia Web, é obrigatório que o usuário tenha habilitado a autenticação em duas etapas para realizar o login, independentemente do ambiente. Se precisar de ajuda para configurar, consulte a documentação: [[GE Autenticação em duas etapas]]
<br><br>
Caso o envio de e-mails ainda não esteja configurado, será necessário configurá-lo, pois a autenticação em duas etapas depende dessa configuração. Se precisar de ajuda, consulte: [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]]
</p>

==Configurações para Cia no CIGAM==
Algumas configurações e parametrizações no CIGAM são necessárias 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.<br>

===Ambiente padrão com único site===
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:
<br>
* Para acessar os Portais MVC:
** Acesse a configuração [[GE - AM - 3159 - Local de Instalação dos Portais Base]] e informe o local onde seus Portais MVC estão instalados.
*** Exemplo: http://servidor:porta/
<br>
* Para acessar os Portais React:
** Acesse a configuração [[GE - AM - 3160 - Local de Instalação dos Portais Complementares]] e informe onde seus Portais React estão instalados.
*** Exemplo: http://servidor:porta/
<br>
* Para acessar os dashboards do BI:
** Acesse a configuração [[GE - GE - 100325 - URL Base BI Portal]] e informe o endereço onde seu BI está instalado.
*** Exemplo: http://servidor:porta/bi<br>
<br>
'''Observação:''' mesmo em ambientes com um único site, é possível configurar as aplicações apenas por meio de '''nomes lógicos''' no arquivo '''Magic.ini'''. Nesse caso, as configurações acima não são necessárias. 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]]<br>

===Ambiente com mais de um site===
Em alguns casos, as aplicações podem estar instaladas 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.
<br>
* 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]]
<br>
* Para acessar os Portais React:
** Acesse a configuração [[GE - AM - 3160 - Local de Instalação dos Portais Complementares]] e informe onde seus Portais React estão instalados.
*** Exemplo: http://servidor:porta/
<br>
* Para acessar os dashboards do BI:
** Acesse a configuração [[GE - GE - 100325 - URL Base BI Portal]] e informe o endereço onde seu BI está instalado.
*** Exemplo: http://servidor:porta/bi<br>

===Configuração do BI para integração com a Cia===
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:
<br>
[[Imagem:apiCigamBI.png|semmoldura|centro|600px]]

===Configurações para compartilhamento de análises por e-mail===

A partir da versão '''Beta 261005''', o recurso [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Recurso_"Analisar_com_a_Cia"|Analisar com a Cia]] no Desktop passa a disponibilizar opções para utilização e compartilhamento das análises geradas, incluindo o envio por e-mail.

Embora a geração das análises não exija parametrizações adicionais no CIGAM, o compartilhamento por e-mail depende de algumas configurações no ambiente.

Para utilizar essa funcionalidade, é necessário:

* Possuir a '''API CIGAM''' instalada no ambiente utilizado.
* Possuir o '''Broker''' do ambiente devidamente configurado e em execução.
* Informar os nomes lógicos '''CDN''' e '''CDN_KEYTOKEN''' no arquivo '''Magic.ini'''.
* Possuir as configurações de envio de e-mails pelo CIGAM devidamente parametrizadas.
<br>

====Configuração da API====

Para realizar o envio de análises por e-mail, é necessário que a '''API CIGAM''' esteja instalada e acessível no ambiente utilizado.

A configuração [[GE - AM - 3159 - Local de Instalação dos Portais Base|3159 - Local de Instalação dos Portais Base]] deve estar devidamente parametrizada, permitindo que o CIGAM localize a API responsável pelo processamento da solicitação.

Caso a API não esteja instalada ou não possa ser acessada, será apresentada uma mensagem de erro ao tentar realizar o envio.

<br>
[[Imagem:CiaDesktopErroAPI.png|semmoldura|center|700px]]
<br>

====Configuração do Broker====

Para realizar o compartilhamento das análises por e-mail, também é necessário que o '''Broker''' do ambiente esteja devidamente configurado e em execução.
Caso o Broker não esteja em execução ou apresente alguma configuração incorreta, será exibida uma mensagem de erro ao tentar enviar a análise por e-mail.
<br>
[[Imagem:CiaDesktopErroBroker.png|semmoldura|center|700px]]
<br>

====Configuração dos nomes lógicos====
Além da API e do Broker, é necessário configurar os nomes lógicos '''CDN''' e '''CDN_KEYTOKEN''' no arquivo '''Magic.ini''' do ambiente.
Esses nomes lógicos são utilizados para identificar o endereço e a chave de acesso à CDN, necessária para disponibilizar o arquivo da análise que será enviado como anexo.

* '''CDN:''' deve conter o endereço da CDN utilizada pelo ambiente.
* '''CDN_KEYTOKEN:''' deve conter a chave de acesso utilizada para a comunicação com a CDN.

Caso o nome lógico '''CDN''' não esteja configurado corretamente, será apresentada uma mensagem de erro relacionada ao endereço da CDN.
<br>
[[Imagem:CiaDesktopErroCaminhoCDN.png|semmoldura|center|700px]]
<br>

Da mesma forma, caso o nome lógico '''CDN_KEYTOKEN''' não esteja informado corretamente, será apresentada uma mensagem de erro relacionada à chave de acesso.
<br>
[[Imagem:CiaDesktopErroCDNKey.png|semmoldura|center|700px]]
<br>

====Configurações de envio de e-mail====

Também é necessário que o ambiente possua as configurações necessárias para realizar o envio de e-mails pelo CIGAM devidamente parametrizadas.
Caso essas configurações estejam ausentes ou incorretas, poderão ocorrer falhas durante o envio da análise.
Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
<br>

'''Importante:''' o botão '''E-mail''' permanece disponível mesmo quando alguma das configurações necessárias não está correta. Nesses casos, a mensagem de erro correspondente será apresentada durante a tentativa de envio, e não haverá o compartilhamento da análise.
{{VoltarInicio}}

==Configurações de CORS==
<p align="justify">
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.<br><br>
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.<br><br>
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.
</p>

==Ambientes com acesso externo às aplicações==
<p align="justify">
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.
</p>

===Como configurar o web server (Microsoft IIS)?===
<p align="justify">
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).
<br><br>
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:
</p>

====Configuração via arquivo web.config====
<p align="justify">
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.<br>
<br>
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.<br>
<br>
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.<br>
<br>
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.
<br><br>
'''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.'''
<br><br>
'''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.'''
<br><br>
'''Importante: Essas configurações devem ser feitas apenas para os ambientes que tiverem HTTPS configurados.'''
<br><br>
Exemplo com as pastas das aplicações do CIGAM Web em C:\inetpub\wwwroot\cigam no Web Server IIS:
</p>

[[Imagem:pastaWebConfig.png|semmoldura|centro|770px|Web Config]]
<br>

<p align="justify">Também é possível copiar e utilizar o código abaixo para facilitar a configuração:</p>

''<?xml version="1.0" encoding="UTF-8"?><br> <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><br> </configuration>''

====Como dar acesso através do IIS?====
<p align="justify">
Para configurar o CSP diretamente no IIS, siga os passos abaixo:<br><br>
1. Acesse o '''Gerenciador de Serviços de Informações da Internet (IIS)''' e localize o site que deseja liberar o acesso.<br><br>
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'''.
</p>

[[Imagem:CabecalhoResp.png|semmoldura|centro|800px]]
<br>
<p align="justify">
3. Adicione o cabeçalho '''Content-Security-Policy''' na seção '''Ações''', localizada à direita, clique em '''Adicionar'''.
</p>

[[Imagem:CabecalhoResp2.png|semmoldura|centro|800px]]
<br>
<p align="justify">
4. Na caixa de diálogo que será exibida, preencha os seguintes campos:
* Nome: Content-Security-Policy.
* Valor: frame-ancestors 'self' https://services.cigam.cloud http://services.cigam.cloud;
</p>
<br>
'''Lembre-se de 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?====
<p align="justify">
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'''.
</p>

[[Imagem:Gerenciamento.png|semmoldura|centro|800px]]
<br>
<br>
<p align="justify">
* 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
</p>

[[Imagem:httpCookies.png|semmoldura|centro|800px]]
<br>

<p align="justify">
* Configuração de '''sessionState''':
** Ainda em '''system.web''', localize a configuração '''sessionState'''.<br>
** Altere o valor da propriedade '''cookieSameSite''' para '''None'''.
</p>

[[Imagem:sessionStage.png|semmoldura|centro|850px]]
<br><br>
<p align="justify">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.</p>
{{VoltarInicio}}

==Ambientes internos sem acesso externo às aplicações==
<p align="justify">
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).
<br><br>
'''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.
<br><br>
Para mais informações sobre a importância do uso do HTTPS, acesse: [[GE - Importância do uso do HTTPS|Importância do uso do HTTPS]]
</p>

==Garantindo permissão de acesso aos cookies de terceiros no navegador==
<p align="justify">
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''':<br>
<br>
* 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".
</p>

[[Imagem:settingsEdge.png|semmoldura|centro|800px]]
<br>
<br>
<p align="justify">
* 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".
</p>

[[Imagem:settingsChrome.png|semmoldura|centro|800px]]

==Dispositivos móveis==
<p align="justify">
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.
</p>

[[Imagem:CiaInstalarAppMobile.png|semmoldura|centro|700px]]

<p align="justify">
É 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.
</p>
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, os recursos da Cia possuem exigências diferentes de configuração. Os itens abaixo indicam o que é necessário em cada caso.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia a partir do menu de mosaico (Cia - IA do CIGAM) abre a Cia Web (SaaS). Por esse motivo, depende das configurações descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]], em especial:<br>
* [[#Configurações para Cia no CIGAM|Configurações para Cia no CIGAM]], conforme o ambiente possua um único site ou mais de um.
* [[#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]].
* As configurações de ambiente, como CSP, cookies e permissões do navegador.
<br>
[[Imagem:mosaicoCia.png|semmoldura|centro|650px]]
<br>
Para mais informações sobre como configurar nomes lógicos e o menu mosaico, consulte: [[GE - Como Fazer - Configuração do menu mosaico nos Portais Web]]<br>

==Agentes e opções generativas==
Não é necessária nenhuma parametrização para utilizar os '''agentes''' e as '''opções generativas''' disponíveis no menu da Cia nos Portais, como melhoria de texto e revisão gramatical. Esses recursos são disponibilizados automaticamente, de acordo com o contexto da tela, e não dependem das configurações de local de instalação nem da autenticação em duas etapas.<br>
<br>
Os agentes estão disponíveis a partir da versão '''Beta 260601''', e o '''Editor de Agentes''' a partir da versão '''Beta 261005''', tanto para os Portais MVC quanto para os Portais React.<br>
<br>
[[Imagem:MenuCiaPortais.png|semmoldura|centro|600px]]
<br>
Para saber como utilizar esses recursos, consulte: [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer uso da Cia IA do CIGAM]]
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, os recursos da Cia possuem exigências distintas de configuração:<br>
<br>
{| class="wikitable"
|-
| '''Recurso''' || '''Configuração necessária'''
|-
| '''Acesso rápido à Cia - IA do CIGAM''' || Exige API e Portais instalados, além das configurações da Cia Web (SaaS).
|-
| '''Analisar com a Cia''' || Não exige parametrização no CIGAM. Requer a versão 250505 patch A ou superior e o navegador padrão e a extensão .html configurados no Windows.
|-
| '''Compartilhamento de análises por e-mail''' || Exige API instalada, configuração 3159, nomes lógicos CDN e CDN_KEYTOKEN e configurações de envio de e-mail.
|}

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM) disponível no menu lateral do Desktop abre a Cia Web (SaaS) em uma janela integrada ao sistema. Por esse motivo, depende de:<br>
* A API e os Portais instalados, pois são eles que conectam o sistema aos dados do ERP. '''Sem a API, a funcionalidade não funcionará'''.
* As configurações descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]], em especial [[#Configurações para Cia no CIGAM|Configurações para Cia no CIGAM]] e [[#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]].
<br>
[[Imagem:CiaIA.png|semmoldura|centro|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''', disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída, não exige nenhuma parametrização adicional no CIGAM para a geração das análises. Ele também não depende da autenticação em duas etapas nem das configurações de local de instalação dos Portais.

Entretanto, a funcionalidade de '''compartilhamento por e-mail''', disponível a partir da versão '''Beta 261005''', exige configurações adicionais no ambiente, conforme descrito na seção abaixo.<br>
<br>
Exemplo do recurso disponível na Pesquisa Dinâmica:<br>
<br>
[[Imagem:PesquisaDinamicaComCia.png|semmoldura|centro|800px]]
<br>
Os requisitos para utilização são:<br>
* Estar na versão '''250505.a''' ou superior.
* Ter um '''navegador padrão configurado no Windows''', preferencialmente o '''Google Chrome''' ou o '''Microsoft Edge''', por serem os navegadores homologados pela CIGAM.
* Ter a '''extensão .html''' associada a um desses navegadores, para que o conteúdo enviado à Cia seja aberto corretamente.
<br>
[[Imagem:NavegadorPadraoWindows.png|semmoldura|centro|800px]]
<br>
Para mais informações sobre os navegadores homologados, acesse: [[Requisitos_de_Software#Versões_de_Navegadores|Versões de navegadores]]<br>
<br>
Para saber como utilizar o recurso, consulte: [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer uso da Cia IA do CIGAM]]

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Uso da Cia - IA do CIGAM]]<br>
[[GE - Importância do uso do HTTPS]]<br>
[[GE Autenticação em duas etapas]]<br>
[[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]]<br>
[[GE - Como Fazer - Configuração do menu mosaico nos Portais Web]]
{{VoltarInicio}}

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

2026-10-15T19:54:31Z

Vinicius.moder: /* Recurso "Analisar com a Cia" */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como Fazer Utilidades/Diversos_2]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como_Fazer - Configuração da Cia IA do CIGAM|Configuração da Cia IA do CIGAM]]

=Como a Cia - IA do CIGAM funciona?=
<p align="justify">
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.
<br>
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:
<br>
* Atualizações em tempo real, sem necessidade de intervenção do cliente.<br/>
* Treinamento de forma compartilhada, adicionando novas funcionalidades, otimizando performance e resultados.<br/>
</p>
Todas as configurações necessárias estão descritas em [[#Cia Web (SaaS)|Cia Web (SaaS)]]. As seções [[#Portais|Portais]] e [[#Desktop|Desktop]] indicam quais dessas configurações se aplicam a cada forma de acesso.<br>

=Cia Web (SaaS)=
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.
<br><br>
As configurações desta seção garantem o funcionamento da Cia Web, que é a aplicação onde todos os recursos da Cia são disponibilizados.
<br><br>
Como os Portais e a aplicação Desktop abrem a mesma Cia Web, essas configurações também se aplicam a eles, conforme indicado nas respectivas seções.<br>

==Versões de navegadores==
<p align="justify">
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.
<br><br>
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.
<br><br>
Para mais informações, acesse: [[Requisitos_de_Software#Versões_de_Navegadores|Versões de navegadores]]
</p>

==Importância do uso do HTTPS==
<p align="justify">
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:
<br><br>
1. Segurança: O HTTPS criptografa os dados transmitidos, garantindo maior proteção contra interceptações e ataques.<br>
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.<br>
<br>
Para mais informações sobre a importância do uso do HTTPS, acesse: [[GE - Importância do uso do HTTPS|Importância do uso do HTTPS]]
</p>

==Autenticação em duas etapas e configurações de envio de e-mail==
<p align="justify">
Para acessar a Cia Web, é obrigatório que o usuário tenha habilitado a autenticação em duas etapas para realizar o login, independentemente do ambiente. Se precisar de ajuda para configurar, consulte a documentação: [[GE Autenticação em duas etapas]]
<br><br>
Caso o envio de e-mails ainda não esteja configurado, será necessário configurá-lo, pois a autenticação em duas etapas depende dessa configuração. Se precisar de ajuda, consulte: [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]]
</p>

==Configurações para Cia no CIGAM==
Algumas configurações e parametrizações no CIGAM são necessárias 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.<br>

===Ambiente padrão com único site===
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:
<br>
* Para acessar os Portais MVC:
** Acesse a configuração [[GE - AM - 3159 - Local de Instalação dos Portais Base]] e informe o local onde seus Portais MVC estão instalados.
*** Exemplo: http://servidor:porta/
<br>
* Para acessar os Portais React:
** Acesse a configuração [[GE - AM - 3160 - Local de Instalação dos Portais Complementares]] e informe onde seus Portais React estão instalados.
*** Exemplo: http://servidor:porta/
<br>
* Para acessar os dashboards do BI:
** Acesse a configuração [[GE - GE - 100325 - URL Base BI Portal]] e informe o endereço onde seu BI está instalado.
*** Exemplo: http://servidor:porta/bi<br>
<br>
'''Observação:''' mesmo em ambientes com um único site, é possível configurar as aplicações apenas por meio de '''nomes lógicos''' no arquivo '''Magic.ini'''. Nesse caso, as configurações acima não são necessárias. 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]]<br>

===Ambiente com mais de um site===
Em alguns casos, as aplicações podem estar instaladas 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.
<br>
* 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]]
<br>
* Para acessar os Portais React:
** Acesse a configuração [[GE - AM - 3160 - Local de Instalação dos Portais Complementares]] e informe onde seus Portais React estão instalados.
*** Exemplo: http://servidor:porta/
<br>
* Para acessar os dashboards do BI:
** Acesse a configuração [[GE - GE - 100325 - URL Base BI Portal]] e informe o endereço onde seu BI está instalado.
*** Exemplo: http://servidor:porta/bi<br>

===Configuração do BI para integração com a Cia===
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:
<br>
[[Imagem:apiCigamBI.png|semmoldura|centro|600px]]

===Configurações para compartilhamento de análises por e-mail===

A partir da versão '''Beta 261005''', o recurso [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Recurso_"Analisar_com_a_Cia"|Analisar com a Cia]] no Desktop passa a disponibilizar opções para utilização e compartilhamento das análises geradas, incluindo o envio por e-mail.

Embora a geração das análises não exija parametrizações adicionais no CIGAM, o compartilhamento por e-mail depende de algumas configurações no ambiente.

Para utilizar essa funcionalidade, é necessário:

* Possuir a '''API CIGAM''' instalada no ambiente utilizado.
* Possuir o '''Broker''' do ambiente devidamente configurado e em execução.
* Informar os nomes lógicos '''CDN''' e '''CDN_KEYTOKEN''' no arquivo '''Magic.ini'''.
* Possuir as configurações de envio de e-mails pelo CIGAM devidamente parametrizadas.
<br>

====Configuração da API====

Para realizar o envio de análises por e-mail, é necessário que a '''API CIGAM''' esteja instalada e acessível no ambiente utilizado.

A configuração [[GE - AM - 3159 - Local de Instalação dos Portais Base|3159 - Local de Instalação dos Portais Base]] deve estar devidamente parametrizada, permitindo que o CIGAM localize a API responsável pelo processamento da solicitação.

Caso a API não esteja instalada ou não possa ser acessada, será apresentada uma mensagem de erro ao tentar realizar o envio.

<br>
[[Imagem:CiaDesktopErroAPI.png|semmoldura|center|700px]]
<br>

====Configuração do Broker====

Para realizar o compartilhamento das análises por e-mail, também é necessário que o '''Broker''' do ambiente esteja devidamente configurado e em execução.
Caso o Broker não esteja em execução ou apresente alguma configuração incorreta, será exibida uma mensagem de erro ao tentar enviar a análise por e-mail.
<br>
[[Imagem:CiaDesktopErroBroker.png|semmoldura|center|700px]]
<br>

====Configuração dos nomes lógicos====
Além da API e do Broker, é necessário configurar os nomes lógicos '''CDN''' e '''CDN_KEYTOKEN''' no arquivo '''Magic.ini''' do ambiente.
Esses nomes lógicos são utilizados para identificar o endereço e a chave de acesso à CDN, necessária para disponibilizar o arquivo da análise que será enviado como anexo.

* '''CDN:''' deve conter o endereço da CDN utilizada pelo ambiente.
* '''CDN_KEYTOKEN:''' deve conter a chave de acesso utilizada para a comunicação com a CDN.

Caso o nome lógico '''CDN''' não esteja configurado corretamente, será apresentada uma mensagem de erro relacionada ao endereço da CDN.
<br>
[[Imagem:CiaDesktopErroCaminhoCDN.png|semmoldura|center|700px]]
<br>

Da mesma forma, caso o nome lógico '''CDN_KEYTOKEN''' não esteja informado corretamente, será apresentada uma mensagem de erro relacionada à chave de acesso.
<br>
[[Imagem:CiaDesktopErroCDNKey.png|semmoldura|center|700px]]
<br>

====Configurações de envio de e-mail====

Também é necessário que o ambiente possua as configurações necessárias para realizar o envio de e-mails pelo CIGAM devidamente parametrizadas.
Caso essas configurações estejam ausentes ou incorretas, poderão ocorrer falhas durante o envio da análise.
Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
<br>

'''Importante:''' o botão '''E-mail''' permanece disponível mesmo quando alguma das configurações necessárias não está correta. Nesses casos, a mensagem de erro correspondente será apresentada durante a tentativa de envio, e não haverá o compartilhamento da análise.
{{VoltarInicio}}

==Configurações de CORS==
<p align="justify">
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.<br><br>
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.<br><br>
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.
</p>

==Ambientes com acesso externo às aplicações==
<p align="justify">
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.
</p>

===Como configurar o web server (Microsoft IIS)?===
<p align="justify">
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).
<br><br>
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:
</p>

====Configuração via arquivo web.config====
<p align="justify">
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.<br>
<br>
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.<br>
<br>
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.<br>
<br>
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.
<br><br>
'''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.'''
<br><br>
'''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.'''
<br><br>
'''Importante: Essas configurações devem ser feitas apenas para os ambientes que tiverem HTTPS configurados.'''
<br><br>
Exemplo com as pastas das aplicações do CIGAM Web em C:\inetpub\wwwroot\cigam no Web Server IIS:
</p>

[[Imagem:pastaWebConfig.png|semmoldura|centro|770px|Web Config]]
<br>

<p align="justify">Também é possível copiar e utilizar o código abaixo para facilitar a configuração:</p>

''<?xml version="1.0" encoding="UTF-8"?><br> <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><br> </configuration>''

====Como dar acesso através do IIS?====
<p align="justify">
Para configurar o CSP diretamente no IIS, siga os passos abaixo:<br><br>
1. Acesse o '''Gerenciador de Serviços de Informações da Internet (IIS)''' e localize o site que deseja liberar o acesso.<br><br>
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'''.
</p>

[[Imagem:CabecalhoResp.png|semmoldura|centro|800px]]
<br>
<p align="justify">
3. Adicione o cabeçalho '''Content-Security-Policy''' na seção '''Ações''', localizada à direita, clique em '''Adicionar'''.
</p>

[[Imagem:CabecalhoResp2.png|semmoldura|centro|800px]]
<br>
<p align="justify">
4. Na caixa de diálogo que será exibida, preencha os seguintes campos:
* Nome: Content-Security-Policy.
* Valor: frame-ancestors 'self' https://services.cigam.cloud http://services.cigam.cloud;
</p>
<br>
'''Lembre-se de 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?====
<p align="justify">
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'''.
</p>

[[Imagem:Gerenciamento.png|semmoldura|centro|800px]]
<br>
<br>
<p align="justify">
* 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
</p>

[[Imagem:httpCookies.png|semmoldura|centro|800px]]
<br>

<p align="justify">
* Configuração de '''sessionState''':
** Ainda em '''system.web''', localize a configuração '''sessionState'''.<br>
** Altere o valor da propriedade '''cookieSameSite''' para '''None'''.
</p>

[[Imagem:sessionStage.png|semmoldura|centro|850px]]
<br><br>
<p align="justify">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.</p>
{{VoltarInicio}}

==Ambientes internos sem acesso externo às aplicações==
<p align="justify">
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).
<br><br>
'''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.
<br><br>
Para mais informações sobre a importância do uso do HTTPS, acesse: [[GE - Importância do uso do HTTPS|Importância do uso do HTTPS]]
</p>

==Garantindo permissão de acesso aos cookies de terceiros no navegador==
<p align="justify">
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''':<br>
<br>
* 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".
</p>

[[Imagem:settingsEdge.png|semmoldura|centro|800px]]
<br>
<br>
<p align="justify">
* 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".
</p>

[[Imagem:settingsChrome.png|semmoldura|centro|800px]]

==Dispositivos móveis==
<p align="justify">
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.
</p>

[[Imagem:CiaInstalarAppMobile.png|semmoldura|centro|700px]]

<p align="justify">
É 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.
</p>
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, os recursos da Cia possuem exigências diferentes de configuração. Os itens abaixo indicam o que é necessário em cada caso.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia a partir do menu de mosaico (Cia - IA do CIGAM) abre a Cia Web (SaaS). Por esse motivo, depende das configurações descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]], em especial:<br>
* [[#Configurações para Cia no CIGAM|Configurações para Cia no CIGAM]], conforme o ambiente possua um único site ou mais de um.
* [[#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]].
* As configurações de ambiente, como CSP, cookies e permissões do navegador.
<br>
[[Imagem:mosaicoCia.png|semmoldura|centro|650px]]
<br>
Para mais informações sobre como configurar nomes lógicos e o menu mosaico, consulte: [[GE - Como Fazer - Configuração do menu mosaico nos Portais Web]]<br>

==Agentes e opções generativas==
Não é necessária nenhuma parametrização para utilizar os '''agentes''' e as '''opções generativas''' disponíveis no menu da Cia nos Portais, como melhoria de texto e revisão gramatical. Esses recursos são disponibilizados automaticamente, de acordo com o contexto da tela, e não dependem das configurações de local de instalação nem da autenticação em duas etapas.<br>
<br>
Os agentes estão disponíveis a partir da versão '''Beta 260601''', e o '''Editor de Agentes''' a partir da versão '''Beta 261005''', tanto para os Portais MVC quanto para os Portais React.<br>
<br>
[[Imagem:MenuCiaPortais.png|semmoldura|centro|600px]]
<br>
Para saber como utilizar esses recursos, consulte: [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer uso da Cia IA do CIGAM]]
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, os recursos da Cia possuem exigências distintas de configuração:<br>
<br>
{| class="wikitable"
|-
| '''Recurso''' || '''Configuração necessária'''
|-
| '''Acesso rápido à Cia - IA do CIGAM''' || Exige API e Portais instalados, além das configurações da Cia Web (SaaS).
|-
| '''Analisar com a Cia''' || Não exige parametrização no CIGAM. Requer a versão 250505 patch A ou superior e o navegador padrão e a extensão .html configurados no Windows.
|}

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM) disponível no menu lateral do Desktop abre a Cia Web (SaaS) em uma janela integrada ao sistema. Por esse motivo, depende de:<br>
* A API e os Portais instalados, pois são eles que conectam o sistema aos dados do ERP. '''Sem a API, a funcionalidade não funcionará'''.
* As configurações descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]], em especial [[#Configurações para Cia no CIGAM|Configurações para Cia no CIGAM]] e [[#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]].
<br>
[[Imagem:CiaIA.png|semmoldura|centro|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''', disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída, não exige nenhuma parametrização adicional no CIGAM para a geração das análises. Ele também não depende da autenticação em duas etapas nem das configurações de local de instalação dos Portais.

Entretanto, a funcionalidade de '''compartilhamento por e-mail''', disponível a partir da versão '''Beta 261005''', exige configurações adicionais no ambiente, conforme descrito na seção abaixo.<br>
<br>
Exemplo do recurso disponível na Pesquisa Dinâmica:<br>
<br>
[[Imagem:PesquisaDinamicaComCia.png|semmoldura|centro|800px]]
<br>
Os requisitos para utilização são:<br>
* Estar na versão '''250505.a''' ou superior.
* Ter um '''navegador padrão configurado no Windows''', preferencialmente o '''Google Chrome''' ou o '''Microsoft Edge''', por serem os navegadores homologados pela CIGAM.
* Ter a '''extensão .html''' associada a um desses navegadores, para que o conteúdo enviado à Cia seja aberto corretamente.
<br>
[[Imagem:NavegadorPadraoWindows.png|semmoldura|centro|800px]]
<br>
Para mais informações sobre os navegadores homologados, acesse: [[Requisitos_de_Software#Versões_de_Navegadores|Versões de navegadores]]<br>
<br>
Para saber como utilizar o recurso, consulte: [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer uso da Cia IA do CIGAM]]

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Uso da Cia - IA do CIGAM]]<br>
[[GE - Importância do uso do HTTPS]]<br>
[[GE Autenticação em duas etapas]]<br>
[[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]]<br>
[[GE - Como Fazer - Configuração do menu mosaico nos Portais Web]]
{{VoltarInicio}}

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

2026-10-15T19:50:47Z

Vinicius.moder: /* Configurações para compartilhamento de análises por e-mail */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como Fazer Utilidades/Diversos_2]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como_Fazer - Configuração da Cia IA do CIGAM|Configuração da Cia IA do CIGAM]]

=Como a Cia - IA do CIGAM funciona?=
<p align="justify">
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.
<br>
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:
<br>
* Atualizações em tempo real, sem necessidade de intervenção do cliente.<br/>
* Treinamento de forma compartilhada, adicionando novas funcionalidades, otimizando performance e resultados.<br/>
</p>
Todas as configurações necessárias estão descritas em [[#Cia Web (SaaS)|Cia Web (SaaS)]]. As seções [[#Portais|Portais]] e [[#Desktop|Desktop]] indicam quais dessas configurações se aplicam a cada forma de acesso.<br>

=Cia Web (SaaS)=
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.
<br><br>
As configurações desta seção garantem o funcionamento da Cia Web, que é a aplicação onde todos os recursos da Cia são disponibilizados.
<br><br>
Como os Portais e a aplicação Desktop abrem a mesma Cia Web, essas configurações também se aplicam a eles, conforme indicado nas respectivas seções.<br>

==Versões de navegadores==
<p align="justify">
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.
<br><br>
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.
<br><br>
Para mais informações, acesse: [[Requisitos_de_Software#Versões_de_Navegadores|Versões de navegadores]]
</p>

==Importância do uso do HTTPS==
<p align="justify">
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:
<br><br>
1. Segurança: O HTTPS criptografa os dados transmitidos, garantindo maior proteção contra interceptações e ataques.<br>
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.<br>
<br>
Para mais informações sobre a importância do uso do HTTPS, acesse: [[GE - Importância do uso do HTTPS|Importância do uso do HTTPS]]
</p>

==Autenticação em duas etapas e configurações de envio de e-mail==
<p align="justify">
Para acessar a Cia Web, é obrigatório que o usuário tenha habilitado a autenticação em duas etapas para realizar o login, independentemente do ambiente. Se precisar de ajuda para configurar, consulte a documentação: [[GE Autenticação em duas etapas]]
<br><br>
Caso o envio de e-mails ainda não esteja configurado, será necessário configurá-lo, pois a autenticação em duas etapas depende dessa configuração. Se precisar de ajuda, consulte: [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]]
</p>

==Configurações para Cia no CIGAM==
Algumas configurações e parametrizações no CIGAM são necessárias 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.<br>

===Ambiente padrão com único site===
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:
<br>
* Para acessar os Portais MVC:
** Acesse a configuração [[GE - AM - 3159 - Local de Instalação dos Portais Base]] e informe o local onde seus Portais MVC estão instalados.
*** Exemplo: http://servidor:porta/
<br>
* Para acessar os Portais React:
** Acesse a configuração [[GE - AM - 3160 - Local de Instalação dos Portais Complementares]] e informe onde seus Portais React estão instalados.
*** Exemplo: http://servidor:porta/
<br>
* Para acessar os dashboards do BI:
** Acesse a configuração [[GE - GE - 100325 - URL Base BI Portal]] e informe o endereço onde seu BI está instalado.
*** Exemplo: http://servidor:porta/bi<br>
<br>
'''Observação:''' mesmo em ambientes com um único site, é possível configurar as aplicações apenas por meio de '''nomes lógicos''' no arquivo '''Magic.ini'''. Nesse caso, as configurações acima não são necessárias. 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]]<br>

===Ambiente com mais de um site===
Em alguns casos, as aplicações podem estar instaladas 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.
<br>
* 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]]
<br>
* Para acessar os Portais React:
** Acesse a configuração [[GE - AM - 3160 - Local de Instalação dos Portais Complementares]] e informe onde seus Portais React estão instalados.
*** Exemplo: http://servidor:porta/
<br>
* Para acessar os dashboards do BI:
** Acesse a configuração [[GE - GE - 100325 - URL Base BI Portal]] e informe o endereço onde seu BI está instalado.
*** Exemplo: http://servidor:porta/bi<br>

===Configuração do BI para integração com a Cia===
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:
<br>
[[Imagem:apiCigamBI.png|semmoldura|centro|600px]]

===Configurações para compartilhamento de análises por e-mail===

A partir da versão '''Beta 261005''', o recurso [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Recurso_"Analisar_com_a_Cia"|Analisar com a Cia]] no Desktop passa a disponibilizar opções para utilização e compartilhamento das análises geradas, incluindo o envio por e-mail.

Embora a geração das análises não exija parametrizações adicionais no CIGAM, o compartilhamento por e-mail depende de algumas configurações no ambiente.

Para utilizar essa funcionalidade, é necessário:

* Possuir a '''API CIGAM''' instalada no ambiente utilizado.
* Possuir o '''Broker''' do ambiente devidamente configurado e em execução.
* Informar os nomes lógicos '''CDN''' e '''CDN_KEYTOKEN''' no arquivo '''Magic.ini'''.
* Possuir as configurações de envio de e-mails pelo CIGAM devidamente parametrizadas.
<br>

====Configuração da API====

Para realizar o envio de análises por e-mail, é necessário que a '''API CIGAM''' esteja instalada e acessível no ambiente utilizado.

A configuração [[GE - AM - 3159 - Local de Instalação dos Portais Base|3159 - Local de Instalação dos Portais Base]] deve estar devidamente parametrizada, permitindo que o CIGAM localize a API responsável pelo processamento da solicitação.

Caso a API não esteja instalada ou não possa ser acessada, será apresentada uma mensagem de erro ao tentar realizar o envio.

<br>
[[Imagem:CiaDesktopErroAPI.png|semmoldura|center|700px]]
<br>

====Configuração do Broker====

Para realizar o compartilhamento das análises por e-mail, também é necessário que o '''Broker''' do ambiente esteja devidamente configurado e em execução.
Caso o Broker não esteja em execução ou apresente alguma configuração incorreta, será exibida uma mensagem de erro ao tentar enviar a análise por e-mail.
<br>
[[Imagem:CiaDesktopErroBroker.png|semmoldura|center|700px]]
<br>

====Configuração dos nomes lógicos====
Além da API e do Broker, é necessário configurar os nomes lógicos '''CDN''' e '''CDN_KEYTOKEN''' no arquivo '''Magic.ini''' do ambiente.
Esses nomes lógicos são utilizados para identificar o endereço e a chave de acesso à CDN, necessária para disponibilizar o arquivo da análise que será enviado como anexo.

* '''CDN:''' deve conter o endereço da CDN utilizada pelo ambiente.
* '''CDN_KEYTOKEN:''' deve conter a chave de acesso utilizada para a comunicação com a CDN.

Caso o nome lógico '''CDN''' não esteja configurado corretamente, será apresentada uma mensagem de erro relacionada ao endereço da CDN.
<br>
[[Imagem:CiaDesktopErroCaminhoCDN.png|semmoldura|center|700px]]
<br>

Da mesma forma, caso o nome lógico '''CDN_KEYTOKEN''' não esteja informado corretamente, será apresentada uma mensagem de erro relacionada à chave de acesso.
<br>
[[Imagem:CiaDesktopErroCDNKey.png|semmoldura|center|700px]]
<br>

====Configurações de envio de e-mail====

Também é necessário que o ambiente possua as configurações necessárias para realizar o envio de e-mails pelo CIGAM devidamente parametrizadas.
Caso essas configurações estejam ausentes ou incorretas, poderão ocorrer falhas durante o envio da análise.
Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
<br>

'''Importante:''' o botão '''E-mail''' permanece disponível mesmo quando alguma das configurações necessárias não está correta. Nesses casos, a mensagem de erro correspondente será apresentada durante a tentativa de envio, e não haverá o compartilhamento da análise.
{{VoltarInicio}}

==Configurações de CORS==
<p align="justify">
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.<br><br>
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.<br><br>
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.
</p>

==Ambientes com acesso externo às aplicações==
<p align="justify">
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.
</p>

===Como configurar o web server (Microsoft IIS)?===
<p align="justify">
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).
<br><br>
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:
</p>

====Configuração via arquivo web.config====
<p align="justify">
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.<br>
<br>
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.<br>
<br>
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.<br>
<br>
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.
<br><br>
'''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.'''
<br><br>
'''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.'''
<br><br>
'''Importante: Essas configurações devem ser feitas apenas para os ambientes que tiverem HTTPS configurados.'''
<br><br>
Exemplo com as pastas das aplicações do CIGAM Web em C:\inetpub\wwwroot\cigam no Web Server IIS:
</p>

[[Imagem:pastaWebConfig.png|semmoldura|centro|770px|Web Config]]
<br>

<p align="justify">Também é possível copiar e utilizar o código abaixo para facilitar a configuração:</p>

''<?xml version="1.0" encoding="UTF-8"?><br> <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><br> </configuration>''

====Como dar acesso através do IIS?====
<p align="justify">
Para configurar o CSP diretamente no IIS, siga os passos abaixo:<br><br>
1. Acesse o '''Gerenciador de Serviços de Informações da Internet (IIS)''' e localize o site que deseja liberar o acesso.<br><br>
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'''.
</p>

[[Imagem:CabecalhoResp.png|semmoldura|centro|800px]]
<br>
<p align="justify">
3. Adicione o cabeçalho '''Content-Security-Policy''' na seção '''Ações''', localizada à direita, clique em '''Adicionar'''.
</p>

[[Imagem:CabecalhoResp2.png|semmoldura|centro|800px]]
<br>
<p align="justify">
4. Na caixa de diálogo que será exibida, preencha os seguintes campos:
* Nome: Content-Security-Policy.
* Valor: frame-ancestors 'self' https://services.cigam.cloud http://services.cigam.cloud;
</p>
<br>
'''Lembre-se de 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?====
<p align="justify">
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'''.
</p>

[[Imagem:Gerenciamento.png|semmoldura|centro|800px]]
<br>
<br>
<p align="justify">
* 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
</p>

[[Imagem:httpCookies.png|semmoldura|centro|800px]]
<br>

<p align="justify">
* Configuração de '''sessionState''':
** Ainda em '''system.web''', localize a configuração '''sessionState'''.<br>
** Altere o valor da propriedade '''cookieSameSite''' para '''None'''.
</p>

[[Imagem:sessionStage.png|semmoldura|centro|850px]]
<br><br>
<p align="justify">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.</p>
{{VoltarInicio}}

==Ambientes internos sem acesso externo às aplicações==
<p align="justify">
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).
<br><br>
'''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.
<br><br>
Para mais informações sobre a importância do uso do HTTPS, acesse: [[GE - Importância do uso do HTTPS|Importância do uso do HTTPS]]
</p>

==Garantindo permissão de acesso aos cookies de terceiros no navegador==
<p align="justify">
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''':<br>
<br>
* 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".
</p>

[[Imagem:settingsEdge.png|semmoldura|centro|800px]]
<br>
<br>
<p align="justify">
* 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".
</p>

[[Imagem:settingsChrome.png|semmoldura|centro|800px]]

==Dispositivos móveis==
<p align="justify">
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.
</p>

[[Imagem:CiaInstalarAppMobile.png|semmoldura|centro|700px]]

<p align="justify">
É 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.
</p>
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, os recursos da Cia possuem exigências diferentes de configuração. Os itens abaixo indicam o que é necessário em cada caso.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia a partir do menu de mosaico (Cia - IA do CIGAM) abre a Cia Web (SaaS). Por esse motivo, depende das configurações descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]], em especial:<br>
* [[#Configurações para Cia no CIGAM|Configurações para Cia no CIGAM]], conforme o ambiente possua um único site ou mais de um.
* [[#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]].
* As configurações de ambiente, como CSP, cookies e permissões do navegador.
<br>
[[Imagem:mosaicoCia.png|semmoldura|centro|650px]]
<br>
Para mais informações sobre como configurar nomes lógicos e o menu mosaico, consulte: [[GE - Como Fazer - Configuração do menu mosaico nos Portais Web]]<br>

==Agentes e opções generativas==
Não é necessária nenhuma parametrização para utilizar os '''agentes''' e as '''opções generativas''' disponíveis no menu da Cia nos Portais, como melhoria de texto e revisão gramatical. Esses recursos são disponibilizados automaticamente, de acordo com o contexto da tela, e não dependem das configurações de local de instalação nem da autenticação em duas etapas.<br>
<br>
Os agentes estão disponíveis a partir da versão '''Beta 260601''', e o '''Editor de Agentes''' a partir da versão '''Beta 261005''', tanto para os Portais MVC quanto para os Portais React.<br>
<br>
[[Imagem:MenuCiaPortais.png|semmoldura|centro|600px]]
<br>
Para saber como utilizar esses recursos, consulte: [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer uso da Cia IA do CIGAM]]
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, os recursos da Cia possuem exigências distintas de configuração:<br>
<br>
{| class="wikitable"
|-
| '''Recurso''' || '''Configuração necessária'''
|-
| '''Acesso rápido à Cia - IA do CIGAM''' || Exige API e Portais instalados, além das configurações da Cia Web (SaaS).
|-
| '''Analisar com a Cia''' || Não exige parametrização no CIGAM. Requer a versão 250505 patch A ou superior e o navegador padrão e a extensão .html configurados no Windows.
|}

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM) disponível no menu lateral do Desktop abre a Cia Web (SaaS) em uma janela integrada ao sistema. Por esse motivo, depende de:<br>
* A API e os Portais instalados, pois são eles que conectam o sistema aos dados do ERP. '''Sem a API, a funcionalidade não funcionará'''.
* As configurações descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]], em especial [[#Configurações para Cia no CIGAM|Configurações para Cia no CIGAM]] e [[#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]].
<br>
[[Imagem:CiaIA.png|semmoldura|centro|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''', disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída, não exige nenhuma parametrização no CIGAM. Ele também não depende da autenticação em duas etapas nem das configurações de local de instalação dos Portais.<br>
<br>
Exemplo do recurso disponível na Pesquisa Dinâmica:<br>
<br>
[[Imagem:PesquisaDinamicaComCia.png|semmoldura|centro|800px]]
<br>
Os requisitos para utilização são:<br>
* Estar na versão '''250505.a''' ou superior.
* Ter um '''navegador padrão configurado no Windows''', preferencialmente o '''Google Chrome''' ou o '''Microsoft Edge''', por serem os navegadores homologados pela CIGAM.
* Ter a '''extensão .html''' associada a um desses navegadores, para que o conteúdo enviado à Cia seja aberto corretamente.
<br>
[[Imagem:NavegadorPadraoWindows.png|semmoldura|centro|800px]]
<br>
Para mais informações sobre os navegadores homologados, acesse: [[Requisitos_de_Software#Versões_de_Navegadores|Versões de navegadores]]<br>
<br>
Para saber como utilizar o recurso, consulte: [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer uso da Cia IA do CIGAM]]

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Uso da Cia - IA do CIGAM]]<br>
[[GE - Importância do uso do HTTPS]]<br>
[[GE Autenticação em duas etapas]]<br>
[[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]]<br>
[[GE - Como Fazer - Configuração do menu mosaico nos Portais Web]]
{{VoltarInicio}}

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

2026-10-15T19:50:19Z

Vinicius.moder: /* Configurações para compartilhamento de análises por e-mail */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como Fazer Utilidades/Diversos_2]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como_Fazer - Configuração da Cia IA do CIGAM|Configuração da Cia IA do CIGAM]]

=Como a Cia - IA do CIGAM funciona?=
<p align="justify">
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.
<br>
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:
<br>
* Atualizações em tempo real, sem necessidade de intervenção do cliente.<br/>
* Treinamento de forma compartilhada, adicionando novas funcionalidades, otimizando performance e resultados.<br/>
</p>
Todas as configurações necessárias estão descritas em [[#Cia Web (SaaS)|Cia Web (SaaS)]]. As seções [[#Portais|Portais]] e [[#Desktop|Desktop]] indicam quais dessas configurações se aplicam a cada forma de acesso.<br>

=Cia Web (SaaS)=
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.
<br><br>
As configurações desta seção garantem o funcionamento da Cia Web, que é a aplicação onde todos os recursos da Cia são disponibilizados.
<br><br>
Como os Portais e a aplicação Desktop abrem a mesma Cia Web, essas configurações também se aplicam a eles, conforme indicado nas respectivas seções.<br>

==Versões de navegadores==
<p align="justify">
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.
<br><br>
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.
<br><br>
Para mais informações, acesse: [[Requisitos_de_Software#Versões_de_Navegadores|Versões de navegadores]]
</p>

==Importância do uso do HTTPS==
<p align="justify">
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:
<br><br>
1. Segurança: O HTTPS criptografa os dados transmitidos, garantindo maior proteção contra interceptações e ataques.<br>
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.<br>
<br>
Para mais informações sobre a importância do uso do HTTPS, acesse: [[GE - Importância do uso do HTTPS|Importância do uso do HTTPS]]
</p>

==Autenticação em duas etapas e configurações de envio de e-mail==
<p align="justify">
Para acessar a Cia Web, é obrigatório que o usuário tenha habilitado a autenticação em duas etapas para realizar o login, independentemente do ambiente. Se precisar de ajuda para configurar, consulte a documentação: [[GE Autenticação em duas etapas]]
<br><br>
Caso o envio de e-mails ainda não esteja configurado, será necessário configurá-lo, pois a autenticação em duas etapas depende dessa configuração. Se precisar de ajuda, consulte: [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]]
</p>

==Configurações para Cia no CIGAM==
Algumas configurações e parametrizações no CIGAM são necessárias 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.<br>

===Ambiente padrão com único site===
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:
<br>
* Para acessar os Portais MVC:
** Acesse a configuração [[GE - AM - 3159 - Local de Instalação dos Portais Base]] e informe o local onde seus Portais MVC estão instalados.
*** Exemplo: http://servidor:porta/
<br>
* Para acessar os Portais React:
** Acesse a configuração [[GE - AM - 3160 - Local de Instalação dos Portais Complementares]] e informe onde seus Portais React estão instalados.
*** Exemplo: http://servidor:porta/
<br>
* Para acessar os dashboards do BI:
** Acesse a configuração [[GE - GE - 100325 - URL Base BI Portal]] e informe o endereço onde seu BI está instalado.
*** Exemplo: http://servidor:porta/bi<br>
<br>
'''Observação:''' mesmo em ambientes com um único site, é possível configurar as aplicações apenas por meio de '''nomes lógicos''' no arquivo '''Magic.ini'''. Nesse caso, as configurações acima não são necessárias. 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]]<br>

===Ambiente com mais de um site===
Em alguns casos, as aplicações podem estar instaladas 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.
<br>
* 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]]
<br>
* Para acessar os Portais React:
** Acesse a configuração [[GE - AM - 3160 - Local de Instalação dos Portais Complementares]] e informe onde seus Portais React estão instalados.
*** Exemplo: http://servidor:porta/
<br>
* Para acessar os dashboards do BI:
** Acesse a configuração [[GE - GE - 100325 - URL Base BI Portal]] e informe o endereço onde seu BI está instalado.
*** Exemplo: http://servidor:porta/bi<br>

===Configuração do BI para integração com a Cia===
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:
<br>
[[Imagem:apiCigamBI.png|semmoldura|centro|600px]]

===Configurações para compartilhamento de análises por e-mail===

A partir da versão '''Beta 261005''', o recurso [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Recurso_"Analisar_com_a_Cia"|Analisar com a Cia]] no Desktop passa a disponibilizar opções para utilização e compartilhamento das análises geradas, incluindo o envio por e-mail.

Embora a geração das análises não exija parametrizações adicionais no CIGAM, o compartilhamento por e-mail depende de algumas configurações no ambiente.

Para utilizar essa funcionalidade, é necessário:

* Possuir a '''API CIGAM'' instalada no ambiente utilizado.
* Possuir o '''Broker''' do ambiente devidamente configurado e em execução.
* Informar os nomes lógicos '''CDN''' e '''CDN_KEYTOKEN''' no arquivo '''Magic.ini'''.
* Possuir as configurações de envio de e-mails pelo CIGAM devidamente parametrizadas.
<br>

====Configuração da API====

Para realizar o envio de análises por e-mail, é necessário que a '''API CIGAM''' esteja instalada e acessível no ambiente utilizado.

A configuração [[GE - AM - 3159 - Local de Instalação dos Portais Base|3159 - Local de Instalação dos Portais Base]] deve estar devidamente parametrizada, permitindo que o CIGAM localize a API responsável pelo processamento da solicitação.

Caso a API não esteja instalada ou não possa ser acessada, será apresentada uma mensagem de erro ao tentar realizar o envio.

<br>
[[Imagem:CiaDesktopErroAPI.png|semmoldura|center|700px]]
<br>

====Configuração do Broker====

Para realizar o compartilhamento das análises por e-mail, também é necessário que o '''Broker''' do ambiente esteja devidamente configurado e em execução.
Caso o Broker não esteja em execução ou apresente alguma configuração incorreta, será exibida uma mensagem de erro ao tentar enviar a análise por e-mail.
<br>
[[Imagem:CiaDesktopErroBroker.png|semmoldura|center|700px]]
<br>

====Configuração dos nomes lógicos====
Além da API e do Broker, é necessário configurar os nomes lógicos '''CDN''' e '''CDN_KEYTOKEN''' no arquivo '''Magic.ini''' do ambiente.
Esses nomes lógicos são utilizados para identificar o endereço e a chave de acesso à CDN, necessária para disponibilizar o arquivo da análise que será enviado como anexo.

* '''CDN:''' deve conter o endereço da CDN utilizada pelo ambiente.
* '''CDN_KEYTOKEN:''' deve conter a chave de acesso utilizada para a comunicação com a CDN.

Caso o nome lógico '''CDN''' não esteja configurado corretamente, será apresentada uma mensagem de erro relacionada ao endereço da CDN.
<br>
[[Imagem:CiaDesktopErroCaminhoCDN.png|semmoldura|center|700px]]
<br>

Da mesma forma, caso o nome lógico '''CDN_KEYTOKEN''' não esteja informado corretamente, será apresentada uma mensagem de erro relacionada à chave de acesso.
<br>
[[Imagem:CiaDesktopErroCDNKey.png|semmoldura|center|700px]]
<br>

====Configurações de envio de e-mail====

Também é necessário que o ambiente possua as configurações necessárias para realizar o envio de e-mails pelo CIGAM devidamente parametrizadas.
Caso essas configurações estejam ausentes ou incorretas, poderão ocorrer falhas durante o envio da análise.
Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
<br>

'''Importante:''' o botão '''E-mail''' permanece disponível mesmo quando alguma das configurações necessárias não está correta. Nesses casos, a mensagem de erro correspondente será apresentada durante a tentativa de envio, e não haverá o compartilhamento da análise.
{{VoltarInicio}}

==Configurações de CORS==
<p align="justify">
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.<br><br>
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.<br><br>
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.
</p>

==Ambientes com acesso externo às aplicações==
<p align="justify">
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.
</p>

===Como configurar o web server (Microsoft IIS)?===
<p align="justify">
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).
<br><br>
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:
</p>

====Configuração via arquivo web.config====
<p align="justify">
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.<br>
<br>
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.<br>
<br>
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.<br>
<br>
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.
<br><br>
'''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.'''
<br><br>
'''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.'''
<br><br>
'''Importante: Essas configurações devem ser feitas apenas para os ambientes que tiverem HTTPS configurados.'''
<br><br>
Exemplo com as pastas das aplicações do CIGAM Web em C:\inetpub\wwwroot\cigam no Web Server IIS:
</p>

[[Imagem:pastaWebConfig.png|semmoldura|centro|770px|Web Config]]
<br>

<p align="justify">Também é possível copiar e utilizar o código abaixo para facilitar a configuração:</p>

''<?xml version="1.0" encoding="UTF-8"?><br> <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><br> </configuration>''

====Como dar acesso através do IIS?====
<p align="justify">
Para configurar o CSP diretamente no IIS, siga os passos abaixo:<br><br>
1. Acesse o '''Gerenciador de Serviços de Informações da Internet (IIS)''' e localize o site que deseja liberar o acesso.<br><br>
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'''.
</p>

[[Imagem:CabecalhoResp.png|semmoldura|centro|800px]]
<br>
<p align="justify">
3. Adicione o cabeçalho '''Content-Security-Policy''' na seção '''Ações''', localizada à direita, clique em '''Adicionar'''.
</p>

[[Imagem:CabecalhoResp2.png|semmoldura|centro|800px]]
<br>
<p align="justify">
4. Na caixa de diálogo que será exibida, preencha os seguintes campos:
* Nome: Content-Security-Policy.
* Valor: frame-ancestors 'self' https://services.cigam.cloud http://services.cigam.cloud;
</p>
<br>
'''Lembre-se de 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?====
<p align="justify">
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'''.
</p>

[[Imagem:Gerenciamento.png|semmoldura|centro|800px]]
<br>
<br>
<p align="justify">
* 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
</p>

[[Imagem:httpCookies.png|semmoldura|centro|800px]]
<br>

<p align="justify">
* Configuração de '''sessionState''':
** Ainda em '''system.web''', localize a configuração '''sessionState'''.<br>
** Altere o valor da propriedade '''cookieSameSite''' para '''None'''.
</p>

[[Imagem:sessionStage.png|semmoldura|centro|850px]]
<br><br>
<p align="justify">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.</p>
{{VoltarInicio}}

==Ambientes internos sem acesso externo às aplicações==
<p align="justify">
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).
<br><br>
'''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.
<br><br>
Para mais informações sobre a importância do uso do HTTPS, acesse: [[GE - Importância do uso do HTTPS|Importância do uso do HTTPS]]
</p>

==Garantindo permissão de acesso aos cookies de terceiros no navegador==
<p align="justify">
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''':<br>
<br>
* 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".
</p>

[[Imagem:settingsEdge.png|semmoldura|centro|800px]]
<br>
<br>
<p align="justify">
* 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".
</p>

[[Imagem:settingsChrome.png|semmoldura|centro|800px]]

==Dispositivos móveis==
<p align="justify">
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.
</p>

[[Imagem:CiaInstalarAppMobile.png|semmoldura|centro|700px]]

<p align="justify">
É 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.
</p>
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, os recursos da Cia possuem exigências diferentes de configuração. Os itens abaixo indicam o que é necessário em cada caso.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia a partir do menu de mosaico (Cia - IA do CIGAM) abre a Cia Web (SaaS). Por esse motivo, depende das configurações descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]], em especial:<br>
* [[#Configurações para Cia no CIGAM|Configurações para Cia no CIGAM]], conforme o ambiente possua um único site ou mais de um.
* [[#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]].
* As configurações de ambiente, como CSP, cookies e permissões do navegador.
<br>
[[Imagem:mosaicoCia.png|semmoldura|centro|650px]]
<br>
Para mais informações sobre como configurar nomes lógicos e o menu mosaico, consulte: [[GE - Como Fazer - Configuração do menu mosaico nos Portais Web]]<br>

==Agentes e opções generativas==
Não é necessária nenhuma parametrização para utilizar os '''agentes''' e as '''opções generativas''' disponíveis no menu da Cia nos Portais, como melhoria de texto e revisão gramatical. Esses recursos são disponibilizados automaticamente, de acordo com o contexto da tela, e não dependem das configurações de local de instalação nem da autenticação em duas etapas.<br>
<br>
Os agentes estão disponíveis a partir da versão '''Beta 260601''', e o '''Editor de Agentes''' a partir da versão '''Beta 261005''', tanto para os Portais MVC quanto para os Portais React.<br>
<br>
[[Imagem:MenuCiaPortais.png|semmoldura|centro|600px]]
<br>
Para saber como utilizar esses recursos, consulte: [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer uso da Cia IA do CIGAM]]
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, os recursos da Cia possuem exigências distintas de configuração:<br>
<br>
{| class="wikitable"
|-
| '''Recurso''' || '''Configuração necessária'''
|-
| '''Acesso rápido à Cia - IA do CIGAM''' || Exige API e Portais instalados, além das configurações da Cia Web (SaaS).
|-
| '''Analisar com a Cia''' || Não exige parametrização no CIGAM. Requer a versão 250505 patch A ou superior e o navegador padrão e a extensão .html configurados no Windows.
|}

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM) disponível no menu lateral do Desktop abre a Cia Web (SaaS) em uma janela integrada ao sistema. Por esse motivo, depende de:<br>
* A API e os Portais instalados, pois são eles que conectam o sistema aos dados do ERP. '''Sem a API, a funcionalidade não funcionará'''.
* As configurações descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]], em especial [[#Configurações para Cia no CIGAM|Configurações para Cia no CIGAM]] e [[#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]].
<br>
[[Imagem:CiaIA.png|semmoldura|centro|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''', disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída, não exige nenhuma parametrização no CIGAM. Ele também não depende da autenticação em duas etapas nem das configurações de local de instalação dos Portais.<br>
<br>
Exemplo do recurso disponível na Pesquisa Dinâmica:<br>
<br>
[[Imagem:PesquisaDinamicaComCia.png|semmoldura|centro|800px]]
<br>
Os requisitos para utilização são:<br>
* Estar na versão '''250505.a''' ou superior.
* Ter um '''navegador padrão configurado no Windows''', preferencialmente o '''Google Chrome''' ou o '''Microsoft Edge''', por serem os navegadores homologados pela CIGAM.
* Ter a '''extensão .html''' associada a um desses navegadores, para que o conteúdo enviado à Cia seja aberto corretamente.
<br>
[[Imagem:NavegadorPadraoWindows.png|semmoldura|centro|800px]]
<br>
Para mais informações sobre os navegadores homologados, acesse: [[Requisitos_de_Software#Versões_de_Navegadores|Versões de navegadores]]<br>
<br>
Para saber como utilizar o recurso, consulte: [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer uso da Cia IA do CIGAM]]

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Uso da Cia - IA do CIGAM]]<br>
[[GE - Importância do uso do HTTPS]]<br>
[[GE Autenticação em duas etapas]]<br>
[[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]]<br>
[[GE - Como Fazer - Configuração do menu mosaico nos Portais Web]]
{{VoltarInicio}}

Arquivo:CiaDesktopErroCDNKey.png

2026-10-15T18:41:22Z

Vinicius.moder:

Arquivo:CiaDesktopErroCaminhoCDN.png

2026-10-15T18:41:11Z

Vinicius.moder:

Arquivo:CiaDesktopErroBroker.png

2026-10-15T18:40:56Z

Vinicius.moder:

Arquivo:CiaDesktopErroAPI.png

2026-10-15T18:40:44Z

Vinicius.moder:

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

2026-10-15T18:39:05Z

Vinicius.moder: /* Configurações para Cia no CIGAM */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como Fazer Utilidades/Diversos_2]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como_Fazer - Configuração da Cia IA do CIGAM|Configuração da Cia IA do CIGAM]]

=Como a Cia - IA do CIGAM funciona?=
<p align="justify">
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.
<br>
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:
<br>
* Atualizações em tempo real, sem necessidade de intervenção do cliente.<br/>
* Treinamento de forma compartilhada, adicionando novas funcionalidades, otimizando performance e resultados.<br/>
</p>
Todas as configurações necessárias estão descritas em [[#Cia Web (SaaS)|Cia Web (SaaS)]]. As seções [[#Portais|Portais]] e [[#Desktop|Desktop]] indicam quais dessas configurações se aplicam a cada forma de acesso.<br>

=Cia Web (SaaS)=
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.
<br><br>
As configurações desta seção garantem o funcionamento da Cia Web, que é a aplicação onde todos os recursos da Cia são disponibilizados.
<br><br>
Como os Portais e a aplicação Desktop abrem a mesma Cia Web, essas configurações também se aplicam a eles, conforme indicado nas respectivas seções.<br>

==Versões de navegadores==
<p align="justify">
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.
<br><br>
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.
<br><br>
Para mais informações, acesse: [[Requisitos_de_Software#Versões_de_Navegadores|Versões de navegadores]]
</p>

==Importância do uso do HTTPS==
<p align="justify">
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:
<br><br>
1. Segurança: O HTTPS criptografa os dados transmitidos, garantindo maior proteção contra interceptações e ataques.<br>
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.<br>
<br>
Para mais informações sobre a importância do uso do HTTPS, acesse: [[GE - Importância do uso do HTTPS|Importância do uso do HTTPS]]
</p>

==Autenticação em duas etapas e configurações de envio de e-mail==
<p align="justify">
Para acessar a Cia Web, é obrigatório que o usuário tenha habilitado a autenticação em duas etapas para realizar o login, independentemente do ambiente. Se precisar de ajuda para configurar, consulte a documentação: [[GE Autenticação em duas etapas]]
<br><br>
Caso o envio de e-mails ainda não esteja configurado, será necessário configurá-lo, pois a autenticação em duas etapas depende dessa configuração. Se precisar de ajuda, consulte: [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]]
</p>

==Configurações para Cia no CIGAM==
Algumas configurações e parametrizações no CIGAM são necessárias 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.<br>

===Ambiente padrão com único site===
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:
<br>
* Para acessar os Portais MVC:
** Acesse a configuração [[GE - AM - 3159 - Local de Instalação dos Portais Base]] e informe o local onde seus Portais MVC estão instalados.
*** Exemplo: http://servidor:porta/
<br>
* Para acessar os Portais React:
** Acesse a configuração [[GE - AM - 3160 - Local de Instalação dos Portais Complementares]] e informe onde seus Portais React estão instalados.
*** Exemplo: http://servidor:porta/
<br>
* Para acessar os dashboards do BI:
** Acesse a configuração [[GE - GE - 100325 - URL Base BI Portal]] e informe o endereço onde seu BI está instalado.
*** Exemplo: http://servidor:porta/bi<br>
<br>
'''Observação:''' mesmo em ambientes com um único site, é possível configurar as aplicações apenas por meio de '''nomes lógicos''' no arquivo '''Magic.ini'''. Nesse caso, as configurações acima não são necessárias. 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]]<br>

===Ambiente com mais de um site===
Em alguns casos, as aplicações podem estar instaladas 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.
<br>
* 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]]
<br>
* Para acessar os Portais React:
** Acesse a configuração [[GE - AM - 3160 - Local de Instalação dos Portais Complementares]] e informe onde seus Portais React estão instalados.
*** Exemplo: http://servidor:porta/
<br>
* Para acessar os dashboards do BI:
** Acesse a configuração [[GE - GE - 100325 - URL Base BI Portal]] e informe o endereço onde seu BI está instalado.
*** Exemplo: http://servidor:porta/bi<br>

===Configuração do BI para integração com a Cia===
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:
<br>
[[Imagem:apiCigamBI.png|semmoldura|centro|600px]]

===Configurações para compartilhamento de análises por e-mail===

A partir da versão '''Beta 261005''', o recurso '''"Analisar com a Cia"''' no Desktop passa a disponibilizar opções para utilização e compartilhamento das análises geradas, incluindo o envio por e-mail.

Embora a geração das análises não exija parametrizações adicionais no CIGAM, o compartilhamento por e-mail depende de algumas configurações no ambiente.

Para utilizar essa funcionalidade, é necessário:

* Possuir a '''API CIGAM instalada''' no ambiente utilizado.
* Ter a configuração [[GE - AM - 3159 - Local de Instalação dos Portais Base|3159 - Local de Instalação dos Portais Base]] devidamente parametrizada.
* Possuir o '''Broker''' do ambiente devidamente configurado e em execução.
* Informar os nomes lógicos '''CDN''' e '''CDN_KEYTOKEN''' no arquivo '''Magic.ini'''.
* Possuir as configurações de envio de e-mails pelo CIGAM devidamente parametrizadas.
<br>

====Configuração da API====

Para realizar o envio de análises por e-mail, é necessário que a '''API CIGAM''' esteja instalada e acessível no ambiente utilizado.

A configuração [[GE - AM - 3159 - Local de Instalação dos Portais Base|3159 - Local de Instalação dos Portais Base]] deve estar devidamente parametrizada, permitindo que o CIGAM localize a API responsável pelo processamento da solicitação.

Caso a API não esteja instalada ou não possa ser acessada, será apresentada uma mensagem de erro ao tentar realizar o envio.

<br>
[[Imagem:CiaDesktopErroAPI.png|semmoldura|center|700px]]
<br>

====Configuração do Broker====

Para realizar o compartilhamento das análises por e-mail, também é necessário que o '''Broker''' do ambiente esteja devidamente configurado e em execução.
Caso o Broker não esteja em execução ou apresente alguma configuração incorreta, será exibida uma mensagem de erro ao tentar enviar a análise por e-mail.
<br>
[[Imagem:CiaDesktopErroBroker.png|semmoldura|center|700px]]
<br>

====Configuração dos nomes lógicos====
Além da API e do Broker, é necessário configurar os nomes lógicos '''CDN''' e '''CDN_KEYTOKEN''' no arquivo '''Magic.ini''' do ambiente.
Esses nomes lógicos são utilizados para identificar o endereço e a chave de acesso à CDN, necessária para disponibilizar o arquivo da análise que será enviado como anexo.

* '''CDN:''' deve conter o endereço da CDN utilizada pelo ambiente.
* '''CDN_KEYTOKEN:''' deve conter a chave de acesso utilizada para a comunicação com a CDN.

Caso o nome lógico '''CDN''' não esteja configurado corretamente, será apresentada uma mensagem de erro relacionada ao endereço da CDN.
<br>
[[Imagem:CiaDesktopErroCaminhoCDN.png|semmoldura|center|700px]]
<br>

Da mesma forma, caso o nome lógico '''CDN_KEYTOKEN''' não esteja informado corretamente, será apresentada uma mensagem de erro relacionada à chave de acesso.
<br>
[[Imagem:CiaDesktopErroCDNKey.png|semmoldura|center|700px]]
<br>

====Configurações de envio de e-mail====

Também é necessário que o ambiente possua as configurações necessárias para realizar o envio de e-mails pelo CIGAM devidamente parametrizadas.
Caso essas configurações estejam ausentes ou incorretas, poderão ocorrer falhas durante o envio da análise.
Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
<br>

'''Importante:''' o botão '''E-mail''' permanece disponível mesmo quando alguma das configurações necessárias não está correta. Nesses casos, a mensagem de erro correspondente será apresentada durante a tentativa de envio, e não haverá o compartilhamento da análise.
{{VoltarInicio}}

==Configurações de CORS==
<p align="justify">
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.<br><br>
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.<br><br>
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.
</p>

==Ambientes com acesso externo às aplicações==
<p align="justify">
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.
</p>

===Como configurar o web server (Microsoft IIS)?===
<p align="justify">
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).
<br><br>
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:
</p>

====Configuração via arquivo web.config====
<p align="justify">
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.<br>
<br>
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.<br>
<br>
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.<br>
<br>
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.
<br><br>
'''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.'''
<br><br>
'''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.'''
<br><br>
'''Importante: Essas configurações devem ser feitas apenas para os ambientes que tiverem HTTPS configurados.'''
<br><br>
Exemplo com as pastas das aplicações do CIGAM Web em C:\inetpub\wwwroot\cigam no Web Server IIS:
</p>

[[Imagem:pastaWebConfig.png|semmoldura|centro|770px|Web Config]]
<br>

<p align="justify">Também é possível copiar e utilizar o código abaixo para facilitar a configuração:</p>

''<?xml version="1.0" encoding="UTF-8"?><br> <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><br> </configuration>''

====Como dar acesso através do IIS?====
<p align="justify">
Para configurar o CSP diretamente no IIS, siga os passos abaixo:<br><br>
1. Acesse o '''Gerenciador de Serviços de Informações da Internet (IIS)''' e localize o site que deseja liberar o acesso.<br><br>
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'''.
</p>

[[Imagem:CabecalhoResp.png|semmoldura|centro|800px]]
<br>
<p align="justify">
3. Adicione o cabeçalho '''Content-Security-Policy''' na seção '''Ações''', localizada à direita, clique em '''Adicionar'''.
</p>

[[Imagem:CabecalhoResp2.png|semmoldura|centro|800px]]
<br>
<p align="justify">
4. Na caixa de diálogo que será exibida, preencha os seguintes campos:
* Nome: Content-Security-Policy.
* Valor: frame-ancestors 'self' https://services.cigam.cloud http://services.cigam.cloud;
</p>
<br>
'''Lembre-se de 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?====
<p align="justify">
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'''.
</p>

[[Imagem:Gerenciamento.png|semmoldura|centro|800px]]
<br>
<br>
<p align="justify">
* 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
</p>

[[Imagem:httpCookies.png|semmoldura|centro|800px]]
<br>

<p align="justify">
* Configuração de '''sessionState''':
** Ainda em '''system.web''', localize a configuração '''sessionState'''.<br>
** Altere o valor da propriedade '''cookieSameSite''' para '''None'''.
</p>

[[Imagem:sessionStage.png|semmoldura|centro|850px]]
<br><br>
<p align="justify">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.</p>
{{VoltarInicio}}

==Ambientes internos sem acesso externo às aplicações==
<p align="justify">
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).
<br><br>
'''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.
<br><br>
Para mais informações sobre a importância do uso do HTTPS, acesse: [[GE - Importância do uso do HTTPS|Importância do uso do HTTPS]]
</p>

==Garantindo permissão de acesso aos cookies de terceiros no navegador==
<p align="justify">
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''':<br>
<br>
* 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".
</p>

[[Imagem:settingsEdge.png|semmoldura|centro|800px]]
<br>
<br>
<p align="justify">
* 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".
</p>

[[Imagem:settingsChrome.png|semmoldura|centro|800px]]

==Dispositivos móveis==
<p align="justify">
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.
</p>

[[Imagem:CiaInstalarAppMobile.png|semmoldura|centro|700px]]

<p align="justify">
É 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.
</p>
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, os recursos da Cia possuem exigências diferentes de configuração. Os itens abaixo indicam o que é necessário em cada caso.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia a partir do menu de mosaico (Cia - IA do CIGAM) abre a Cia Web (SaaS). Por esse motivo, depende das configurações descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]], em especial:<br>
* [[#Configurações para Cia no CIGAM|Configurações para Cia no CIGAM]], conforme o ambiente possua um único site ou mais de um.
* [[#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]].
* As configurações de ambiente, como CSP, cookies e permissões do navegador.
<br>
[[Imagem:mosaicoCia.png|semmoldura|centro|650px]]
<br>
Para mais informações sobre como configurar nomes lógicos e o menu mosaico, consulte: [[GE - Como Fazer - Configuração do menu mosaico nos Portais Web]]<br>

==Agentes e opções generativas==
Não é necessária nenhuma parametrização para utilizar os '''agentes''' e as '''opções generativas''' disponíveis no menu da Cia nos Portais, como melhoria de texto e revisão gramatical. Esses recursos são disponibilizados automaticamente, de acordo com o contexto da tela, e não dependem das configurações de local de instalação nem da autenticação em duas etapas.<br>
<br>
Os agentes estão disponíveis a partir da versão '''Beta 260601''', e o '''Editor de Agentes''' a partir da versão '''Beta 261005''', tanto para os Portais MVC quanto para os Portais React.<br>
<br>
[[Imagem:MenuCiaPortais.png|semmoldura|centro|600px]]
<br>
Para saber como utilizar esses recursos, consulte: [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer uso da Cia IA do CIGAM]]
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, os recursos da Cia possuem exigências distintas de configuração:<br>
<br>
{| class="wikitable"
|-
| '''Recurso''' || '''Configuração necessária'''
|-
| '''Acesso rápido à Cia - IA do CIGAM''' || Exige API e Portais instalados, além das configurações da Cia Web (SaaS).
|-
| '''Analisar com a Cia''' || Não exige parametrização no CIGAM. Requer a versão 250505 patch A ou superior e o navegador padrão e a extensão .html configurados no Windows.
|}

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM) disponível no menu lateral do Desktop abre a Cia Web (SaaS) em uma janela integrada ao sistema. Por esse motivo, depende de:<br>
* A API e os Portais instalados, pois são eles que conectam o sistema aos dados do ERP. '''Sem a API, a funcionalidade não funcionará'''.
* As configurações descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]], em especial [[#Configurações para Cia no CIGAM|Configurações para Cia no CIGAM]] e [[#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]].
<br>
[[Imagem:CiaIA.png|semmoldura|centro|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''', disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída, não exige nenhuma parametrização no CIGAM. Ele também não depende da autenticação em duas etapas nem das configurações de local de instalação dos Portais.<br>
<br>
Exemplo do recurso disponível na Pesquisa Dinâmica:<br>
<br>
[[Imagem:PesquisaDinamicaComCia.png|semmoldura|centro|800px]]
<br>
Os requisitos para utilização são:<br>
* Estar na versão '''250505.a''' ou superior.
* Ter um '''navegador padrão configurado no Windows''', preferencialmente o '''Google Chrome''' ou o '''Microsoft Edge''', por serem os navegadores homologados pela CIGAM.
* Ter a '''extensão .html''' associada a um desses navegadores, para que o conteúdo enviado à Cia seja aberto corretamente.
<br>
[[Imagem:NavegadorPadraoWindows.png|semmoldura|centro|800px]]
<br>
Para mais informações sobre os navegadores homologados, acesse: [[Requisitos_de_Software#Versões_de_Navegadores|Versões de navegadores]]<br>
<br>
Para saber como utilizar o recurso, consulte: [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer uso da Cia IA do CIGAM]]

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Uso da Cia - IA do CIGAM]]<br>
[[GE - Importância do uso do HTTPS]]<br>
[[GE Autenticação em duas etapas]]<br>
[[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]]<br>
[[GE - Como Fazer - Configuração do menu mosaico nos Portais Web]]
{{VoltarInicio}}

GE - Como Fazer - Uso da Cia - IA do CIGAM

2026-10-15T18:18:00Z

Vinicius.moder: /* Recurso "Analisar com a Cia" */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como_Fazer_Utilidades/Diversos_6]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer - Uso da Cia - IA do CIGAM]]

=Recursos, configurações e segurança=
A Cia - IA do CIGAM oferece diversas funcionalidades e atua como um hub centralizador para os recursos de inteligência artificial utilizados nas soluções CIGAM. Para garantir o correto funcionamento desses recursos, é necessário verificar se os pré-requisitos e as configurações foram realizados adequadamente. Para mais informações, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM|Como Fazer configuração da Cia IA do CIGAM]]
<br><br>
Todas as soluções de IA do CIGAM são integradas por meio dos serviços da Cia. A Cia possui integração com diferentes provedores de IA de terceiros, como OpenAI, Google, Anthropic, entre outros. Essas integrações são realizadas por meio de contas e serviços contratados, com condições de uso que asseguram que os dados trafegados não sejam utilizados para treinamento dos modelos, identificação de origem, publicidade, anúncios ou qualquer outra finalidade não prevista.
<br><br>
No caso de IAs open-source integradas à Cia, os modelos são executados dentro dos domínios da CIGAM, mantendo as mesmas premissas aplicadas às IAs contratadas: não utilização dos dados para treinamento de modelos, não identificação da origem das informações e ausência de retenção dos dados processados.
<br><br>
Além disso, sempre que houver envio explícito de dados pelo usuário por meio das funcionalidades da Cia disponíveis nas soluções CIGAM, será apresentado um diálogo de confirmação, permitindo que o usuário aceite o envio dessas informações. Os dados enviados serão tratados conforme as mesmas diretrizes de segurança, privacidade e não retenção descritas anteriormente.
<br><br>
Esta documentação apresenta o uso da Cia e está organizada conforme a forma de acesso: [[#Cia Web (SaaS)|Cia Web (SaaS)]], [[#Portais|Portais]] e [[#Desktop|Desktop]].
<br><br>
Caso tenha dúvidas sobre onde encontrar a Cia em cada uma dessas plataformas, ou sobre quais ferramentas do CIGAM possuem recursos integrados a ela, consulte a documentação específica de acesso: [[GE - Como Fazer - Cia - Como acessar|Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Cia Web (SaaS)=
A Cia Web é a aplicação web que centraliza todas as funcionalidades da Cia. Ela pode ser acessada diretamente pelo navegador do seu computador ou dispositivo móvel, ou ainda a partir do Desktop e dos Portais, sem a necessidade de novo login.
<br><br>

<center><youtube>https://youtu.be/DFGtRtPF75A</youtube></center>
<br>

==Primeiro acesso==
A Cia Web pode ser acessada diretamente pelo navegador, utilizando o seguinte endereço: https://services.cigam.cloud/cia/index.html
<br><br>
'''Importante:''' o usuário que for realizar o login precisa ter a autenticação em duas etapas habilitada. Para saber como configurá-la, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]]
<br><br>
Ao acessar pelo endereço, será necessário preencher algumas informações para que a Cia consiga validar seu acesso e consultar seus dados:<br>
* Informar a API do seu CIGAM Server, para garantir o direcionamento correto da base de dados.<br><br>

[[Imagem:CiaAPI.png|semmoldura|center|700px]]<br>

* Informar usuário e senha de login e seu código de verificação:<br><br>

[[Imagem:CiaLogin.png|semmoldura|center|700px]]
<br>
[[Imagem:CiaCodVerif.png|semmoldura|center|700px]]<br>

* Caso não queira aguardar ou informar o código de verificação, você pode optar por responder à pergunta secreta, clicando no botão “Pergunta Secreta” exibido na imagem acima.<br><br>

[[Imagem:CiaLoginA2F.png|semmoldura|center|700px]]
<br>

==Conhecendo a tela da Cia==
Após realizar o login, a Cia carregará automaticamente as informações e dados necessários do ambiente e será iniciada no assunto '''#Geral''', identificado pelo botão localizado à esquerda da caixa de texto.

[[Imagem:CiaGeral.png|semmoldura|center|700px]]
<br><br>
Ao clicar nesse botão, será exibida uma lista com todos os assuntos disponíveis, permitindo que você selecione aquele com o qual deseja interagir.<br><br>
Além disso, você pode digitar diretamente na caixa de texto o '''#Assunto''' que deseja utilizar, e a Cia entenderá automaticamente o tema da sua mensagem.<br><br>
Também é possível '''formular uma pergunta seguida de um #Assunto''' para interagir com qualquer assunto, mesmo que ele não esteja selecionado no momento.

[[Imagem:CiaAberta.png|semmoldura|center|700px]]
<br>
Ao selecionar um assunto, serão exibidas automaticamente dicas e sugestões sobre o tema escolhido, além de exemplos clicáveis que, ao serem selecionados, são processados de forma imediata.<br><br>
Além disso, ao digitar um ponto de interrogação (?) na caixa de texto, será exibida uma lista com todas as interações disponíveis para o assunto selecionado, facilitando a descoberta de comandos e possibilidades de uso.

[[Imagem:CiaDicas.png|semmoldura|center|700px]]
<br>
Outra funcionalidade prática é a possibilidade de reenviar perguntas já feitas no chat. Para isso, basta posicionar o mouse sobre a pergunta desejada e clicar no ícone de “Reenviar”. Ao passar o mouse sobre a mensagem, também será exibido o horário de envio.
<br>
[[Imagem:CiaReenviar.png|semmoldura|center|400px]]
<br>
Além disso, você pode utilizar as setas do teclado (⬆️ para cima e ⬇️ para baixo) na caixa de texto para navegar pelas últimas perguntas enviadas para o #Assunto selecionado, facilitando o reuso de interações anteriores.

===Ícones da caixa de texto===
Na caixa de texto, você encontrará alguns ícones com as seguintes funções:

<center>
{| class="wikitable"
|-
! !! Ação
|-
|center|[[Imagem:CiaUltPerg.png]] || '''Histórico de Perguntas''' – Ao clicar, é exibido o histórico das perguntas já realizadas para o assunto selecionado.
|-
|center|[[Imagem:CiaEnviar.png]] || '''Enviar''' – Envia o conteúdo digitado na caixa de texto.
|-
|center|[[Imagem:CiaFala.png]] || '''Falar''' – Permite falar ao invés de digitar, usando o recurso de voz.
|-
|center|[[Imagem:CiaExpandir.png]] || '''Expandir''' – Aumenta a altura da caixa de texto para facilitar a digitação de mensagens longas.
|-
|center|[[Imagem:CiaRecolher.png]] || '''Recolher''' – Reduz a caixa de texto ao tamanho padrão.
|}
</center>
{{VoltarInicio}}

==Assuntos disponíveis==

===Geral===
Nesse assunto, é possível conversar livremente com a Cia sobre qualquer um dos assuntos disponíveis. Se encontrar dificuldades para obter a resposta desejada, experimente selecionar um assunto específico, o que pode gerar resultados mais precisos.<br><br>
Se houver muitas respostas correspondentes, a Cia não executará nenhuma automaticamente. Em vez disso, exibirá uma opção com os valores possíveis, permitindo que você selecione manualmente a melhor alternativa.

[[Imagem:CiaGeralOpcoes.png|semmoldura|center|700px]]
<br>
Caso a Cia encontre uma resposta com confiança significativamente maior que as demais, ela será executada automaticamente.
<br><br>
No entanto, se você selecionar a opção “Não era bem isso o que eu queria”, a Cia exibirá outras opções relacionadas ao que foi solicitado, apresentando também um indicador de semáforo com a porcentagem de confiança de cada alternativa.

[[Imagem:CiaGeralOpcaoCerta.png|semmoldura|center|600px]]

===Ajuda, Vídeos e Auditor===
Conheça melhor o ERP com a ajuda da Wiki e Cia, assista vídeos sobre o CIGAM e audite seu ambiente.

====Ajuda====
Nesse assunto, você pode acessar o Chatbot da assistente virtual, onde você pode tirar dúvidas e consultar conteúdos da CIGAM Wiki enviando perguntas diretamente nela.<br>
<br>
'''Importante:''' neste assunto, a Cia atua dedicada à Wiki, focada exclusivamente nos conteúdos da documentação. As demais funcionalidades e atalhos da Cia não estarão disponíveis nesse contexto.

====Vídeos====
Nesse assunto, é possível procurar por vídeos relacionados ao tema desejado. O resultado será apresentado em forma de lista, contendo os vídeos encontrados e os tempos exatos em que o assunto começa a ser abordado, de acordo com o termo ou palavra pesquisada.

====Auditor====
Neste assunto, é possível verificar o status do sistema e identificar possíveis problemas ou inconsistências. O resultado será exibido em forma de tabela, contendo os dados retornados para facilitar a análise.

===Painéis BI, Portais e Relatórios===
Explore dashboards do BI, interaja com Portais intuitivos e execute relatórios personalizados.

====Painéis BI====
Nesse assunto, é possível abrir dashboards do BI já configurados para o usuário, permitindo sua visualização diretamente na tela.
Ao abrir um dashboard, você também pode interagir com ele, solicitando inserção de filtros, dimensões, métricas, transformações e outros ajustes.<br>
Cada dashboard aberto exibirá uma guia com as “Interações” disponíveis para aquele painel específico.
<br><br>
Além disso, ao selecionar o assunto '''#Painéis do BI''', é possível solicitar que a Cia crie um dashboard do zero.
Por exemplo: "Crie um dashboard para ver meu fluxo de caixa". Você pode ainda solicitar que métricas, dimensões e filtros sejam adicionados durante a criação, ou pedir dashboards separados por áreas.
<br><br>
'''Importante:''' caso o usuário não possua acesso ao BI ou este não esteja implementado na base de dados, será exibida uma mensagem informativa no momento do login na Cia.

====Portais====
Quando este assunto é utilizado, o resultado será sempre a abertura de uma tela dos Portais, permitindo ao usuário acessar diretamente os conteúdos e funcionalidades disponíveis nesse ambiente.
<br><br>
Essa abertura é feita de forma integrada, garantindo uma navegação contínua entre a Cia e os Portais, sem necessidade de realizar novo login ou sair da plataforma.

====Relatórios====
Ao utilizar esse assunto, será exibida uma tela para preenchimento de filtros, permitindo a emissão de relatórios web.
<br><br>
Para que essa funcionalidade opere corretamente, é necessário garantir que a instalação da CDN e da Pesquisa Dinâmica no servidor de aplicação esteja configurada de forma adequada.
<br><br>
Os relatórios exibidos aqui são os mesmos disponíveis nos Portais CIGAM, portanto é essencial que esses componentes também estejam funcionando corretamente nesses Portais.

===Qual, Faça, Consultar, Listar, Analisar e Insights===
Crie registros, analise informações ou liste dados cadastrados no CIGAM.

====Qual====
Nesse assunto, a Cia vai consultar e processar informações diretamente no ERP, usando os dados e relacionamentos disponíveis no CIGAM, e retornar os resultados em forma de texto para você visualizar.
<br><br>
'''Importante:''' nem todas as opções estão liberadas. Para ver quais você pode usar, digite ? na caixa de texto. A Cia vai mostrar uma lista com todos os comandos e funções disponíveis.

====Faça====
Nesse assunto, a Cia sempre fará um processamento no CIGAM e retornará o status do resultado. Por exemplo, você pode solicitar que a Cia crie um alerta ou até mesmo crie uma nova empresa no sistema.
<br><br>
'''Dica:''' para saber quais treinamentos ou comandos estão disponíveis, digite ? na caixa de texto. A Cia mostrará uma lista com todas as opções implementadas para você usar.

====Consultar====
Nesse assunto, você poderá fazer consultas de dados para obter listagens de registros, conforme os treinamentos de tabelas disponíveis. O resultado será apresentado em forma de tabela, exibindo os dados retornados. Já existem diversas Views prontas, para que você possa listar informações de forma mais completa e rápida.
<br><br>
'''Dica:''' para ver exemplos de consultas já implementadas, digite ? na caixa de texto.

====Listar====
Nesse assunto, você pode montar sua própria consulta de dados, escolhendo os filtros e parâmetros para gerar uma listagem personalizada. Diferente do assunto #Consultar, aqui é possível utilizar qualquer tabela do CIGAM para montar sua consulta, escrevendo em linguagem natural o que deseja buscar.
<br><br>
'''Dica:''' para ver todas as tabelas disponíveis, digite ? na caixa de texto.

====Analisar====
Analise o arquivo selecionado para gerar gráficos interativos e informativos, apresentando insights relevantes que ajudam a identificar tendências, padrões e oportunidades de melhoria.
<br><br>
Esse recurso oferece uma visualização clara e intuitiva dos dados, facilitando a interpretação das informações e apoiando a tomada de decisões estratégicas.
<br><br>
'''Aviso:''' para utilizar esta funcionalidade, é necessário concordar que os dados enviados serão processados por modelos de IA de terceiros integrados à Cia.

[[Imagem:AnalisarCia.png|semmoldura|center|600px]]

====Insights====
Gere insights inteligentes a partir dos dados de uma consulta, com análises automáticas realizadas pela Cia, que identificam padrões, tendências e possíveis pontos de atenção. Esse recurso ajuda a transformar dados brutos em informações acionáveis, facilitando a tomada de decisões estratégicas e otimizando processos.
<br><br>
'''Aviso:''' ao utilizar o assunto “Insights”, você concorda que os dados e informações analisados poderão ser enviados para modelos de IA de terceiros integrados à Cia, exclusivamente para processamento e geração dos resultados apresentados.

===IA Generativa e Pesquisa na Internet===
Converse com a IA sobre assuntos diversos, crie conteúdos e pesquise na internet sobre qualquer coisa.

====IA Generativa====
Nesse assunto, ao interagir com a IA Generativa, você poderá fazer qualquer tipo de pergunta ou solicitação, de forma livre e criativa.
O resultado exibido será exatamente a resposta gerada pela IA, sem complementos da Cia. Você pode, por exemplo, solicitar que a IA melhore ou reformule um texto, crie conteúdos ou resuma informações.
<br><br>
'''Importante:''' nesse assunto, a Cia não estará integrada aos serviços e sistemas do CIGAM — a interação é exclusivamente com a IA Generativa.

====Pesquisa na Internet====
Use esse assunto para fazer pesquisas na internet e visualizar os resultados diretamente integrados na Cia, sem precisar sair da plataforma. Você pode pesquisar qualquer tema de interesse e abrir os links retornados para acessar conteúdos, notícias e informações de forma rápida e prática.
{{VoltarInicio}}

===Compartilhamento de Análises da Cia===

<br>
<div align="justify">
Na Cia Web (SaaS), é possível gerar análises detalhadas de determinadas informações e compartilhá-las. Essa funcionalidade está disponível nos seguintes assuntos: [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Auditor|Auditor]], [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Analisar|Analisar]], [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Insights|Insights]], [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Listar|Listar]] e [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Consultar|Consultar]].
</div>
<br>

[[Image: opcoesAnalisarCia.png|semmoldura|center|800px]]

<br>
<div align="justify">
Essa opção está disponível por meio do botão '''analisar''', exibido junto à resposta apresentada após a solicitação de um desses assuntos.
</div>
<br>

[[Image: exemploBotaoAnalisar.png|semmoldura|center|800px]]

<br>
<div align="justify">
Particularmente para o assunto '''Analisar''', a análise já é exibida diretamente, pois essa é a finalidade desse assunto:
</div>
<br>

[[Image: analiseAnalisar.png|semmoldura|center|800px]]

<br>
<div align="justify">
Ao gerar uma análise , a página de resultado passa a disponibilizar opções para compartilhar e utilizar o conteúdo gerado. São disponibilizadas três opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>
<br>

[[Image: CiaWebAnalise.png|semmoldura|center|800px]]

=====Compartilhamento por e-mail=====

<div align="justify">
Ao selecionar a opção '''E-mail''', é apresentada uma janela para preenchimento das informações necessárias ao envio da análise.
</div>
<br>

[[Image: CiaWebModalEmail.png|semmoldura|center|800px]]

<br>
<div align="justify">
Após informar os destinatários e os demais dados da mensagem, basta selecionar '''Enviar'''. A análise gerada será encaminhada como um arquivo em anexo.

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
</div>

==Configurações==
O ícone de engrenagem, localizado no canto superior direito da página, reúne recursos de informação e gerenciamento. As opções disponíveis são:
* '''Respostas com áudio:''' quando ativado, as respostas da Cia são narradas em voz alta.
* '''Ambiente atual do CIGAM:''' exibe na tela o usuário logado e o ambiente em uso.
* '''Ver consumo:''' mostra a quantidade de tokens já utilizados e os usuários que geraram consumo.
* '''Limpar dados de navegação:''' exibe uma mensagem explicando como limpar os dados de navegação do navegador.
* '''Limpar cookies:''' apaga os dados armazenados localmente, permitindo informar novamente a API e realizar um novo login.
* '''Instalar aplicativo:''' instala a Cia como aplicativo no dispositivo, criando um atalho na tela inicial.
* '''Documentação na wiki:''' direciona para a documentação da Cia na CIGAM Wiki.
* '''Sair:''' encerra a sessão do usuário, permitindo realizar login com outro usuário.
<br>
[[Imagem:ConfiguracoesCia.png|semmoldura|center|500px]]
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, além do acesso à Cia Web pelo menu de mosaico, estão disponíveis recursos de IA que atuam diretamente nas telas em que você está trabalhando. Esses recursos não exigem parametrização e são apresentados de acordo com o contexto da tela.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia Web a partir dos Portais é feito pelo ícone de mosaico, onde está disponível o ícone da Cia - IA do CIGAM.<br>
<br>
[[Imagem:mosaicoCia.png|semmoldura|center|800px]]
<br>
A Cia será aberta de forma integrada, sem a necessidade de novo login, e todas as funcionalidades descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] estarão disponíveis normalmente.<br>

==Geração de conteúdo==
Na barra superior dos Portais está disponível um ícone com um menu de contexto que permite interagir com os '''campos de texto''' de qualquer parte dos Portais. As opções disponíveis permitem melhorar textos, criar conteúdos, revisar a gramática, entre outras ações.<br>
<br>
[[Imagem:comandosCia.png|semmoldura|center|650px]]
<br>
A partir da versão '''Beta 260601''', essas opções passaram a ser exibidas em uma seção separada, chamada '''Geração de conteúdo''', apresentada no mesmo menu em que ficam os agentes.<br>
<br>
[[Imagem:MenuGeracaoConteudoAgentes.png|semmoldura|center|800px]]
<br>
O campo processado é sempre o '''último campo em que o cursor esteve posicionado''' antes de abrir o menu da Cia. Por isso, basta clicar no campo desejado e, em seguida, acionar o menu e escolher o comando.<br>
<br>
Para que o comando seja executado, o campo precisa ser um '''campo de texto válido''' e conter, no mínimo, '''três palavras'''. Caso contrário, será apresentada uma mensagem informando que o conteúdo não atende aos requisitos.<br>
<br>
Após o processamento, o conteúdo gerado é aplicado automaticamente no campo, substituindo o texto anterior, sem necessidade de confirmação.<br>
<br>
Essa funcionalidade também está disponível em telas modais, ou seja, janelas sobrepostas com interações:<br>
<br>
[[Imagem:comandosModalCia.png|semmoldura|center|800px]]
<br>

==Agentes==
A partir da versão '''Beta 260601''', o menu da Cia nos Portais passou a disponibilizar também o acesso aos agentes, tanto nos Portais MVC quanto nos Portais React.<br>
<br>
Ao abrir o menu da Cia, os agentes disponíveis são detectados automaticamente de acordo com a tela que está sendo acessada, ou seja, as opções apresentadas variam conforme a página aberta.<br>
<br>
[[Imagem:MenuAgentesCia.png|semmoldura|center|800px]]
<br>

===Como os agentes são disponibilizados===
A disponibilização de cada agente pode ocorrer de quatro formas:<br>
<br>
* '''Por contexto:''' o agente é apresentado quando a Cia identifica que a tela acessada corresponde ao assunto tratado por ele. Por exemplo, um agente sobre Ordem de Produção será disponibilizado ao acessar uma página cujo contexto seja identificado como Ordem de Produção.
<br>
* '''Por parâmetro:''' o agente é apresentado quando a Cia identifica, na tela, um parâmetro com o valor esperado por ele. Por exemplo, um agente de Pedidos será disponibilizado quando existir na tela um parâmetro que contenha o código do pedido.
<br>
* '''Por contexto e parâmetro:''' o agente é apresentado somente quando as duas condições forem atendidas ao mesmo tempo.
<br>
* '''Sempre disponível:''' o agente é apresentado em qualquer tela, independentemente do contexto ou dos parâmetros.
<br>

===Resultado do processamento===
Após o processamento, o retorno do agente pode ser apresentado de duas formas, conforme o que foi executado:<br>
<br>
* Em uma '''nova guia''' do navegador, quando o agente gera algum conteúdo ou relatório como resultado.
<br>
[[Imagem:AgentesRetornoGuia.png|semmoldura|center|800px]]
<br>
* Em uma '''janela modal''', dentro da própria página em que o usuário está, quando o retorno é uma mensagem.
<br>
[[Imagem:AgentesRetornoModal.png|semmoldura|center|800px]]
<br>
<div align="justify>
A partir da versão '''Beta 261005''', quando o resultado do agente é apresentado em uma nova guia, a página passa a disponibilizar também opções para utilização e compartilhamento da análise.
</div>
<br>
[[Imagem:resultadoAnalise.png|semmoldura|center|800px]]
<br>
<div align="justify">
No cabeçalho são apresentados o nome do agente executado e as opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>
<div align="justify">
=====Compartilhamento por e-mail=====
A janela abaixo é exibida ao quando selecionada a opção '''E-mail''':
</div>
<br>
[[Imagem:modalEmail.png|semmoldura|center|800px]]
<br>
<div align="justify">

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
</div>

==Editor de Agentes==
A partir da versão '''Beta 261005''', o menu passou a disponibilizar o acesso à ferramenta '''Editor de Agentes''', que permite criar seus próprios agentes.<br>
<br>
[[Imagem:EditorAgentesCia.png|semmoldura|center|800px]]
<br>
Ao clicar na opção, será aberta uma página web no formato de assistente (wizard), com cada etapa explicada de forma detalhada. Basta preencher as informações do agente conforme a sua necessidade e avançar pelos passos até a conclusão.<br>
<br>
[[Imagem:EditorAgentesWizard.png|semmoldura|center|800px]]
<br>
Ao final do processo, será gerado um arquivo com a extensão '''.cgagt''', que contém a definição do agente criado.<br>
<br>

===Disponibilizando o agente criado===
Para que o agente passe a ser exibido nos Portais, o arquivo '''.cgagt''' precisa ser colocado na aplicação da API, dentro da pasta raiz da aplicação.<br>
<br>
É necessário que existam as pastas '''Exclusivo''' e, dentro dela, '''Agentes'''. Caso não existam, elas devem ser criadas manualmente. O arquivo deve ser colocado dentro dessa estrutura, ficando da seguinte forma:<br>
<br>
/api/exclusivo/agentes/
<br>
Assim que o arquivo é adicionado nesse local, a Cia passa a reconhecer o agente automaticamente, sem necessidade de qualquer outra configuração. Os agentes customizados são exibidos no menu da Cia nos Portais, em uma seção separada dos agentes padrão.<br>
<br>
[[Imagem:MenuAgentesCustomizados.png|semmoldura|center|800px]]
<br>
==Conversar com documentos==
<div align="justify">
A ferramenta de '''Conversar com documentos''' permite analisar, resumir e cruzar informações contidas em arquivos e relatórios através de modelos avançados de Inteligência Artificial integrados ao ERP CIGAM.

O acesso pode ser realizado a partir da tela principal da Cia Web (SaaS), clicando na opção correspondente ou digitando o assunto <code>#Documentos</code>, momento em que a aplicação é aberta em uma nova guia do navegador assim que digitada a primeira mensagem.

Além disto, podemos acessar a aplicação através dos Portais CIGAM, conforme descrito em [[GE_-_Como_Fazer_-_Cia_-_Como_acessar#Conversar_com_documentos|Como acessar]].

Para a utilização da aplicação, é necessário estar autenticado com um token de autorização CIGAM e com o endereço da API CIGAM devidamente parametrizado. Logo ao abrir, o sistema avalia o ambiente e valida a sessão do usuário em tempo real.

Estando os parâmetros validados, será gerado automaticamente um ID de conversação (''Conversation ID'') exclusivo para a sessão. Esta identificação é armazenada em cookies do navegador com validade de 24 horas, permitindo que a Cia armazene e mantenha o contexto contínuo de todas as mensagens e documentos anexados. Caso a página seja atualizada ou fechada dentro deste período, a sessão conectada e os arquivos são recuperados automaticamente.

<br>
<center>[[Arquivo:cia_conv_docs_01.png|nenhum|750px]]</center>
<br>

No primeiro acesso, é obrigatório marcar a opção '''Termo de consentimento''' para indicar ciência de que os dados e documentos selecionados para análise serão enviados aos modelos de IA de terceiros integrados com a Cia. Por segurança e conformidade, os campos de envio e a área de anexos permanecem bloqueados até que o consentimento seja confirmado. Uma vez aceito, uma mensagem de registro é inserida no histórico da conversa e a preferência é memorizada para a sessão.

Após confirmar o termo, a área de upload no painel lateral esquerdo é habilitada, permitindo anexar múltiplos arquivos simultaneamente, seja arrastando e soltando os documentos sobre a área de dropzone, seja clicando sobre ela para abrir a janela de seleção de arquivos.

A ferramenta suporta uma ampla variedade de formatos corporativos:
*'''Documentos de Texto e Portáteis:''' PDF (<code>.pdf</code>), Texto Simples (<code>.txt</code>), Word (<code>.doc</code>, <code>.docx</code>).
*'''Planilhas e Dados Tabulares:''' Planilhas Excel (<code>.xlsx</code>, <code>.xls</code>), Valores Separados por Vírgula (<code>.csv</code>).
*'''Arquivos de Estrutura de Dados:''' Arquivos <code>.json</code> e <code>.xml</code>.
*'''Imagens:''' Formatos de imagem (<code>.png</code>, <code>.jpg</code>, <code>.jpeg</code>, etc.).

No painel lateral, é possível visualizar o contador total de documentos anexados, o ícone específico do formato, o nome, o tamanho do arquivo formatado e a indicação de que o documento encontra-se ativo no contexto da conversa. Em dispositivos móveis ou telas menores, o painel lateral pode ser recolhido ou expandido através do botão retrátil no topo da barra.

Uma vez enviados para análise, os documentos permanecem registrados no contexto da conversa no servidor, não sendo necessário reenviá-los a cada nova pergunta. Caso deseje substituir ou remover os arquivos analisados, deve-se reiniciar o contexto através da opção de limpeza da conversa.

<br>
<center>[[Arquivo:cia_conv_docs_02.png|nenhum|750px]]</center>
<br>

Clicando no ícone da engrenagem localizado no canto superior direito da tela, temos acesso ao menu de opções e configurações da ferramenta:

*'''Modelo de IA:''' Permite selecionar o modelo de Inteligência Artificial desejado para o processamento documental (ex.: GPT-5.4 Recomendado, GPT-5.4 Mini, GPT-5.2 Alta Precisão, GPT-5.1 Raciocínio, GPT-4.1 Análise Documental, GPT-4o Versátil, GPT-4o Mini Econômico). A lista de modelos é atualizada dinamicamente a partir dos serviços disponíveis na Cia.
*'''Usuário Conectado:''' Exibe os dados do usuário autenticado no ERP CIGAM, incluindo nome, empresa (razão social / fantasia) e código de usuário.
*'''Ambiente & Sessão CIGAM:''' Apresenta o tipo de ambiente (produção ou depuração) e a URL da API CIGAM conectada, acompanhado de um botão de cópia rápida para facilitar diagnósticos e solicitações de suporte técnico.
*'''ID da Conversa Ativa:''' Exibe o identificador único da sessão com indicador visual de status em tempo real e botão para copiar o código do ID diretamente para a área de transferência.
*'''Limpar conversa:''' Permite reiniciar o contexto da conversa. Ao acionar esta opção, um balão interativo de confirmação é apresentado no histórico do chat (com as opções ''Limpar Conversa'' ou ''Cancelar''). Ao confirmar, o sistema solicita a exclusão da conversa no serviço da OpenAI para evitar registros órfãos, remove os documentos e cookies locais e gera um novo ID de conversação limpo.
*'''Documentação na wiki:''' Atalho que direciona diretamente aos manuais e guias de uso na CIGAM Wiki.

<br>
<center>[[Arquivo:cia_conv_docs_03.png|nenhum|750px]]</center>
<br>

Com os documentos anexados, podemos enviar perguntas e comandos no campo inferior para obter resumos executivos, explicações pontuais, cruzamento de dados entre arquivos distintos, localização de inconsistências ou extração de indicadores. Caso enviemos os arquivos sem digitar nenhuma mensagem complementar, a Cia aplicará o prompt de sistema padrão para realizar uma leitura analítica e retornar um resumo estruturado dos documentos.

O sistema dispõe de diretrizes de sistema corporativas (''System Prompt'') integradas ao ecossistema do ERP CIGAM, orientando o modelo a analisar com fidelidade os dados fornecidos, sem inventar informações ausentes.

Também é disponibilizado o recurso de '''Reconhecimento de Voz''' através do ícone de microfone (habilitado em conexões seguras HTTPS ou localhost). O recurso conta com reconhecimento inteligente de pontuação falada: ao ditar expressões como ''"vírgula"'', ''"ponto"'', ''"ponto e vírgula"'', ''"dois pontos"'', ''"interrogação"'', ''"exclamação"'', ''"hífen"'', ''"abre parênteses"'', ''"fecha parênteses"'' ou ''"nova linha"'', os termos são automaticamente substituídos pelos respectivos sinais gráficos e as frases são capitalizadas de forma automática.

<br>
<center>[[Arquivo:cia_conv_docs_04.png|nenhum|750px]]</center>
<br>

As respostas retornadas pela Cia contam com formatação Markdown avançada, estruturando o conteúdo em títulos hierárquicos, listas ordenadas ou em tópicos, citações em bloco e tabelas responsivas estilizadas.

Além disso, sempre que a análise envolver dados numéricos comparativos, demonstrativos contábeis/financeiros (como DRE, receitas e despesas), séries temporais ou valores tabulares, a Cia gera automaticamente gráficos visuais e interativos integrados diretamente na resposta:
*'''Tipos de Gráficos Gerados:''' Barras verticais, linhas de tendência, gráficos de pizza e rosca, estilizados na paleta de cores oficial da Cia e com valores numéricos formatados no padrão brasileiro (pt-BR).
*'''Exportação do Gráfico:''' Cada card de gráfico possui um botão de download no canto superior direito, permitindo baixar a imagem em formato PNG em alta resolução para inclusão imediata em relatórios, apresentações ou envio por e-mail.

<br>
<center>[[Arquivo:cia_conv_docs_05.png|nenhum|750px]]</center>
<br>

Podemos manter uma conversa contínua com diversos documentos e mensagens em múltiplos turnos de diálogo. A Cia preserva o histórico de perguntas e respostas anteriores, permitindo aprofundar análises, solicitar detalhamentos de itens específicos ou anexar novos arquivos complementares ao longo da conversa.

</div>
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, além do acesso rápido à Cia Web, algumas ferramentas do sistema disponibilizam o recurso "Analisar com a Cia".<br>

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM), disponível no menu lateral do Desktop, abre a Cia Web de forma integrada ao sistema, em uma janela do próprio CIGAM.<br>
<br>
Desde que as configurações necessárias tenham sido aplicadas, conforme [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Acesso rápido à Cia Web (SaaS)|Acesso rápido à Cia Web (SaaS)]], '''todas as funcionalidades da Cia Web estarão disponíveis normalmente''', da mesma forma que no acesso pelo navegador. Para conhecê-las, consulte a seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] desta documentação.<br>
<br>
[[Imagem:CiaAbertaDesktop.png|semmoldura|center|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''' está disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída. Em todas elas, o comportamento é o mesmo: a Cia analisa o conteúdo que está em uso na tela e gera um relatório com o resultado da análise, apresentado em uma nova página.<br>
<br>
Ao acionar a opção, o fluxo é o seguinte:<br>
<br>
'''1. Confirmação dos termos de uso'''<br>
Antes de qualquer envio, será exibida uma mensagem solicitando que o usuário concorde com o envio das informações para análise. Os dados enviados seguem as diretrizes de segurança, privacidade e não retenção descritas em [[#Recursos, configurações e segurança|Recursos, configurações e segurança]].<br>
<br>
[[Imagem:AnalisarCiaTermos.png|semmoldura|center|500px]]
<br>
'''2. Complemento do prompt (opcional)'''<br>
Em seguida, será apresentada uma caixa de texto para que o usuário complemente a solicitação, orientando a análise para algum ponto específico. O preenchimento é opcional e pode ser deixado em branco.<br>
<br>
Essa caixa de texto serve apenas para complementar o prompt base que a Cia monta automaticamente, e não altera o conteúdo que está sendo enviado. O recurso considera que o usuário já filtrou os dados na própria tela do CIGAM antes de acionar a análise. O prompt base é mantido oculto por ser extenso e técnico, evitando que o usuário precise conferi-lo a cada utilização.<br>
<br>
[[Imagem:AnalisarCiaPrompt.png|semmoldura|center|700px]]
<br>
'''3. Geração do relatório'''<br>
Após a confirmação, a Cia processa o conteúdo e apresenta o relatório em uma nova página flutuante, com a análise dos dados enviados.<br>
<br>
O próprio relatório informa a quantidade de dados que foi analisada, permitindo que o usuário veja o volume aproximado considerado e identifique se o conteúdo enviado corresponde ao que esperava.<br>
<br>
[[Imagem:AnalisarCiaRelatorio.png|semmoldura|center|700px]]
<br>

A partir da versão '''Beta 261005''', o resultado da análise passa a ser apresentado em uma nova janela flutuante, que disponibiliza opções para utilização e compartilhamento do conteúdo gerado.<br>
<br>
No cabeçalho dessa janela, são apresentados o título da análise e três opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.

<br>
[[Imagem:AnalisarCiaDesktopCompartilhar.png|semmoldura|center|800px]]
<br>

====Compartilhamento por e-mail====

Ao selecionar a opção '''E-mail''', é apresentada uma janela para preenchimento das informações necessárias ao envio da análise.<br>
<br>
[[Imagem:AnalisarCiaDesktopEmail.png|semmoldura|center|700px]]
<br>
Após informar os destinatários e os demais dados da mensagem, basta selecionar '''Enviar'''. A análise gerada será encaminhada como um arquivo em anexo.<br>
<br>

===Limite de conteúdo enviado===
Existe um limite para o volume de conteúdo enviado em cada análise, que varia conforme a versão do ambiente:<br>
<br>
* '''150 KB''' — desde a disponibilização do recurso, na versão '''250505.a'''.
* '''3 MB''' — a partir das patches '''250505.i''' e '''251103.a''', e da versão '''RC 260504'''.
<br>
Quando o conteúdo selecionado ultrapassa esse limite, a Cia exibe uma mensagem informando o tamanho excedido e a análise não é processada, ou seja, nenhum relatório será gerado.<br>
<br>
[[Imagem:AnalisarCiaLimite.png|semmoldura|center|600px]]
<br>
'''Esse limite não é parametrizável e não se trata de uma restrição imposta pela CIGAM.''' Ele decorre da própria capacidade dos modelos de IA integrados à Cia, que possuem um limite técnico de volume de dados que conseguem processar em uma única análise. Quando esse volume é ultrapassado, os modelos passam a analisar as informações por amostragem — ou seja, mesmo que fosse permitido enviar uma quantidade maior de dados, o modelo não analisaria todo o conteúdo, e o resultado seria menos preciso. O limite adotado pela Cia acompanha essa característica dos modelos e assegura que a análise seja feita sobre os dados completos.<br>
<br>
Além da qualidade da análise, há também a questão do tempo de processamento: quanto maior o volume enviado, maior o tempo de resposta do modelo, tornando a espera inviável para o uso no dia a dia.<br>
<br>
Por isso, o recurso foi feito para ser simples e direto: analisar, com um clique, os dados que o usuário já está visualizando pelos meios tradicionais do CIGAM, como grids filtrados e relatórios. Em ambientes com grande volume de dados, a prática recomendada é '''filtrar e consolidar as informações na própria tela antes de acionar a análise''', reduzindo o período ou o escopo consultado. Para análises de períodos maiores, recomenda-se utilizar dados já consolidados, como totalizadores e relatórios sintéticos, em vez de listagens analíticas completas.<br>
<br>
A CIGAM está trabalhando em outras ferramentas que, por processarem os dados de forma diferente, permitirão trabalhar com volumes maiores de informação.<br>

Para saber como acessar o recurso em cada ferramenta, consulte: [[GE - Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Configuração da Cia IA do CIGAM]]

GE - Como Fazer - Uso da Cia - IA do CIGAM

2026-10-15T18:17:03Z

Vinicius.moder: /* Recurso "Analisar com a Cia" */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como_Fazer_Utilidades/Diversos_6]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer - Uso da Cia - IA do CIGAM]]

=Recursos, configurações e segurança=
A Cia - IA do CIGAM oferece diversas funcionalidades e atua como um hub centralizador para os recursos de inteligência artificial utilizados nas soluções CIGAM. Para garantir o correto funcionamento desses recursos, é necessário verificar se os pré-requisitos e as configurações foram realizados adequadamente. Para mais informações, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM|Como Fazer configuração da Cia IA do CIGAM]]
<br><br>
Todas as soluções de IA do CIGAM são integradas por meio dos serviços da Cia. A Cia possui integração com diferentes provedores de IA de terceiros, como OpenAI, Google, Anthropic, entre outros. Essas integrações são realizadas por meio de contas e serviços contratados, com condições de uso que asseguram que os dados trafegados não sejam utilizados para treinamento dos modelos, identificação de origem, publicidade, anúncios ou qualquer outra finalidade não prevista.
<br><br>
No caso de IAs open-source integradas à Cia, os modelos são executados dentro dos domínios da CIGAM, mantendo as mesmas premissas aplicadas às IAs contratadas: não utilização dos dados para treinamento de modelos, não identificação da origem das informações e ausência de retenção dos dados processados.
<br><br>
Além disso, sempre que houver envio explícito de dados pelo usuário por meio das funcionalidades da Cia disponíveis nas soluções CIGAM, será apresentado um diálogo de confirmação, permitindo que o usuário aceite o envio dessas informações. Os dados enviados serão tratados conforme as mesmas diretrizes de segurança, privacidade e não retenção descritas anteriormente.
<br><br>
Esta documentação apresenta o uso da Cia e está organizada conforme a forma de acesso: [[#Cia Web (SaaS)|Cia Web (SaaS)]], [[#Portais|Portais]] e [[#Desktop|Desktop]].
<br><br>
Caso tenha dúvidas sobre onde encontrar a Cia em cada uma dessas plataformas, ou sobre quais ferramentas do CIGAM possuem recursos integrados a ela, consulte a documentação específica de acesso: [[GE - Como Fazer - Cia - Como acessar|Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Cia Web (SaaS)=
A Cia Web é a aplicação web que centraliza todas as funcionalidades da Cia. Ela pode ser acessada diretamente pelo navegador do seu computador ou dispositivo móvel, ou ainda a partir do Desktop e dos Portais, sem a necessidade de novo login.
<br><br>

<center><youtube>https://youtu.be/DFGtRtPF75A</youtube></center>
<br>

==Primeiro acesso==
A Cia Web pode ser acessada diretamente pelo navegador, utilizando o seguinte endereço: https://services.cigam.cloud/cia/index.html
<br><br>
'''Importante:''' o usuário que for realizar o login precisa ter a autenticação em duas etapas habilitada. Para saber como configurá-la, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]]
<br><br>
Ao acessar pelo endereço, será necessário preencher algumas informações para que a Cia consiga validar seu acesso e consultar seus dados:<br>
* Informar a API do seu CIGAM Server, para garantir o direcionamento correto da base de dados.<br><br>

[[Imagem:CiaAPI.png|semmoldura|center|700px]]<br>

* Informar usuário e senha de login e seu código de verificação:<br><br>

[[Imagem:CiaLogin.png|semmoldura|center|700px]]
<br>
[[Imagem:CiaCodVerif.png|semmoldura|center|700px]]<br>

* Caso não queira aguardar ou informar o código de verificação, você pode optar por responder à pergunta secreta, clicando no botão “Pergunta Secreta” exibido na imagem acima.<br><br>

[[Imagem:CiaLoginA2F.png|semmoldura|center|700px]]
<br>

==Conhecendo a tela da Cia==
Após realizar o login, a Cia carregará automaticamente as informações e dados necessários do ambiente e será iniciada no assunto '''#Geral''', identificado pelo botão localizado à esquerda da caixa de texto.

[[Imagem:CiaGeral.png|semmoldura|center|700px]]
<br><br>
Ao clicar nesse botão, será exibida uma lista com todos os assuntos disponíveis, permitindo que você selecione aquele com o qual deseja interagir.<br><br>
Além disso, você pode digitar diretamente na caixa de texto o '''#Assunto''' que deseja utilizar, e a Cia entenderá automaticamente o tema da sua mensagem.<br><br>
Também é possível '''formular uma pergunta seguida de um #Assunto''' para interagir com qualquer assunto, mesmo que ele não esteja selecionado no momento.

[[Imagem:CiaAberta.png|semmoldura|center|700px]]
<br>
Ao selecionar um assunto, serão exibidas automaticamente dicas e sugestões sobre o tema escolhido, além de exemplos clicáveis que, ao serem selecionados, são processados de forma imediata.<br><br>
Além disso, ao digitar um ponto de interrogação (?) na caixa de texto, será exibida uma lista com todas as interações disponíveis para o assunto selecionado, facilitando a descoberta de comandos e possibilidades de uso.

[[Imagem:CiaDicas.png|semmoldura|center|700px]]
<br>
Outra funcionalidade prática é a possibilidade de reenviar perguntas já feitas no chat. Para isso, basta posicionar o mouse sobre a pergunta desejada e clicar no ícone de “Reenviar”. Ao passar o mouse sobre a mensagem, também será exibido o horário de envio.
<br>
[[Imagem:CiaReenviar.png|semmoldura|center|400px]]
<br>
Além disso, você pode utilizar as setas do teclado (⬆️ para cima e ⬇️ para baixo) na caixa de texto para navegar pelas últimas perguntas enviadas para o #Assunto selecionado, facilitando o reuso de interações anteriores.

===Ícones da caixa de texto===
Na caixa de texto, você encontrará alguns ícones com as seguintes funções:

<center>
{| class="wikitable"
|-
! !! Ação
|-
|center|[[Imagem:CiaUltPerg.png]] || '''Histórico de Perguntas''' – Ao clicar, é exibido o histórico das perguntas já realizadas para o assunto selecionado.
|-
|center|[[Imagem:CiaEnviar.png]] || '''Enviar''' – Envia o conteúdo digitado na caixa de texto.
|-
|center|[[Imagem:CiaFala.png]] || '''Falar''' – Permite falar ao invés de digitar, usando o recurso de voz.
|-
|center|[[Imagem:CiaExpandir.png]] || '''Expandir''' – Aumenta a altura da caixa de texto para facilitar a digitação de mensagens longas.
|-
|center|[[Imagem:CiaRecolher.png]] || '''Recolher''' – Reduz a caixa de texto ao tamanho padrão.
|}
</center>
{{VoltarInicio}}

==Assuntos disponíveis==

===Geral===
Nesse assunto, é possível conversar livremente com a Cia sobre qualquer um dos assuntos disponíveis. Se encontrar dificuldades para obter a resposta desejada, experimente selecionar um assunto específico, o que pode gerar resultados mais precisos.<br><br>
Se houver muitas respostas correspondentes, a Cia não executará nenhuma automaticamente. Em vez disso, exibirá uma opção com os valores possíveis, permitindo que você selecione manualmente a melhor alternativa.

[[Imagem:CiaGeralOpcoes.png|semmoldura|center|700px]]
<br>
Caso a Cia encontre uma resposta com confiança significativamente maior que as demais, ela será executada automaticamente.
<br><br>
No entanto, se você selecionar a opção “Não era bem isso o que eu queria”, a Cia exibirá outras opções relacionadas ao que foi solicitado, apresentando também um indicador de semáforo com a porcentagem de confiança de cada alternativa.

[[Imagem:CiaGeralOpcaoCerta.png|semmoldura|center|600px]]

===Ajuda, Vídeos e Auditor===
Conheça melhor o ERP com a ajuda da Wiki e Cia, assista vídeos sobre o CIGAM e audite seu ambiente.

====Ajuda====
Nesse assunto, você pode acessar o Chatbot da assistente virtual, onde você pode tirar dúvidas e consultar conteúdos da CIGAM Wiki enviando perguntas diretamente nela.<br>
<br>
'''Importante:''' neste assunto, a Cia atua dedicada à Wiki, focada exclusivamente nos conteúdos da documentação. As demais funcionalidades e atalhos da Cia não estarão disponíveis nesse contexto.

====Vídeos====
Nesse assunto, é possível procurar por vídeos relacionados ao tema desejado. O resultado será apresentado em forma de lista, contendo os vídeos encontrados e os tempos exatos em que o assunto começa a ser abordado, de acordo com o termo ou palavra pesquisada.

====Auditor====
Neste assunto, é possível verificar o status do sistema e identificar possíveis problemas ou inconsistências. O resultado será exibido em forma de tabela, contendo os dados retornados para facilitar a análise.

===Painéis BI, Portais e Relatórios===
Explore dashboards do BI, interaja com Portais intuitivos e execute relatórios personalizados.

====Painéis BI====
Nesse assunto, é possível abrir dashboards do BI já configurados para o usuário, permitindo sua visualização diretamente na tela.
Ao abrir um dashboard, você também pode interagir com ele, solicitando inserção de filtros, dimensões, métricas, transformações e outros ajustes.<br>
Cada dashboard aberto exibirá uma guia com as “Interações” disponíveis para aquele painel específico.
<br><br>
Além disso, ao selecionar o assunto '''#Painéis do BI''', é possível solicitar que a Cia crie um dashboard do zero.
Por exemplo: "Crie um dashboard para ver meu fluxo de caixa". Você pode ainda solicitar que métricas, dimensões e filtros sejam adicionados durante a criação, ou pedir dashboards separados por áreas.
<br><br>
'''Importante:''' caso o usuário não possua acesso ao BI ou este não esteja implementado na base de dados, será exibida uma mensagem informativa no momento do login na Cia.

====Portais====
Quando este assunto é utilizado, o resultado será sempre a abertura de uma tela dos Portais, permitindo ao usuário acessar diretamente os conteúdos e funcionalidades disponíveis nesse ambiente.
<br><br>
Essa abertura é feita de forma integrada, garantindo uma navegação contínua entre a Cia e os Portais, sem necessidade de realizar novo login ou sair da plataforma.

====Relatórios====
Ao utilizar esse assunto, será exibida uma tela para preenchimento de filtros, permitindo a emissão de relatórios web.
<br><br>
Para que essa funcionalidade opere corretamente, é necessário garantir que a instalação da CDN e da Pesquisa Dinâmica no servidor de aplicação esteja configurada de forma adequada.
<br><br>
Os relatórios exibidos aqui são os mesmos disponíveis nos Portais CIGAM, portanto é essencial que esses componentes também estejam funcionando corretamente nesses Portais.

===Qual, Faça, Consultar, Listar, Analisar e Insights===
Crie registros, analise informações ou liste dados cadastrados no CIGAM.

====Qual====
Nesse assunto, a Cia vai consultar e processar informações diretamente no ERP, usando os dados e relacionamentos disponíveis no CIGAM, e retornar os resultados em forma de texto para você visualizar.
<br><br>
'''Importante:''' nem todas as opções estão liberadas. Para ver quais você pode usar, digite ? na caixa de texto. A Cia vai mostrar uma lista com todos os comandos e funções disponíveis.

====Faça====
Nesse assunto, a Cia sempre fará um processamento no CIGAM e retornará o status do resultado. Por exemplo, você pode solicitar que a Cia crie um alerta ou até mesmo crie uma nova empresa no sistema.
<br><br>
'''Dica:''' para saber quais treinamentos ou comandos estão disponíveis, digite ? na caixa de texto. A Cia mostrará uma lista com todas as opções implementadas para você usar.

====Consultar====
Nesse assunto, você poderá fazer consultas de dados para obter listagens de registros, conforme os treinamentos de tabelas disponíveis. O resultado será apresentado em forma de tabela, exibindo os dados retornados. Já existem diversas Views prontas, para que você possa listar informações de forma mais completa e rápida.
<br><br>
'''Dica:''' para ver exemplos de consultas já implementadas, digite ? na caixa de texto.

====Listar====
Nesse assunto, você pode montar sua própria consulta de dados, escolhendo os filtros e parâmetros para gerar uma listagem personalizada. Diferente do assunto #Consultar, aqui é possível utilizar qualquer tabela do CIGAM para montar sua consulta, escrevendo em linguagem natural o que deseja buscar.
<br><br>
'''Dica:''' para ver todas as tabelas disponíveis, digite ? na caixa de texto.

====Analisar====
Analise o arquivo selecionado para gerar gráficos interativos e informativos, apresentando insights relevantes que ajudam a identificar tendências, padrões e oportunidades de melhoria.
<br><br>
Esse recurso oferece uma visualização clara e intuitiva dos dados, facilitando a interpretação das informações e apoiando a tomada de decisões estratégicas.
<br><br>
'''Aviso:''' para utilizar esta funcionalidade, é necessário concordar que os dados enviados serão processados por modelos de IA de terceiros integrados à Cia.

[[Imagem:AnalisarCia.png|semmoldura|center|600px]]

====Insights====
Gere insights inteligentes a partir dos dados de uma consulta, com análises automáticas realizadas pela Cia, que identificam padrões, tendências e possíveis pontos de atenção. Esse recurso ajuda a transformar dados brutos em informações acionáveis, facilitando a tomada de decisões estratégicas e otimizando processos.
<br><br>
'''Aviso:''' ao utilizar o assunto “Insights”, você concorda que os dados e informações analisados poderão ser enviados para modelos de IA de terceiros integrados à Cia, exclusivamente para processamento e geração dos resultados apresentados.

===IA Generativa e Pesquisa na Internet===
Converse com a IA sobre assuntos diversos, crie conteúdos e pesquise na internet sobre qualquer coisa.

====IA Generativa====
Nesse assunto, ao interagir com a IA Generativa, você poderá fazer qualquer tipo de pergunta ou solicitação, de forma livre e criativa.
O resultado exibido será exatamente a resposta gerada pela IA, sem complementos da Cia. Você pode, por exemplo, solicitar que a IA melhore ou reformule um texto, crie conteúdos ou resuma informações.
<br><br>
'''Importante:''' nesse assunto, a Cia não estará integrada aos serviços e sistemas do CIGAM — a interação é exclusivamente com a IA Generativa.

====Pesquisa na Internet====
Use esse assunto para fazer pesquisas na internet e visualizar os resultados diretamente integrados na Cia, sem precisar sair da plataforma. Você pode pesquisar qualquer tema de interesse e abrir os links retornados para acessar conteúdos, notícias e informações de forma rápida e prática.
{{VoltarInicio}}

===Compartilhamento de Análises da Cia===

<br>
<div align="justify">
Na Cia Web (SaaS), é possível gerar análises detalhadas de determinadas informações e compartilhá-las. Essa funcionalidade está disponível nos seguintes assuntos: [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Auditor|Auditor]], [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Analisar|Analisar]], [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Insights|Insights]], [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Listar|Listar]] e [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Consultar|Consultar]].
</div>
<br>

[[Image: opcoesAnalisarCia.png|semmoldura|center|800px]]

<br>
<div align="justify">
Essa opção está disponível por meio do botão '''analisar''', exibido junto à resposta apresentada após a solicitação de um desses assuntos.
</div>
<br>

[[Image: exemploBotaoAnalisar.png|semmoldura|center|800px]]

<br>
<div align="justify">
Particularmente para o assunto '''Analisar''', a análise já é exibida diretamente, pois essa é a finalidade desse assunto:
</div>
<br>

[[Image: analiseAnalisar.png|semmoldura|center|800px]]

<br>
<div align="justify">
Ao gerar uma análise , a página de resultado passa a disponibilizar opções para compartilhar e utilizar o conteúdo gerado. São disponibilizadas três opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>
<br>

[[Image: CiaWebAnalise.png|semmoldura|center|800px]]

=====Compartilhamento por e-mail=====

<div align="justify">
Ao selecionar a opção '''E-mail''', é apresentada uma janela para preenchimento das informações necessárias ao envio da análise.
</div>
<br>

[[Image: CiaWebModalEmail.png|semmoldura|center|800px]]

<br>
<div align="justify">
Após informar os destinatários e os demais dados da mensagem, basta selecionar '''Enviar'''. A análise gerada será encaminhada como um arquivo em anexo.

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
</div>

==Configurações==
O ícone de engrenagem, localizado no canto superior direito da página, reúne recursos de informação e gerenciamento. As opções disponíveis são:
* '''Respostas com áudio:''' quando ativado, as respostas da Cia são narradas em voz alta.
* '''Ambiente atual do CIGAM:''' exibe na tela o usuário logado e o ambiente em uso.
* '''Ver consumo:''' mostra a quantidade de tokens já utilizados e os usuários que geraram consumo.
* '''Limpar dados de navegação:''' exibe uma mensagem explicando como limpar os dados de navegação do navegador.
* '''Limpar cookies:''' apaga os dados armazenados localmente, permitindo informar novamente a API e realizar um novo login.
* '''Instalar aplicativo:''' instala a Cia como aplicativo no dispositivo, criando um atalho na tela inicial.
* '''Documentação na wiki:''' direciona para a documentação da Cia na CIGAM Wiki.
* '''Sair:''' encerra a sessão do usuário, permitindo realizar login com outro usuário.
<br>
[[Imagem:ConfiguracoesCia.png|semmoldura|center|500px]]
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, além do acesso à Cia Web pelo menu de mosaico, estão disponíveis recursos de IA que atuam diretamente nas telas em que você está trabalhando. Esses recursos não exigem parametrização e são apresentados de acordo com o contexto da tela.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia Web a partir dos Portais é feito pelo ícone de mosaico, onde está disponível o ícone da Cia - IA do CIGAM.<br>
<br>
[[Imagem:mosaicoCia.png|semmoldura|center|800px]]
<br>
A Cia será aberta de forma integrada, sem a necessidade de novo login, e todas as funcionalidades descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] estarão disponíveis normalmente.<br>

==Geração de conteúdo==
Na barra superior dos Portais está disponível um ícone com um menu de contexto que permite interagir com os '''campos de texto''' de qualquer parte dos Portais. As opções disponíveis permitem melhorar textos, criar conteúdos, revisar a gramática, entre outras ações.<br>
<br>
[[Imagem:comandosCia.png|semmoldura|center|650px]]
<br>
A partir da versão '''Beta 260601''', essas opções passaram a ser exibidas em uma seção separada, chamada '''Geração de conteúdo''', apresentada no mesmo menu em que ficam os agentes.<br>
<br>
[[Imagem:MenuGeracaoConteudoAgentes.png|semmoldura|center|800px]]
<br>
O campo processado é sempre o '''último campo em que o cursor esteve posicionado''' antes de abrir o menu da Cia. Por isso, basta clicar no campo desejado e, em seguida, acionar o menu e escolher o comando.<br>
<br>
Para que o comando seja executado, o campo precisa ser um '''campo de texto válido''' e conter, no mínimo, '''três palavras'''. Caso contrário, será apresentada uma mensagem informando que o conteúdo não atende aos requisitos.<br>
<br>
Após o processamento, o conteúdo gerado é aplicado automaticamente no campo, substituindo o texto anterior, sem necessidade de confirmação.<br>
<br>
Essa funcionalidade também está disponível em telas modais, ou seja, janelas sobrepostas com interações:<br>
<br>
[[Imagem:comandosModalCia.png|semmoldura|center|800px]]
<br>

==Agentes==
A partir da versão '''Beta 260601''', o menu da Cia nos Portais passou a disponibilizar também o acesso aos agentes, tanto nos Portais MVC quanto nos Portais React.<br>
<br>
Ao abrir o menu da Cia, os agentes disponíveis são detectados automaticamente de acordo com a tela que está sendo acessada, ou seja, as opções apresentadas variam conforme a página aberta.<br>
<br>
[[Imagem:MenuAgentesCia.png|semmoldura|center|800px]]
<br>

===Como os agentes são disponibilizados===
A disponibilização de cada agente pode ocorrer de quatro formas:<br>
<br>
* '''Por contexto:''' o agente é apresentado quando a Cia identifica que a tela acessada corresponde ao assunto tratado por ele. Por exemplo, um agente sobre Ordem de Produção será disponibilizado ao acessar uma página cujo contexto seja identificado como Ordem de Produção.
<br>
* '''Por parâmetro:''' o agente é apresentado quando a Cia identifica, na tela, um parâmetro com o valor esperado por ele. Por exemplo, um agente de Pedidos será disponibilizado quando existir na tela um parâmetro que contenha o código do pedido.
<br>
* '''Por contexto e parâmetro:''' o agente é apresentado somente quando as duas condições forem atendidas ao mesmo tempo.
<br>
* '''Sempre disponível:''' o agente é apresentado em qualquer tela, independentemente do contexto ou dos parâmetros.
<br>

===Resultado do processamento===
Após o processamento, o retorno do agente pode ser apresentado de duas formas, conforme o que foi executado:<br>
<br>
* Em uma '''nova guia''' do navegador, quando o agente gera algum conteúdo ou relatório como resultado.
<br>
[[Imagem:AgentesRetornoGuia.png|semmoldura|center|800px]]
<br>
* Em uma '''janela modal''', dentro da própria página em que o usuário está, quando o retorno é uma mensagem.
<br>
[[Imagem:AgentesRetornoModal.png|semmoldura|center|800px]]
<br>
<div align="justify>
A partir da versão '''Beta 261005''', quando o resultado do agente é apresentado em uma nova guia, a página passa a disponibilizar também opções para utilização e compartilhamento da análise.
</div>
<br>
[[Imagem:resultadoAnalise.png|semmoldura|center|800px]]
<br>
<div align="justify">
No cabeçalho são apresentados o nome do agente executado e as opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>
<div align="justify">
=====Compartilhamento por e-mail=====
A janela abaixo é exibida ao quando selecionada a opção '''E-mail''':
</div>
<br>
[[Imagem:modalEmail.png|semmoldura|center|800px]]
<br>
<div align="justify">

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
</div>

==Editor de Agentes==
A partir da versão '''Beta 261005''', o menu passou a disponibilizar o acesso à ferramenta '''Editor de Agentes''', que permite criar seus próprios agentes.<br>
<br>
[[Imagem:EditorAgentesCia.png|semmoldura|center|800px]]
<br>
Ao clicar na opção, será aberta uma página web no formato de assistente (wizard), com cada etapa explicada de forma detalhada. Basta preencher as informações do agente conforme a sua necessidade e avançar pelos passos até a conclusão.<br>
<br>
[[Imagem:EditorAgentesWizard.png|semmoldura|center|800px]]
<br>
Ao final do processo, será gerado um arquivo com a extensão '''.cgagt''', que contém a definição do agente criado.<br>
<br>

===Disponibilizando o agente criado===
Para que o agente passe a ser exibido nos Portais, o arquivo '''.cgagt''' precisa ser colocado na aplicação da API, dentro da pasta raiz da aplicação.<br>
<br>
É necessário que existam as pastas '''Exclusivo''' e, dentro dela, '''Agentes'''. Caso não existam, elas devem ser criadas manualmente. O arquivo deve ser colocado dentro dessa estrutura, ficando da seguinte forma:<br>
<br>
/api/exclusivo/agentes/
<br>
Assim que o arquivo é adicionado nesse local, a Cia passa a reconhecer o agente automaticamente, sem necessidade de qualquer outra configuração. Os agentes customizados são exibidos no menu da Cia nos Portais, em uma seção separada dos agentes padrão.<br>
<br>
[[Imagem:MenuAgentesCustomizados.png|semmoldura|center|800px]]
<br>
==Conversar com documentos==
<div align="justify">
A ferramenta de '''Conversar com documentos''' permite analisar, resumir e cruzar informações contidas em arquivos e relatórios através de modelos avançados de Inteligência Artificial integrados ao ERP CIGAM.

O acesso pode ser realizado a partir da tela principal da Cia Web (SaaS), clicando na opção correspondente ou digitando o assunto <code>#Documentos</code>, momento em que a aplicação é aberta em uma nova guia do navegador assim que digitada a primeira mensagem.

Além disto, podemos acessar a aplicação através dos Portais CIGAM, conforme descrito em [[GE_-_Como_Fazer_-_Cia_-_Como_acessar#Conversar_com_documentos|Como acessar]].

Para a utilização da aplicação, é necessário estar autenticado com um token de autorização CIGAM e com o endereço da API CIGAM devidamente parametrizado. Logo ao abrir, o sistema avalia o ambiente e valida a sessão do usuário em tempo real.

Estando os parâmetros validados, será gerado automaticamente um ID de conversação (''Conversation ID'') exclusivo para a sessão. Esta identificação é armazenada em cookies do navegador com validade de 24 horas, permitindo que a Cia armazene e mantenha o contexto contínuo de todas as mensagens e documentos anexados. Caso a página seja atualizada ou fechada dentro deste período, a sessão conectada e os arquivos são recuperados automaticamente.

<br>
<center>[[Arquivo:cia_conv_docs_01.png|nenhum|750px]]</center>
<br>

No primeiro acesso, é obrigatório marcar a opção '''Termo de consentimento''' para indicar ciência de que os dados e documentos selecionados para análise serão enviados aos modelos de IA de terceiros integrados com a Cia. Por segurança e conformidade, os campos de envio e a área de anexos permanecem bloqueados até que o consentimento seja confirmado. Uma vez aceito, uma mensagem de registro é inserida no histórico da conversa e a preferência é memorizada para a sessão.

Após confirmar o termo, a área de upload no painel lateral esquerdo é habilitada, permitindo anexar múltiplos arquivos simultaneamente, seja arrastando e soltando os documentos sobre a área de dropzone, seja clicando sobre ela para abrir a janela de seleção de arquivos.

A ferramenta suporta uma ampla variedade de formatos corporativos:
*'''Documentos de Texto e Portáteis:''' PDF (<code>.pdf</code>), Texto Simples (<code>.txt</code>), Word (<code>.doc</code>, <code>.docx</code>).
*'''Planilhas e Dados Tabulares:''' Planilhas Excel (<code>.xlsx</code>, <code>.xls</code>), Valores Separados por Vírgula (<code>.csv</code>).
*'''Arquivos de Estrutura de Dados:''' Arquivos <code>.json</code> e <code>.xml</code>.
*'''Imagens:''' Formatos de imagem (<code>.png</code>, <code>.jpg</code>, <code>.jpeg</code>, etc.).

No painel lateral, é possível visualizar o contador total de documentos anexados, o ícone específico do formato, o nome, o tamanho do arquivo formatado e a indicação de que o documento encontra-se ativo no contexto da conversa. Em dispositivos móveis ou telas menores, o painel lateral pode ser recolhido ou expandido através do botão retrátil no topo da barra.

Uma vez enviados para análise, os documentos permanecem registrados no contexto da conversa no servidor, não sendo necessário reenviá-los a cada nova pergunta. Caso deseje substituir ou remover os arquivos analisados, deve-se reiniciar o contexto através da opção de limpeza da conversa.

<br>
<center>[[Arquivo:cia_conv_docs_02.png|nenhum|750px]]</center>
<br>

Clicando no ícone da engrenagem localizado no canto superior direito da tela, temos acesso ao menu de opções e configurações da ferramenta:

*'''Modelo de IA:''' Permite selecionar o modelo de Inteligência Artificial desejado para o processamento documental (ex.: GPT-5.4 Recomendado, GPT-5.4 Mini, GPT-5.2 Alta Precisão, GPT-5.1 Raciocínio, GPT-4.1 Análise Documental, GPT-4o Versátil, GPT-4o Mini Econômico). A lista de modelos é atualizada dinamicamente a partir dos serviços disponíveis na Cia.
*'''Usuário Conectado:''' Exibe os dados do usuário autenticado no ERP CIGAM, incluindo nome, empresa (razão social / fantasia) e código de usuário.
*'''Ambiente & Sessão CIGAM:''' Apresenta o tipo de ambiente (produção ou depuração) e a URL da API CIGAM conectada, acompanhado de um botão de cópia rápida para facilitar diagnósticos e solicitações de suporte técnico.
*'''ID da Conversa Ativa:''' Exibe o identificador único da sessão com indicador visual de status em tempo real e botão para copiar o código do ID diretamente para a área de transferência.
*'''Limpar conversa:''' Permite reiniciar o contexto da conversa. Ao acionar esta opção, um balão interativo de confirmação é apresentado no histórico do chat (com as opções ''Limpar Conversa'' ou ''Cancelar''). Ao confirmar, o sistema solicita a exclusão da conversa no serviço da OpenAI para evitar registros órfãos, remove os documentos e cookies locais e gera um novo ID de conversação limpo.
*'''Documentação na wiki:''' Atalho que direciona diretamente aos manuais e guias de uso na CIGAM Wiki.

<br>
<center>[[Arquivo:cia_conv_docs_03.png|nenhum|750px]]</center>
<br>

Com os documentos anexados, podemos enviar perguntas e comandos no campo inferior para obter resumos executivos, explicações pontuais, cruzamento de dados entre arquivos distintos, localização de inconsistências ou extração de indicadores. Caso enviemos os arquivos sem digitar nenhuma mensagem complementar, a Cia aplicará o prompt de sistema padrão para realizar uma leitura analítica e retornar um resumo estruturado dos documentos.

O sistema dispõe de diretrizes de sistema corporativas (''System Prompt'') integradas ao ecossistema do ERP CIGAM, orientando o modelo a analisar com fidelidade os dados fornecidos, sem inventar informações ausentes.

Também é disponibilizado o recurso de '''Reconhecimento de Voz''' através do ícone de microfone (habilitado em conexões seguras HTTPS ou localhost). O recurso conta com reconhecimento inteligente de pontuação falada: ao ditar expressões como ''"vírgula"'', ''"ponto"'', ''"ponto e vírgula"'', ''"dois pontos"'', ''"interrogação"'', ''"exclamação"'', ''"hífen"'', ''"abre parênteses"'', ''"fecha parênteses"'' ou ''"nova linha"'', os termos são automaticamente substituídos pelos respectivos sinais gráficos e as frases são capitalizadas de forma automática.

<br>
<center>[[Arquivo:cia_conv_docs_04.png|nenhum|750px]]</center>
<br>

As respostas retornadas pela Cia contam com formatação Markdown avançada, estruturando o conteúdo em títulos hierárquicos, listas ordenadas ou em tópicos, citações em bloco e tabelas responsivas estilizadas.

Além disso, sempre que a análise envolver dados numéricos comparativos, demonstrativos contábeis/financeiros (como DRE, receitas e despesas), séries temporais ou valores tabulares, a Cia gera automaticamente gráficos visuais e interativos integrados diretamente na resposta:
*'''Tipos de Gráficos Gerados:''' Barras verticais, linhas de tendência, gráficos de pizza e rosca, estilizados na paleta de cores oficial da Cia e com valores numéricos formatados no padrão brasileiro (pt-BR).
*'''Exportação do Gráfico:''' Cada card de gráfico possui um botão de download no canto superior direito, permitindo baixar a imagem em formato PNG em alta resolução para inclusão imediata em relatórios, apresentações ou envio por e-mail.

<br>
<center>[[Arquivo:cia_conv_docs_05.png|nenhum|750px]]</center>
<br>

Podemos manter uma conversa contínua com diversos documentos e mensagens em múltiplos turnos de diálogo. A Cia preserva o histórico de perguntas e respostas anteriores, permitindo aprofundar análises, solicitar detalhamentos de itens específicos ou anexar novos arquivos complementares ao longo da conversa.

</div>
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, além do acesso rápido à Cia Web, algumas ferramentas do sistema disponibilizam o recurso "Analisar com a Cia".<br>

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM), disponível no menu lateral do Desktop, abre a Cia Web de forma integrada ao sistema, em uma janela do próprio CIGAM.<br>
<br>
Desde que as configurações necessárias tenham sido aplicadas, conforme [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Acesso rápido à Cia Web (SaaS)|Acesso rápido à Cia Web (SaaS)]], '''todas as funcionalidades da Cia Web estarão disponíveis normalmente''', da mesma forma que no acesso pelo navegador. Para conhecê-las, consulte a seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] desta documentação.<br>
<br>
[[Imagem:CiaAbertaDesktop.png|semmoldura|center|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''' está disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída. Em todas elas, o comportamento é o mesmo: a Cia analisa o conteúdo que está em uso na tela e gera um relatório com o resultado da análise, apresentado em uma nova página.<br>
<br>
Ao acionar a opção, o fluxo é o seguinte:<br>
<br>
'''1. Confirmação dos termos de uso'''<br>
Antes de qualquer envio, será exibida uma mensagem solicitando que o usuário concorde com o envio das informações para análise. Os dados enviados seguem as diretrizes de segurança, privacidade e não retenção descritas em [[#Recursos, configurações e segurança|Recursos, configurações e segurança]].<br>
<br>
[[Imagem:AnalisarCiaTermos.png|semmoldura|center|500px]]
<br>
'''2. Complemento do prompt (opcional)'''<br>
Em seguida, será apresentada uma caixa de texto para que o usuário complemente a solicitação, orientando a análise para algum ponto específico. O preenchimento é opcional e pode ser deixado em branco.<br>
<br>
Essa caixa de texto serve apenas para complementar o prompt base que a Cia monta automaticamente, e não altera o conteúdo que está sendo enviado. O recurso considera que o usuário já filtrou os dados na própria tela do CIGAM antes de acionar a análise. O prompt base é mantido oculto por ser extenso e técnico, evitando que o usuário precise conferi-lo a cada utilização.<br>
<br>
[[Imagem:AnalisarCiaPrompt.png|semmoldura|center|700px]]
<br>
'''3. Geração do relatório'''<br>
Após a confirmação, a Cia processa o conteúdo e apresenta o relatório em uma nova página flutuante, com a análise dos dados enviados.<br>
<br>
O próprio relatório informa a quantidade de dados que foi analisada, permitindo que o usuário veja o volume aproximado considerado e identifique se o conteúdo enviado corresponde ao que esperava.<br>
<br>
[[Imagem:AnalisarCiaRelatorio.png|semmoldura|center|700px]]
<br>

A partir da versão '''Beta 261005''', o resultado da análise passa a ser apresentado em uma nova janela flutuante, que disponibiliza opções para utilização e compartilhamento do conteúdo gerado.<br>
<br>
No cabeçalho dessa janela, são apresentados o nome do agente executado e três opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.

<br>
[[Imagem:AnalisarCiaDesktopCompartilhar.png|semmoldura|center|800px]]
<br>

====Compartilhamento por e-mail====

Ao selecionar a opção '''E-mail''', é apresentada uma janela para preenchimento das informações necessárias ao envio da análise.<br>
<br>
[[Imagem:AnalisarCiaDesktopEmail.png|semmoldura|center|700px]]
<br>
Após informar os destinatários e os demais dados da mensagem, basta selecionar '''Enviar'''. A análise gerada será encaminhada como um arquivo em anexo.<br>
<br>

===Limite de conteúdo enviado===
Existe um limite para o volume de conteúdo enviado em cada análise, que varia conforme a versão do ambiente:<br>
<br>
* '''150 KB''' — desde a disponibilização do recurso, na versão '''250505.a'''.
* '''3 MB''' — a partir das patches '''250505.i''' e '''251103.a''', e da versão '''RC 260504'''.
<br>
Quando o conteúdo selecionado ultrapassa esse limite, a Cia exibe uma mensagem informando o tamanho excedido e a análise não é processada, ou seja, nenhum relatório será gerado.<br>
<br>
[[Imagem:AnalisarCiaLimite.png|semmoldura|center|600px]]
<br>
'''Esse limite não é parametrizável e não se trata de uma restrição imposta pela CIGAM.''' Ele decorre da própria capacidade dos modelos de IA integrados à Cia, que possuem um limite técnico de volume de dados que conseguem processar em uma única análise. Quando esse volume é ultrapassado, os modelos passam a analisar as informações por amostragem — ou seja, mesmo que fosse permitido enviar uma quantidade maior de dados, o modelo não analisaria todo o conteúdo, e o resultado seria menos preciso. O limite adotado pela Cia acompanha essa característica dos modelos e assegura que a análise seja feita sobre os dados completos.<br>
<br>
Além da qualidade da análise, há também a questão do tempo de processamento: quanto maior o volume enviado, maior o tempo de resposta do modelo, tornando a espera inviável para o uso no dia a dia.<br>
<br>
Por isso, o recurso foi feito para ser simples e direto: analisar, com um clique, os dados que o usuário já está visualizando pelos meios tradicionais do CIGAM, como grids filtrados e relatórios. Em ambientes com grande volume de dados, a prática recomendada é '''filtrar e consolidar as informações na própria tela antes de acionar a análise''', reduzindo o período ou o escopo consultado. Para análises de períodos maiores, recomenda-se utilizar dados já consolidados, como totalizadores e relatórios sintéticos, em vez de listagens analíticas completas.<br>
<br>
A CIGAM está trabalhando em outras ferramentas que, por processarem os dados de forma diferente, permitirão trabalhar com volumes maiores de informação.<br>

Para saber como acessar o recurso em cada ferramenta, consulte: [[GE - Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Configuração da Cia IA do CIGAM]]

Arquivo:AnalisarCiaDesktopEmail.png

2026-10-15T18:09:52Z

Vinicius.moder:

Arquivo:AnalisarCiaDesktopCompartilhar.png

2026-10-15T18:09:20Z

Vinicius.moder:

GE - Como Fazer - Uso da Cia - IA do CIGAM

2026-10-15T18:08:20Z

Vinicius.moder: /* Recurso "Analisar com a Cia" */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como_Fazer_Utilidades/Diversos_6]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer - Uso da Cia - IA do CIGAM]]

=Recursos, configurações e segurança=
A Cia - IA do CIGAM oferece diversas funcionalidades e atua como um hub centralizador para os recursos de inteligência artificial utilizados nas soluções CIGAM. Para garantir o correto funcionamento desses recursos, é necessário verificar se os pré-requisitos e as configurações foram realizados adequadamente. Para mais informações, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM|Como Fazer configuração da Cia IA do CIGAM]]
<br><br>
Todas as soluções de IA do CIGAM são integradas por meio dos serviços da Cia. A Cia possui integração com diferentes provedores de IA de terceiros, como OpenAI, Google, Anthropic, entre outros. Essas integrações são realizadas por meio de contas e serviços contratados, com condições de uso que asseguram que os dados trafegados não sejam utilizados para treinamento dos modelos, identificação de origem, publicidade, anúncios ou qualquer outra finalidade não prevista.
<br><br>
No caso de IAs open-source integradas à Cia, os modelos são executados dentro dos domínios da CIGAM, mantendo as mesmas premissas aplicadas às IAs contratadas: não utilização dos dados para treinamento de modelos, não identificação da origem das informações e ausência de retenção dos dados processados.
<br><br>
Além disso, sempre que houver envio explícito de dados pelo usuário por meio das funcionalidades da Cia disponíveis nas soluções CIGAM, será apresentado um diálogo de confirmação, permitindo que o usuário aceite o envio dessas informações. Os dados enviados serão tratados conforme as mesmas diretrizes de segurança, privacidade e não retenção descritas anteriormente.
<br><br>
Esta documentação apresenta o uso da Cia e está organizada conforme a forma de acesso: [[#Cia Web (SaaS)|Cia Web (SaaS)]], [[#Portais|Portais]] e [[#Desktop|Desktop]].
<br><br>
Caso tenha dúvidas sobre onde encontrar a Cia em cada uma dessas plataformas, ou sobre quais ferramentas do CIGAM possuem recursos integrados a ela, consulte a documentação específica de acesso: [[GE - Como Fazer - Cia - Como acessar|Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Cia Web (SaaS)=
A Cia Web é a aplicação web que centraliza todas as funcionalidades da Cia. Ela pode ser acessada diretamente pelo navegador do seu computador ou dispositivo móvel, ou ainda a partir do Desktop e dos Portais, sem a necessidade de novo login.
<br><br>

<center><youtube>https://youtu.be/DFGtRtPF75A</youtube></center>
<br>

==Primeiro acesso==
A Cia Web pode ser acessada diretamente pelo navegador, utilizando o seguinte endereço: https://services.cigam.cloud/cia/index.html
<br><br>
'''Importante:''' o usuário que for realizar o login precisa ter a autenticação em duas etapas habilitada. Para saber como configurá-la, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]]
<br><br>
Ao acessar pelo endereço, será necessário preencher algumas informações para que a Cia consiga validar seu acesso e consultar seus dados:<br>
* Informar a API do seu CIGAM Server, para garantir o direcionamento correto da base de dados.<br><br>

[[Imagem:CiaAPI.png|semmoldura|center|700px]]<br>

* Informar usuário e senha de login e seu código de verificação:<br><br>

[[Imagem:CiaLogin.png|semmoldura|center|700px]]
<br>
[[Imagem:CiaCodVerif.png|semmoldura|center|700px]]<br>

* Caso não queira aguardar ou informar o código de verificação, você pode optar por responder à pergunta secreta, clicando no botão “Pergunta Secreta” exibido na imagem acima.<br><br>

[[Imagem:CiaLoginA2F.png|semmoldura|center|700px]]
<br>

==Conhecendo a tela da Cia==
Após realizar o login, a Cia carregará automaticamente as informações e dados necessários do ambiente e será iniciada no assunto '''#Geral''', identificado pelo botão localizado à esquerda da caixa de texto.

[[Imagem:CiaGeral.png|semmoldura|center|700px]]
<br><br>
Ao clicar nesse botão, será exibida uma lista com todos os assuntos disponíveis, permitindo que você selecione aquele com o qual deseja interagir.<br><br>
Além disso, você pode digitar diretamente na caixa de texto o '''#Assunto''' que deseja utilizar, e a Cia entenderá automaticamente o tema da sua mensagem.<br><br>
Também é possível '''formular uma pergunta seguida de um #Assunto''' para interagir com qualquer assunto, mesmo que ele não esteja selecionado no momento.

[[Imagem:CiaAberta.png|semmoldura|center|700px]]
<br>
Ao selecionar um assunto, serão exibidas automaticamente dicas e sugestões sobre o tema escolhido, além de exemplos clicáveis que, ao serem selecionados, são processados de forma imediata.<br><br>
Além disso, ao digitar um ponto de interrogação (?) na caixa de texto, será exibida uma lista com todas as interações disponíveis para o assunto selecionado, facilitando a descoberta de comandos e possibilidades de uso.

[[Imagem:CiaDicas.png|semmoldura|center|700px]]
<br>
Outra funcionalidade prática é a possibilidade de reenviar perguntas já feitas no chat. Para isso, basta posicionar o mouse sobre a pergunta desejada e clicar no ícone de “Reenviar”. Ao passar o mouse sobre a mensagem, também será exibido o horário de envio.
<br>
[[Imagem:CiaReenviar.png|semmoldura|center|400px]]
<br>
Além disso, você pode utilizar as setas do teclado (⬆️ para cima e ⬇️ para baixo) na caixa de texto para navegar pelas últimas perguntas enviadas para o #Assunto selecionado, facilitando o reuso de interações anteriores.

===Ícones da caixa de texto===
Na caixa de texto, você encontrará alguns ícones com as seguintes funções:

<center>
{| class="wikitable"
|-
! !! Ação
|-
|center|[[Imagem:CiaUltPerg.png]] || '''Histórico de Perguntas''' – Ao clicar, é exibido o histórico das perguntas já realizadas para o assunto selecionado.
|-
|center|[[Imagem:CiaEnviar.png]] || '''Enviar''' – Envia o conteúdo digitado na caixa de texto.
|-
|center|[[Imagem:CiaFala.png]] || '''Falar''' – Permite falar ao invés de digitar, usando o recurso de voz.
|-
|center|[[Imagem:CiaExpandir.png]] || '''Expandir''' – Aumenta a altura da caixa de texto para facilitar a digitação de mensagens longas.
|-
|center|[[Imagem:CiaRecolher.png]] || '''Recolher''' – Reduz a caixa de texto ao tamanho padrão.
|}
</center>
{{VoltarInicio}}

==Assuntos disponíveis==

===Geral===
Nesse assunto, é possível conversar livremente com a Cia sobre qualquer um dos assuntos disponíveis. Se encontrar dificuldades para obter a resposta desejada, experimente selecionar um assunto específico, o que pode gerar resultados mais precisos.<br><br>
Se houver muitas respostas correspondentes, a Cia não executará nenhuma automaticamente. Em vez disso, exibirá uma opção com os valores possíveis, permitindo que você selecione manualmente a melhor alternativa.

[[Imagem:CiaGeralOpcoes.png|semmoldura|center|700px]]
<br>
Caso a Cia encontre uma resposta com confiança significativamente maior que as demais, ela será executada automaticamente.
<br><br>
No entanto, se você selecionar a opção “Não era bem isso o que eu queria”, a Cia exibirá outras opções relacionadas ao que foi solicitado, apresentando também um indicador de semáforo com a porcentagem de confiança de cada alternativa.

[[Imagem:CiaGeralOpcaoCerta.png|semmoldura|center|600px]]

===Ajuda, Vídeos e Auditor===
Conheça melhor o ERP com a ajuda da Wiki e Cia, assista vídeos sobre o CIGAM e audite seu ambiente.

====Ajuda====
Nesse assunto, você pode acessar o Chatbot da assistente virtual, onde você pode tirar dúvidas e consultar conteúdos da CIGAM Wiki enviando perguntas diretamente nela.<br>
<br>
'''Importante:''' neste assunto, a Cia atua dedicada à Wiki, focada exclusivamente nos conteúdos da documentação. As demais funcionalidades e atalhos da Cia não estarão disponíveis nesse contexto.

====Vídeos====
Nesse assunto, é possível procurar por vídeos relacionados ao tema desejado. O resultado será apresentado em forma de lista, contendo os vídeos encontrados e os tempos exatos em que o assunto começa a ser abordado, de acordo com o termo ou palavra pesquisada.

====Auditor====
Neste assunto, é possível verificar o status do sistema e identificar possíveis problemas ou inconsistências. O resultado será exibido em forma de tabela, contendo os dados retornados para facilitar a análise.

===Painéis BI, Portais e Relatórios===
Explore dashboards do BI, interaja com Portais intuitivos e execute relatórios personalizados.

====Painéis BI====
Nesse assunto, é possível abrir dashboards do BI já configurados para o usuário, permitindo sua visualização diretamente na tela.
Ao abrir um dashboard, você também pode interagir com ele, solicitando inserção de filtros, dimensões, métricas, transformações e outros ajustes.<br>
Cada dashboard aberto exibirá uma guia com as “Interações” disponíveis para aquele painel específico.
<br><br>
Além disso, ao selecionar o assunto '''#Painéis do BI''', é possível solicitar que a Cia crie um dashboard do zero.
Por exemplo: "Crie um dashboard para ver meu fluxo de caixa". Você pode ainda solicitar que métricas, dimensões e filtros sejam adicionados durante a criação, ou pedir dashboards separados por áreas.
<br><br>
'''Importante:''' caso o usuário não possua acesso ao BI ou este não esteja implementado na base de dados, será exibida uma mensagem informativa no momento do login na Cia.

====Portais====
Quando este assunto é utilizado, o resultado será sempre a abertura de uma tela dos Portais, permitindo ao usuário acessar diretamente os conteúdos e funcionalidades disponíveis nesse ambiente.
<br><br>
Essa abertura é feita de forma integrada, garantindo uma navegação contínua entre a Cia e os Portais, sem necessidade de realizar novo login ou sair da plataforma.

====Relatórios====
Ao utilizar esse assunto, será exibida uma tela para preenchimento de filtros, permitindo a emissão de relatórios web.
<br><br>
Para que essa funcionalidade opere corretamente, é necessário garantir que a instalação da CDN e da Pesquisa Dinâmica no servidor de aplicação esteja configurada de forma adequada.
<br><br>
Os relatórios exibidos aqui são os mesmos disponíveis nos Portais CIGAM, portanto é essencial que esses componentes também estejam funcionando corretamente nesses Portais.

===Qual, Faça, Consultar, Listar, Analisar e Insights===
Crie registros, analise informações ou liste dados cadastrados no CIGAM.

====Qual====
Nesse assunto, a Cia vai consultar e processar informações diretamente no ERP, usando os dados e relacionamentos disponíveis no CIGAM, e retornar os resultados em forma de texto para você visualizar.
<br><br>
'''Importante:''' nem todas as opções estão liberadas. Para ver quais você pode usar, digite ? na caixa de texto. A Cia vai mostrar uma lista com todos os comandos e funções disponíveis.

====Faça====
Nesse assunto, a Cia sempre fará um processamento no CIGAM e retornará o status do resultado. Por exemplo, você pode solicitar que a Cia crie um alerta ou até mesmo crie uma nova empresa no sistema.
<br><br>
'''Dica:''' para saber quais treinamentos ou comandos estão disponíveis, digite ? na caixa de texto. A Cia mostrará uma lista com todas as opções implementadas para você usar.

====Consultar====
Nesse assunto, você poderá fazer consultas de dados para obter listagens de registros, conforme os treinamentos de tabelas disponíveis. O resultado será apresentado em forma de tabela, exibindo os dados retornados. Já existem diversas Views prontas, para que você possa listar informações de forma mais completa e rápida.
<br><br>
'''Dica:''' para ver exemplos de consultas já implementadas, digite ? na caixa de texto.

====Listar====
Nesse assunto, você pode montar sua própria consulta de dados, escolhendo os filtros e parâmetros para gerar uma listagem personalizada. Diferente do assunto #Consultar, aqui é possível utilizar qualquer tabela do CIGAM para montar sua consulta, escrevendo em linguagem natural o que deseja buscar.
<br><br>
'''Dica:''' para ver todas as tabelas disponíveis, digite ? na caixa de texto.

====Analisar====
Analise o arquivo selecionado para gerar gráficos interativos e informativos, apresentando insights relevantes que ajudam a identificar tendências, padrões e oportunidades de melhoria.
<br><br>
Esse recurso oferece uma visualização clara e intuitiva dos dados, facilitando a interpretação das informações e apoiando a tomada de decisões estratégicas.
<br><br>
'''Aviso:''' para utilizar esta funcionalidade, é necessário concordar que os dados enviados serão processados por modelos de IA de terceiros integrados à Cia.

[[Imagem:AnalisarCia.png|semmoldura|center|600px]]

====Insights====
Gere insights inteligentes a partir dos dados de uma consulta, com análises automáticas realizadas pela Cia, que identificam padrões, tendências e possíveis pontos de atenção. Esse recurso ajuda a transformar dados brutos em informações acionáveis, facilitando a tomada de decisões estratégicas e otimizando processos.
<br><br>
'''Aviso:''' ao utilizar o assunto “Insights”, você concorda que os dados e informações analisados poderão ser enviados para modelos de IA de terceiros integrados à Cia, exclusivamente para processamento e geração dos resultados apresentados.

===IA Generativa e Pesquisa na Internet===
Converse com a IA sobre assuntos diversos, crie conteúdos e pesquise na internet sobre qualquer coisa.

====IA Generativa====
Nesse assunto, ao interagir com a IA Generativa, você poderá fazer qualquer tipo de pergunta ou solicitação, de forma livre e criativa.
O resultado exibido será exatamente a resposta gerada pela IA, sem complementos da Cia. Você pode, por exemplo, solicitar que a IA melhore ou reformule um texto, crie conteúdos ou resuma informações.
<br><br>
'''Importante:''' nesse assunto, a Cia não estará integrada aos serviços e sistemas do CIGAM — a interação é exclusivamente com a IA Generativa.

====Pesquisa na Internet====
Use esse assunto para fazer pesquisas na internet e visualizar os resultados diretamente integrados na Cia, sem precisar sair da plataforma. Você pode pesquisar qualquer tema de interesse e abrir os links retornados para acessar conteúdos, notícias e informações de forma rápida e prática.
{{VoltarInicio}}

===Compartilhamento de Análises da Cia===

<br>
<div align="justify">
Na Cia Web (SaaS), é possível gerar análises detalhadas de determinadas informações e compartilhá-las. Essa funcionalidade está disponível nos seguintes assuntos: [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Auditor|Auditor]], [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Analisar|Analisar]], [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Insights|Insights]], [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Listar|Listar]] e [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Consultar|Consultar]].
</div>
<br>

[[Image: opcoesAnalisarCia.png|semmoldura|center|800px]]

<br>
<div align="justify">
Essa opção está disponível por meio do botão '''analisar''', exibido junto à resposta apresentada após a solicitação de um desses assuntos.
</div>
<br>

[[Image: exemploBotaoAnalisar.png|semmoldura|center|800px]]

<br>
<div align="justify">
Particularmente para o assunto '''Analisar''', a análise já é exibida diretamente, pois essa é a finalidade desse assunto:
</div>
<br>

[[Image: analiseAnalisar.png|semmoldura|center|800px]]

<br>
<div align="justify">
Ao gerar uma análise , a página de resultado passa a disponibilizar opções para compartilhar e utilizar o conteúdo gerado. São disponibilizadas três opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>
<br>

[[Image: CiaWebAnalise.png|semmoldura|center|800px]]

=====Compartilhamento por e-mail=====

<div align="justify">
Ao selecionar a opção '''E-mail''', é apresentada uma janela para preenchimento das informações necessárias ao envio da análise.
</div>
<br>

[[Image: CiaWebModalEmail.png|semmoldura|center|800px]]

<br>
<div align="justify">
Após informar os destinatários e os demais dados da mensagem, basta selecionar '''Enviar'''. A análise gerada será encaminhada como um arquivo em anexo.

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
</div>

==Configurações==
O ícone de engrenagem, localizado no canto superior direito da página, reúne recursos de informação e gerenciamento. As opções disponíveis são:
* '''Respostas com áudio:''' quando ativado, as respostas da Cia são narradas em voz alta.
* '''Ambiente atual do CIGAM:''' exibe na tela o usuário logado e o ambiente em uso.
* '''Ver consumo:''' mostra a quantidade de tokens já utilizados e os usuários que geraram consumo.
* '''Limpar dados de navegação:''' exibe uma mensagem explicando como limpar os dados de navegação do navegador.
* '''Limpar cookies:''' apaga os dados armazenados localmente, permitindo informar novamente a API e realizar um novo login.
* '''Instalar aplicativo:''' instala a Cia como aplicativo no dispositivo, criando um atalho na tela inicial.
* '''Documentação na wiki:''' direciona para a documentação da Cia na CIGAM Wiki.
* '''Sair:''' encerra a sessão do usuário, permitindo realizar login com outro usuário.
<br>
[[Imagem:ConfiguracoesCia.png|semmoldura|center|500px]]
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, além do acesso à Cia Web pelo menu de mosaico, estão disponíveis recursos de IA que atuam diretamente nas telas em que você está trabalhando. Esses recursos não exigem parametrização e são apresentados de acordo com o contexto da tela.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia Web a partir dos Portais é feito pelo ícone de mosaico, onde está disponível o ícone da Cia - IA do CIGAM.<br>
<br>
[[Imagem:mosaicoCia.png|semmoldura|center|800px]]
<br>
A Cia será aberta de forma integrada, sem a necessidade de novo login, e todas as funcionalidades descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] estarão disponíveis normalmente.<br>

==Geração de conteúdo==
Na barra superior dos Portais está disponível um ícone com um menu de contexto que permite interagir com os '''campos de texto''' de qualquer parte dos Portais. As opções disponíveis permitem melhorar textos, criar conteúdos, revisar a gramática, entre outras ações.<br>
<br>
[[Imagem:comandosCia.png|semmoldura|center|650px]]
<br>
A partir da versão '''Beta 260601''', essas opções passaram a ser exibidas em uma seção separada, chamada '''Geração de conteúdo''', apresentada no mesmo menu em que ficam os agentes.<br>
<br>
[[Imagem:MenuGeracaoConteudoAgentes.png|semmoldura|center|800px]]
<br>
O campo processado é sempre o '''último campo em que o cursor esteve posicionado''' antes de abrir o menu da Cia. Por isso, basta clicar no campo desejado e, em seguida, acionar o menu e escolher o comando.<br>
<br>
Para que o comando seja executado, o campo precisa ser um '''campo de texto válido''' e conter, no mínimo, '''três palavras'''. Caso contrário, será apresentada uma mensagem informando que o conteúdo não atende aos requisitos.<br>
<br>
Após o processamento, o conteúdo gerado é aplicado automaticamente no campo, substituindo o texto anterior, sem necessidade de confirmação.<br>
<br>
Essa funcionalidade também está disponível em telas modais, ou seja, janelas sobrepostas com interações:<br>
<br>
[[Imagem:comandosModalCia.png|semmoldura|center|800px]]
<br>

==Agentes==
A partir da versão '''Beta 260601''', o menu da Cia nos Portais passou a disponibilizar também o acesso aos agentes, tanto nos Portais MVC quanto nos Portais React.<br>
<br>
Ao abrir o menu da Cia, os agentes disponíveis são detectados automaticamente de acordo com a tela que está sendo acessada, ou seja, as opções apresentadas variam conforme a página aberta.<br>
<br>
[[Imagem:MenuAgentesCia.png|semmoldura|center|800px]]
<br>

===Como os agentes são disponibilizados===
A disponibilização de cada agente pode ocorrer de quatro formas:<br>
<br>
* '''Por contexto:''' o agente é apresentado quando a Cia identifica que a tela acessada corresponde ao assunto tratado por ele. Por exemplo, um agente sobre Ordem de Produção será disponibilizado ao acessar uma página cujo contexto seja identificado como Ordem de Produção.
<br>
* '''Por parâmetro:''' o agente é apresentado quando a Cia identifica, na tela, um parâmetro com o valor esperado por ele. Por exemplo, um agente de Pedidos será disponibilizado quando existir na tela um parâmetro que contenha o código do pedido.
<br>
* '''Por contexto e parâmetro:''' o agente é apresentado somente quando as duas condições forem atendidas ao mesmo tempo.
<br>
* '''Sempre disponível:''' o agente é apresentado em qualquer tela, independentemente do contexto ou dos parâmetros.
<br>

===Resultado do processamento===
Após o processamento, o retorno do agente pode ser apresentado de duas formas, conforme o que foi executado:<br>
<br>
* Em uma '''nova guia''' do navegador, quando o agente gera algum conteúdo ou relatório como resultado.
<br>
[[Imagem:AgentesRetornoGuia.png|semmoldura|center|800px]]
<br>
* Em uma '''janela modal''', dentro da própria página em que o usuário está, quando o retorno é uma mensagem.
<br>
[[Imagem:AgentesRetornoModal.png|semmoldura|center|800px]]
<br>
<div align="justify>
A partir da versão '''Beta 261005''', quando o resultado do agente é apresentado em uma nova guia, a página passa a disponibilizar também opções para utilização e compartilhamento da análise.
</div>
<br>
[[Imagem:resultadoAnalise.png|semmoldura|center|800px]]
<br>
<div align="justify">
No cabeçalho são apresentados o nome do agente executado e as opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>
<div align="justify">
=====Compartilhamento por e-mail=====
A janela abaixo é exibida ao quando selecionada a opção '''E-mail''':
</div>
<br>
[[Imagem:modalEmail.png|semmoldura|center|800px]]
<br>
<div align="justify">

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
</div>

==Editor de Agentes==
A partir da versão '''Beta 261005''', o menu passou a disponibilizar o acesso à ferramenta '''Editor de Agentes''', que permite criar seus próprios agentes.<br>
<br>
[[Imagem:EditorAgentesCia.png|semmoldura|center|800px]]
<br>
Ao clicar na opção, será aberta uma página web no formato de assistente (wizard), com cada etapa explicada de forma detalhada. Basta preencher as informações do agente conforme a sua necessidade e avançar pelos passos até a conclusão.<br>
<br>
[[Imagem:EditorAgentesWizard.png|semmoldura|center|800px]]
<br>
Ao final do processo, será gerado um arquivo com a extensão '''.cgagt''', que contém a definição do agente criado.<br>
<br>

===Disponibilizando o agente criado===
Para que o agente passe a ser exibido nos Portais, o arquivo '''.cgagt''' precisa ser colocado na aplicação da API, dentro da pasta raiz da aplicação.<br>
<br>
É necessário que existam as pastas '''Exclusivo''' e, dentro dela, '''Agentes'''. Caso não existam, elas devem ser criadas manualmente. O arquivo deve ser colocado dentro dessa estrutura, ficando da seguinte forma:<br>
<br>
/api/exclusivo/agentes/
<br>
Assim que o arquivo é adicionado nesse local, a Cia passa a reconhecer o agente automaticamente, sem necessidade de qualquer outra configuração. Os agentes customizados são exibidos no menu da Cia nos Portais, em uma seção separada dos agentes padrão.<br>
<br>
[[Imagem:MenuAgentesCustomizados.png|semmoldura|center|800px]]
<br>
==Conversar com documentos==
<div align="justify">
A ferramenta de '''Conversar com documentos''' permite analisar, resumir e cruzar informações contidas em arquivos e relatórios através de modelos avançados de Inteligência Artificial integrados ao ERP CIGAM.

O acesso pode ser realizado a partir da tela principal da Cia Web (SaaS), clicando na opção correspondente ou digitando o assunto <code>#Documentos</code>, momento em que a aplicação é aberta em uma nova guia do navegador assim que digitada a primeira mensagem.

Além disto, podemos acessar a aplicação através dos Portais CIGAM, conforme descrito em [[GE_-_Como_Fazer_-_Cia_-_Como_acessar#Conversar_com_documentos|Como acessar]].

Para a utilização da aplicação, é necessário estar autenticado com um token de autorização CIGAM e com o endereço da API CIGAM devidamente parametrizado. Logo ao abrir, o sistema avalia o ambiente e valida a sessão do usuário em tempo real.

Estando os parâmetros validados, será gerado automaticamente um ID de conversação (''Conversation ID'') exclusivo para a sessão. Esta identificação é armazenada em cookies do navegador com validade de 24 horas, permitindo que a Cia armazene e mantenha o contexto contínuo de todas as mensagens e documentos anexados. Caso a página seja atualizada ou fechada dentro deste período, a sessão conectada e os arquivos são recuperados automaticamente.

<br>
<center>[[Arquivo:cia_conv_docs_01.png|nenhum|750px]]</center>
<br>

No primeiro acesso, é obrigatório marcar a opção '''Termo de consentimento''' para indicar ciência de que os dados e documentos selecionados para análise serão enviados aos modelos de IA de terceiros integrados com a Cia. Por segurança e conformidade, os campos de envio e a área de anexos permanecem bloqueados até que o consentimento seja confirmado. Uma vez aceito, uma mensagem de registro é inserida no histórico da conversa e a preferência é memorizada para a sessão.

Após confirmar o termo, a área de upload no painel lateral esquerdo é habilitada, permitindo anexar múltiplos arquivos simultaneamente, seja arrastando e soltando os documentos sobre a área de dropzone, seja clicando sobre ela para abrir a janela de seleção de arquivos.

A ferramenta suporta uma ampla variedade de formatos corporativos:
*'''Documentos de Texto e Portáteis:''' PDF (<code>.pdf</code>), Texto Simples (<code>.txt</code>), Word (<code>.doc</code>, <code>.docx</code>).
*'''Planilhas e Dados Tabulares:''' Planilhas Excel (<code>.xlsx</code>, <code>.xls</code>), Valores Separados por Vírgula (<code>.csv</code>).
*'''Arquivos de Estrutura de Dados:''' Arquivos <code>.json</code> e <code>.xml</code>.
*'''Imagens:''' Formatos de imagem (<code>.png</code>, <code>.jpg</code>, <code>.jpeg</code>, etc.).

No painel lateral, é possível visualizar o contador total de documentos anexados, o ícone específico do formato, o nome, o tamanho do arquivo formatado e a indicação de que o documento encontra-se ativo no contexto da conversa. Em dispositivos móveis ou telas menores, o painel lateral pode ser recolhido ou expandido através do botão retrátil no topo da barra.

Uma vez enviados para análise, os documentos permanecem registrados no contexto da conversa no servidor, não sendo necessário reenviá-los a cada nova pergunta. Caso deseje substituir ou remover os arquivos analisados, deve-se reiniciar o contexto através da opção de limpeza da conversa.

<br>
<center>[[Arquivo:cia_conv_docs_02.png|nenhum|750px]]</center>
<br>

Clicando no ícone da engrenagem localizado no canto superior direito da tela, temos acesso ao menu de opções e configurações da ferramenta:

*'''Modelo de IA:''' Permite selecionar o modelo de Inteligência Artificial desejado para o processamento documental (ex.: GPT-5.4 Recomendado, GPT-5.4 Mini, GPT-5.2 Alta Precisão, GPT-5.1 Raciocínio, GPT-4.1 Análise Documental, GPT-4o Versátil, GPT-4o Mini Econômico). A lista de modelos é atualizada dinamicamente a partir dos serviços disponíveis na Cia.
*'''Usuário Conectado:''' Exibe os dados do usuário autenticado no ERP CIGAM, incluindo nome, empresa (razão social / fantasia) e código de usuário.
*'''Ambiente & Sessão CIGAM:''' Apresenta o tipo de ambiente (produção ou depuração) e a URL da API CIGAM conectada, acompanhado de um botão de cópia rápida para facilitar diagnósticos e solicitações de suporte técnico.
*'''ID da Conversa Ativa:''' Exibe o identificador único da sessão com indicador visual de status em tempo real e botão para copiar o código do ID diretamente para a área de transferência.
*'''Limpar conversa:''' Permite reiniciar o contexto da conversa. Ao acionar esta opção, um balão interativo de confirmação é apresentado no histórico do chat (com as opções ''Limpar Conversa'' ou ''Cancelar''). Ao confirmar, o sistema solicita a exclusão da conversa no serviço da OpenAI para evitar registros órfãos, remove os documentos e cookies locais e gera um novo ID de conversação limpo.
*'''Documentação na wiki:''' Atalho que direciona diretamente aos manuais e guias de uso na CIGAM Wiki.

<br>
<center>[[Arquivo:cia_conv_docs_03.png|nenhum|750px]]</center>
<br>

Com os documentos anexados, podemos enviar perguntas e comandos no campo inferior para obter resumos executivos, explicações pontuais, cruzamento de dados entre arquivos distintos, localização de inconsistências ou extração de indicadores. Caso enviemos os arquivos sem digitar nenhuma mensagem complementar, a Cia aplicará o prompt de sistema padrão para realizar uma leitura analítica e retornar um resumo estruturado dos documentos.

O sistema dispõe de diretrizes de sistema corporativas (''System Prompt'') integradas ao ecossistema do ERP CIGAM, orientando o modelo a analisar com fidelidade os dados fornecidos, sem inventar informações ausentes.

Também é disponibilizado o recurso de '''Reconhecimento de Voz''' através do ícone de microfone (habilitado em conexões seguras HTTPS ou localhost). O recurso conta com reconhecimento inteligente de pontuação falada: ao ditar expressões como ''"vírgula"'', ''"ponto"'', ''"ponto e vírgula"'', ''"dois pontos"'', ''"interrogação"'', ''"exclamação"'', ''"hífen"'', ''"abre parênteses"'', ''"fecha parênteses"'' ou ''"nova linha"'', os termos são automaticamente substituídos pelos respectivos sinais gráficos e as frases são capitalizadas de forma automática.

<br>
<center>[[Arquivo:cia_conv_docs_04.png|nenhum|750px]]</center>
<br>

As respostas retornadas pela Cia contam com formatação Markdown avançada, estruturando o conteúdo em títulos hierárquicos, listas ordenadas ou em tópicos, citações em bloco e tabelas responsivas estilizadas.

Além disso, sempre que a análise envolver dados numéricos comparativos, demonstrativos contábeis/financeiros (como DRE, receitas e despesas), séries temporais ou valores tabulares, a Cia gera automaticamente gráficos visuais e interativos integrados diretamente na resposta:
*'''Tipos de Gráficos Gerados:''' Barras verticais, linhas de tendência, gráficos de pizza e rosca, estilizados na paleta de cores oficial da Cia e com valores numéricos formatados no padrão brasileiro (pt-BR).
*'''Exportação do Gráfico:''' Cada card de gráfico possui um botão de download no canto superior direito, permitindo baixar a imagem em formato PNG em alta resolução para inclusão imediata em relatórios, apresentações ou envio por e-mail.

<br>
<center>[[Arquivo:cia_conv_docs_05.png|nenhum|750px]]</center>
<br>

Podemos manter uma conversa contínua com diversos documentos e mensagens em múltiplos turnos de diálogo. A Cia preserva o histórico de perguntas e respostas anteriores, permitindo aprofundar análises, solicitar detalhamentos de itens específicos ou anexar novos arquivos complementares ao longo da conversa.

</div>
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, além do acesso rápido à Cia Web, algumas ferramentas do sistema disponibilizam o recurso "Analisar com a Cia".<br>

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM), disponível no menu lateral do Desktop, abre a Cia Web de forma integrada ao sistema, em uma janela do próprio CIGAM.<br>
<br>
Desde que as configurações necessárias tenham sido aplicadas, conforme [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Acesso rápido à Cia Web (SaaS)|Acesso rápido à Cia Web (SaaS)]], '''todas as funcionalidades da Cia Web estarão disponíveis normalmente''', da mesma forma que no acesso pelo navegador. Para conhecê-las, consulte a seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] desta documentação.<br>
<br>
[[Imagem:CiaAbertaDesktop.png|semmoldura|center|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''' está disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída. Em todas elas, o comportamento é o mesmo: a Cia analisa o conteúdo que está em uso na tela e gera um relatório com o resultado da análise, apresentado em uma nova página.<br>
<br>
Ao acionar a opção, o fluxo é o seguinte:<br>
<br>
'''1. Confirmação dos termos de uso'''<br>
Antes de qualquer envio, será exibida uma mensagem solicitando que o usuário concorde com o envio das informações para análise. Os dados enviados seguem as diretrizes de segurança, privacidade e não retenção descritas em [[#Recursos, configurações e segurança|Recursos, configurações e segurança]].<br>
<br>
[[Imagem:AnalisarCiaTermos.png|semmoldura|center|500px]]
<br>
'''2. Complemento do prompt (opcional)'''<br>
Em seguida, será apresentada uma caixa de texto para que o usuário complemente a solicitação, orientando a análise para algum ponto específico. O preenchimento é opcional e pode ser deixado em branco.<br>
<br>
Essa caixa de texto serve apenas para complementar o prompt base que a Cia monta automaticamente, e não altera o conteúdo que está sendo enviado. O recurso considera que o usuário já filtrou os dados na própria tela do CIGAM antes de acionar a análise. O prompt base é mantido oculto por ser extenso e técnico, evitando que o usuário precise conferi-lo a cada utilização.<br>
<br>
[[Imagem:AnalisarCiaPrompt.png|semmoldura|center|700px]]
<br>
'''3. Geração do relatório'''<br>
Após a confirmação, a Cia processa o conteúdo e apresenta o relatório em uma nova página flutuante, com a análise dos dados enviados.<br>
<br>
O próprio relatório informa a quantidade de dados que foi analisada, permitindo que o usuário veja o volume aproximado considerado e identifique se o conteúdo enviado corresponde ao que esperava.<br>
<br>
[[Imagem:AnalisarCiaRelatorio.png|semmoldura|center|700px]]
<br>

A partir da versão '''Beta 261005''', o resultado da análise passa a ser apresentado em uma janela separada no aplicativo Desktop, que disponibiliza opções para utilização e compartilhamento do conteúdo gerado.<br>
<br>
No cabeçalho dessa janela, são apresentados o nome do agente executado e três opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.

<br>
[[Imagem:AnalisarCiaDesktopCompartilhar.png|semmoldura|center|800px]]
<br>

====Compartilhamento por e-mail====

Ao selecionar a opção '''E-mail''', é apresentada uma janela para preenchimento das informações necessárias ao envio da análise.<br>
<br>
[[Imagem:AnalisarCiaDesktopEmail.png|semmoldura|center|700px]]
<br>
Após informar os destinatários e os demais dados da mensagem, basta selecionar '''Enviar'''. A análise gerada será encaminhada como um arquivo em anexo.<br>
<br>

===Limite de conteúdo enviado===
Existe um limite para o volume de conteúdo enviado em cada análise, que varia conforme a versão do ambiente:<br>
<br>
* '''150 KB''' — desde a disponibilização do recurso, na versão '''250505.a'''.
* '''3 MB''' — a partir das patches '''250505.i''' e '''251103.a''', e da versão '''RC 260504'''.
<br>
Quando o conteúdo selecionado ultrapassa esse limite, a Cia exibe uma mensagem informando o tamanho excedido e a análise não é processada, ou seja, nenhum relatório será gerado.<br>
<br>
[[Imagem:AnalisarCiaLimite.png|semmoldura|center|600px]]
<br>
'''Esse limite não é parametrizável e não se trata de uma restrição imposta pela CIGAM.''' Ele decorre da própria capacidade dos modelos de IA integrados à Cia, que possuem um limite técnico de volume de dados que conseguem processar em uma única análise. Quando esse volume é ultrapassado, os modelos passam a analisar as informações por amostragem — ou seja, mesmo que fosse permitido enviar uma quantidade maior de dados, o modelo não analisaria todo o conteúdo, e o resultado seria menos preciso. O limite adotado pela Cia acompanha essa característica dos modelos e assegura que a análise seja feita sobre os dados completos.<br>
<br>
Além da qualidade da análise, há também a questão do tempo de processamento: quanto maior o volume enviado, maior o tempo de resposta do modelo, tornando a espera inviável para o uso no dia a dia.<br>
<br>
Por isso, o recurso foi feito para ser simples e direto: analisar, com um clique, os dados que o usuário já está visualizando pelos meios tradicionais do CIGAM, como grids filtrados e relatórios. Em ambientes com grande volume de dados, a prática recomendada é '''filtrar e consolidar as informações na própria tela antes de acionar a análise''', reduzindo o período ou o escopo consultado. Para análises de períodos maiores, recomenda-se utilizar dados já consolidados, como totalizadores e relatórios sintéticos, em vez de listagens analíticas completas.<br>
<br>
A CIGAM está trabalhando em outras ferramentas que, por processarem os dados de forma diferente, permitirão trabalhar com volumes maiores de informação.<br>

Para saber como acessar o recurso em cada ferramenta, consulte: [[GE - Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Configuração da Cia IA do CIGAM]]

Arquivo:ExemploBotaoAnalisar.png

2026-10-15T17:33:21Z

Vinicius.moder:

Arquivo:CiaWebModalEmail.png

2026-10-15T17:30:40Z

Vinicius.moder:

Arquivo:CiaWebAnalise.png

2026-10-15T17:30:14Z

Vinicius.moder:

Arquivo:AnaliseAnalisar.png

2026-10-15T17:29:26Z

Vinicius.moder:

Arquivo:OpcoesAnalisarCia.png

2026-10-15T17:24:57Z

Vinicius.moder:

GE - Como Fazer - Uso da Cia - IA do CIGAM

2026-10-15T17:10:28Z

Vinicius.moder: /* Assuntos disponíveis */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como_Fazer_Utilidades/Diversos_6]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer - Uso da Cia - IA do CIGAM]]

=Recursos, configurações e segurança=
A Cia - IA do CIGAM oferece diversas funcionalidades e atua como um hub centralizador para os recursos de inteligência artificial utilizados nas soluções CIGAM. Para garantir o correto funcionamento desses recursos, é necessário verificar se os pré-requisitos e as configurações foram realizados adequadamente. Para mais informações, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM|Como Fazer configuração da Cia IA do CIGAM]]
<br><br>
Todas as soluções de IA do CIGAM são integradas por meio dos serviços da Cia. A Cia possui integração com diferentes provedores de IA de terceiros, como OpenAI, Google, Anthropic, entre outros. Essas integrações são realizadas por meio de contas e serviços contratados, com condições de uso que asseguram que os dados trafegados não sejam utilizados para treinamento dos modelos, identificação de origem, publicidade, anúncios ou qualquer outra finalidade não prevista.
<br><br>
No caso de IAs open-source integradas à Cia, os modelos são executados dentro dos domínios da CIGAM, mantendo as mesmas premissas aplicadas às IAs contratadas: não utilização dos dados para treinamento de modelos, não identificação da origem das informações e ausência de retenção dos dados processados.
<br><br>
Além disso, sempre que houver envio explícito de dados pelo usuário por meio das funcionalidades da Cia disponíveis nas soluções CIGAM, será apresentado um diálogo de confirmação, permitindo que o usuário aceite o envio dessas informações. Os dados enviados serão tratados conforme as mesmas diretrizes de segurança, privacidade e não retenção descritas anteriormente.
<br><br>
Esta documentação apresenta o uso da Cia e está organizada conforme a forma de acesso: [[#Cia Web (SaaS)|Cia Web (SaaS)]], [[#Portais|Portais]] e [[#Desktop|Desktop]].
<br><br>
Caso tenha dúvidas sobre onde encontrar a Cia em cada uma dessas plataformas, ou sobre quais ferramentas do CIGAM possuem recursos integrados a ela, consulte a documentação específica de acesso: [[GE - Como Fazer - Cia - Como acessar|Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Cia Web (SaaS)=
A Cia Web é a aplicação web que centraliza todas as funcionalidades da Cia. Ela pode ser acessada diretamente pelo navegador do seu computador ou dispositivo móvel, ou ainda a partir do Desktop e dos Portais, sem a necessidade de novo login.
<br><br>

<center><youtube>https://youtu.be/DFGtRtPF75A</youtube></center>
<br>

==Primeiro acesso==
A Cia Web pode ser acessada diretamente pelo navegador, utilizando o seguinte endereço: https://services.cigam.cloud/cia/index.html
<br><br>
'''Importante:''' o usuário que for realizar o login precisa ter a autenticação em duas etapas habilitada. Para saber como configurá-la, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]]
<br><br>
Ao acessar pelo endereço, será necessário preencher algumas informações para que a Cia consiga validar seu acesso e consultar seus dados:<br>
* Informar a API do seu CIGAM Server, para garantir o direcionamento correto da base de dados.<br><br>

[[Imagem:CiaAPI.png|semmoldura|center|700px]]<br>

* Informar usuário e senha de login e seu código de verificação:<br><br>

[[Imagem:CiaLogin.png|semmoldura|center|700px]]
<br>
[[Imagem:CiaCodVerif.png|semmoldura|center|700px]]<br>

* Caso não queira aguardar ou informar o código de verificação, você pode optar por responder à pergunta secreta, clicando no botão “Pergunta Secreta” exibido na imagem acima.<br><br>

[[Imagem:CiaLoginA2F.png|semmoldura|center|700px]]
<br>

==Conhecendo a tela da Cia==
Após realizar o login, a Cia carregará automaticamente as informações e dados necessários do ambiente e será iniciada no assunto '''#Geral''', identificado pelo botão localizado à esquerda da caixa de texto.

[[Imagem:CiaGeral.png|semmoldura|center|700px]]
<br><br>
Ao clicar nesse botão, será exibida uma lista com todos os assuntos disponíveis, permitindo que você selecione aquele com o qual deseja interagir.<br><br>
Além disso, você pode digitar diretamente na caixa de texto o '''#Assunto''' que deseja utilizar, e a Cia entenderá automaticamente o tema da sua mensagem.<br><br>
Também é possível '''formular uma pergunta seguida de um #Assunto''' para interagir com qualquer assunto, mesmo que ele não esteja selecionado no momento.

[[Imagem:CiaAberta.png|semmoldura|center|700px]]
<br>
Ao selecionar um assunto, serão exibidas automaticamente dicas e sugestões sobre o tema escolhido, além de exemplos clicáveis que, ao serem selecionados, são processados de forma imediata.<br><br>
Além disso, ao digitar um ponto de interrogação (?) na caixa de texto, será exibida uma lista com todas as interações disponíveis para o assunto selecionado, facilitando a descoberta de comandos e possibilidades de uso.

[[Imagem:CiaDicas.png|semmoldura|center|700px]]
<br>
Outra funcionalidade prática é a possibilidade de reenviar perguntas já feitas no chat. Para isso, basta posicionar o mouse sobre a pergunta desejada e clicar no ícone de “Reenviar”. Ao passar o mouse sobre a mensagem, também será exibido o horário de envio.
<br>
[[Imagem:CiaReenviar.png|semmoldura|center|400px]]
<br>
Além disso, você pode utilizar as setas do teclado (⬆️ para cima e ⬇️ para baixo) na caixa de texto para navegar pelas últimas perguntas enviadas para o #Assunto selecionado, facilitando o reuso de interações anteriores.

===Ícones da caixa de texto===
Na caixa de texto, você encontrará alguns ícones com as seguintes funções:

<center>
{| class="wikitable"
|-
! !! Ação
|-
|center|[[Imagem:CiaUltPerg.png]] || '''Histórico de Perguntas''' – Ao clicar, é exibido o histórico das perguntas já realizadas para o assunto selecionado.
|-
|center|[[Imagem:CiaEnviar.png]] || '''Enviar''' – Envia o conteúdo digitado na caixa de texto.
|-
|center|[[Imagem:CiaFala.png]] || '''Falar''' – Permite falar ao invés de digitar, usando o recurso de voz.
|-
|center|[[Imagem:CiaExpandir.png]] || '''Expandir''' – Aumenta a altura da caixa de texto para facilitar a digitação de mensagens longas.
|-
|center|[[Imagem:CiaRecolher.png]] || '''Recolher''' – Reduz a caixa de texto ao tamanho padrão.
|}
</center>
{{VoltarInicio}}

==Assuntos disponíveis==

===Geral===
Nesse assunto, é possível conversar livremente com a Cia sobre qualquer um dos assuntos disponíveis. Se encontrar dificuldades para obter a resposta desejada, experimente selecionar um assunto específico, o que pode gerar resultados mais precisos.<br><br>
Se houver muitas respostas correspondentes, a Cia não executará nenhuma automaticamente. Em vez disso, exibirá uma opção com os valores possíveis, permitindo que você selecione manualmente a melhor alternativa.

[[Imagem:CiaGeralOpcoes.png|semmoldura|center|700px]]
<br>
Caso a Cia encontre uma resposta com confiança significativamente maior que as demais, ela será executada automaticamente.
<br><br>
No entanto, se você selecionar a opção “Não era bem isso o que eu queria”, a Cia exibirá outras opções relacionadas ao que foi solicitado, apresentando também um indicador de semáforo com a porcentagem de confiança de cada alternativa.

[[Imagem:CiaGeralOpcaoCerta.png|semmoldura|center|600px]]

===Ajuda, Vídeos e Auditor===
Conheça melhor o ERP com a ajuda da Wiki e Cia, assista vídeos sobre o CIGAM e audite seu ambiente.

====Ajuda====
Nesse assunto, você pode acessar o Chatbot da assistente virtual, onde você pode tirar dúvidas e consultar conteúdos da CIGAM Wiki enviando perguntas diretamente nela.<br>
<br>
'''Importante:''' neste assunto, a Cia atua dedicada à Wiki, focada exclusivamente nos conteúdos da documentação. As demais funcionalidades e atalhos da Cia não estarão disponíveis nesse contexto.

====Vídeos====
Nesse assunto, é possível procurar por vídeos relacionados ao tema desejado. O resultado será apresentado em forma de lista, contendo os vídeos encontrados e os tempos exatos em que o assunto começa a ser abordado, de acordo com o termo ou palavra pesquisada.

====Auditor====
Neste assunto, é possível verificar o status do sistema e identificar possíveis problemas ou inconsistências. O resultado será exibido em forma de tabela, contendo os dados retornados para facilitar a análise.

===Painéis BI, Portais e Relatórios===
Explore dashboards do BI, interaja com Portais intuitivos e execute relatórios personalizados.

====Painéis BI====
Nesse assunto, é possível abrir dashboards do BI já configurados para o usuário, permitindo sua visualização diretamente na tela.
Ao abrir um dashboard, você também pode interagir com ele, solicitando inserção de filtros, dimensões, métricas, transformações e outros ajustes.<br>
Cada dashboard aberto exibirá uma guia com as “Interações” disponíveis para aquele painel específico.
<br><br>
Além disso, ao selecionar o assunto '''#Painéis do BI''', é possível solicitar que a Cia crie um dashboard do zero.
Por exemplo: "Crie um dashboard para ver meu fluxo de caixa". Você pode ainda solicitar que métricas, dimensões e filtros sejam adicionados durante a criação, ou pedir dashboards separados por áreas.
<br><br>
'''Importante:''' caso o usuário não possua acesso ao BI ou este não esteja implementado na base de dados, será exibida uma mensagem informativa no momento do login na Cia.

====Portais====
Quando este assunto é utilizado, o resultado será sempre a abertura de uma tela dos Portais, permitindo ao usuário acessar diretamente os conteúdos e funcionalidades disponíveis nesse ambiente.
<br><br>
Essa abertura é feita de forma integrada, garantindo uma navegação contínua entre a Cia e os Portais, sem necessidade de realizar novo login ou sair da plataforma.

====Relatórios====
Ao utilizar esse assunto, será exibida uma tela para preenchimento de filtros, permitindo a emissão de relatórios web.
<br><br>
Para que essa funcionalidade opere corretamente, é necessário garantir que a instalação da CDN e da Pesquisa Dinâmica no servidor de aplicação esteja configurada de forma adequada.
<br><br>
Os relatórios exibidos aqui são os mesmos disponíveis nos Portais CIGAM, portanto é essencial que esses componentes também estejam funcionando corretamente nesses Portais.

===Qual, Faça, Consultar, Listar, Analisar e Insights===
Crie registros, analise informações ou liste dados cadastrados no CIGAM.

====Qual====
Nesse assunto, a Cia vai consultar e processar informações diretamente no ERP, usando os dados e relacionamentos disponíveis no CIGAM, e retornar os resultados em forma de texto para você visualizar.
<br><br>
'''Importante:''' nem todas as opções estão liberadas. Para ver quais você pode usar, digite ? na caixa de texto. A Cia vai mostrar uma lista com todos os comandos e funções disponíveis.

====Faça====
Nesse assunto, a Cia sempre fará um processamento no CIGAM e retornará o status do resultado. Por exemplo, você pode solicitar que a Cia crie um alerta ou até mesmo crie uma nova empresa no sistema.
<br><br>
'''Dica:''' para saber quais treinamentos ou comandos estão disponíveis, digite ? na caixa de texto. A Cia mostrará uma lista com todas as opções implementadas para você usar.

====Consultar====
Nesse assunto, você poderá fazer consultas de dados para obter listagens de registros, conforme os treinamentos de tabelas disponíveis. O resultado será apresentado em forma de tabela, exibindo os dados retornados. Já existem diversas Views prontas, para que você possa listar informações de forma mais completa e rápida.
<br><br>
'''Dica:''' para ver exemplos de consultas já implementadas, digite ? na caixa de texto.

====Listar====
Nesse assunto, você pode montar sua própria consulta de dados, escolhendo os filtros e parâmetros para gerar uma listagem personalizada. Diferente do assunto #Consultar, aqui é possível utilizar qualquer tabela do CIGAM para montar sua consulta, escrevendo em linguagem natural o que deseja buscar.
<br><br>
'''Dica:''' para ver todas as tabelas disponíveis, digite ? na caixa de texto.

====Analisar====
Analise o arquivo selecionado para gerar gráficos interativos e informativos, apresentando insights relevantes que ajudam a identificar tendências, padrões e oportunidades de melhoria.
<br><br>
Esse recurso oferece uma visualização clara e intuitiva dos dados, facilitando a interpretação das informações e apoiando a tomada de decisões estratégicas.
<br><br>
'''Aviso:''' para utilizar esta funcionalidade, é necessário concordar que os dados enviados serão processados por modelos de IA de terceiros integrados à Cia.

[[Imagem:AnalisarCia.png|semmoldura|center|600px]]

====Insights====
Gere insights inteligentes a partir dos dados de uma consulta, com análises automáticas realizadas pela Cia, que identificam padrões, tendências e possíveis pontos de atenção. Esse recurso ajuda a transformar dados brutos em informações acionáveis, facilitando a tomada de decisões estratégicas e otimizando processos.
<br><br>
'''Aviso:''' ao utilizar o assunto “Insights”, você concorda que os dados e informações analisados poderão ser enviados para modelos de IA de terceiros integrados à Cia, exclusivamente para processamento e geração dos resultados apresentados.

===IA Generativa e Pesquisa na Internet===
Converse com a IA sobre assuntos diversos, crie conteúdos e pesquise na internet sobre qualquer coisa.

====IA Generativa====
Nesse assunto, ao interagir com a IA Generativa, você poderá fazer qualquer tipo de pergunta ou solicitação, de forma livre e criativa.
O resultado exibido será exatamente a resposta gerada pela IA, sem complementos da Cia. Você pode, por exemplo, solicitar que a IA melhore ou reformule um texto, crie conteúdos ou resuma informações.
<br><br>
'''Importante:''' nesse assunto, a Cia não estará integrada aos serviços e sistemas do CIGAM — a interação é exclusivamente com a IA Generativa.

====Pesquisa na Internet====
Use esse assunto para fazer pesquisas na internet e visualizar os resultados diretamente integrados na Cia, sem precisar sair da plataforma. Você pode pesquisar qualquer tema de interesse e abrir os links retornados para acessar conteúdos, notícias e informações de forma rápida e prática.
{{VoltarInicio}}

===Compartilhamento de Análises da Cia===

<br>
<div align="justify">
Na Cia Web (SaaS), é possível gerar análises detalhadas de determinadas informações e compartilhá-las. Essa funcionalidade está disponível nos seguintes assuntos: [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Auditor|Auditor]], [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Analisar|Analisar]], [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Insights|Insights]], [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Listar|Listar]] e [[GE_-_Como_Fazer_-_Uso_da_Cia_-_IA_do_CIGAM#Consultar|Consultar]].
</div>
<br>

[[Image: opcoesAnalisarCia.png|semmoldura|center|800px]]

<br>
<div align="justify">
Essa opção está disponível por meio do botão '''analisar''', exibido junto à resposta apresentada após a solicitação de um desses assuntos.
</div>
<br>

[[Image: exemploBotaoAnalisar.png|semmoldura|center|800px]]

<br>
<div align="justify">
Particularmente para o assunto '''Analisar''', a análise já é exibida diretamente, pois essa é a finalidade desse assunto:
</div>
<br>

[[Image: analiseAnalisar.png|semmoldura|center|800px]]

<br>
<div align="justify">
Ao gerar uma análise , a página de resultado passa a disponibilizar opções para compartilhar e utilizar o conteúdo gerado. São disponibilizadas três opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>
<br>

[[Image: CiaWebAnalise.png|semmoldura|center|800px]]

=====Compartilhamento por e-mail=====

<div align="justify">
Ao selecionar a opção '''E-mail''', é apresentada uma janela para preenchimento das informações necessárias ao envio da análise.
</div>
<br>

[[Image: CiaWebModalEmail.png|semmoldura|center|800px]]

<br>
<div align="justify">
Após informar os destinatários e os demais dados da mensagem, basta selecionar '''Enviar'''. A análise gerada será encaminhada como um arquivo em anexo.

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
</div>

==Configurações==
O ícone de engrenagem, localizado no canto superior direito da página, reúne recursos de informação e gerenciamento. As opções disponíveis são:
* '''Respostas com áudio:''' quando ativado, as respostas da Cia são narradas em voz alta.
* '''Ambiente atual do CIGAM:''' exibe na tela o usuário logado e o ambiente em uso.
* '''Ver consumo:''' mostra a quantidade de tokens já utilizados e os usuários que geraram consumo.
* '''Limpar dados de navegação:''' exibe uma mensagem explicando como limpar os dados de navegação do navegador.
* '''Limpar cookies:''' apaga os dados armazenados localmente, permitindo informar novamente a API e realizar um novo login.
* '''Instalar aplicativo:''' instala a Cia como aplicativo no dispositivo, criando um atalho na tela inicial.
* '''Documentação na wiki:''' direciona para a documentação da Cia na CIGAM Wiki.
* '''Sair:''' encerra a sessão do usuário, permitindo realizar login com outro usuário.
<br>
[[Imagem:ConfiguracoesCia.png|semmoldura|center|500px]]
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, além do acesso à Cia Web pelo menu de mosaico, estão disponíveis recursos de IA que atuam diretamente nas telas em que você está trabalhando. Esses recursos não exigem parametrização e são apresentados de acordo com o contexto da tela.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia Web a partir dos Portais é feito pelo ícone de mosaico, onde está disponível o ícone da Cia - IA do CIGAM.<br>
<br>
[[Imagem:mosaicoCia.png|semmoldura|center|800px]]
<br>
A Cia será aberta de forma integrada, sem a necessidade de novo login, e todas as funcionalidades descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] estarão disponíveis normalmente.<br>

==Geração de conteúdo==
Na barra superior dos Portais está disponível um ícone com um menu de contexto que permite interagir com os '''campos de texto''' de qualquer parte dos Portais. As opções disponíveis permitem melhorar textos, criar conteúdos, revisar a gramática, entre outras ações.<br>
<br>
[[Imagem:comandosCia.png|semmoldura|center|650px]]
<br>
A partir da versão '''Beta 260601''', essas opções passaram a ser exibidas em uma seção separada, chamada '''Geração de conteúdo''', apresentada no mesmo menu em que ficam os agentes.<br>
<br>
[[Imagem:MenuGeracaoConteudoAgentes.png|semmoldura|center|800px]]
<br>
O campo processado é sempre o '''último campo em que o cursor esteve posicionado''' antes de abrir o menu da Cia. Por isso, basta clicar no campo desejado e, em seguida, acionar o menu e escolher o comando.<br>
<br>
Para que o comando seja executado, o campo precisa ser um '''campo de texto válido''' e conter, no mínimo, '''três palavras'''. Caso contrário, será apresentada uma mensagem informando que o conteúdo não atende aos requisitos.<br>
<br>
Após o processamento, o conteúdo gerado é aplicado automaticamente no campo, substituindo o texto anterior, sem necessidade de confirmação.<br>
<br>
Essa funcionalidade também está disponível em telas modais, ou seja, janelas sobrepostas com interações:<br>
<br>
[[Imagem:comandosModalCia.png|semmoldura|center|800px]]
<br>

==Agentes==
A partir da versão '''Beta 260601''', o menu da Cia nos Portais passou a disponibilizar também o acesso aos agentes, tanto nos Portais MVC quanto nos Portais React.<br>
<br>
Ao abrir o menu da Cia, os agentes disponíveis são detectados automaticamente de acordo com a tela que está sendo acessada, ou seja, as opções apresentadas variam conforme a página aberta.<br>
<br>
[[Imagem:MenuAgentesCia.png|semmoldura|center|800px]]
<br>

===Como os agentes são disponibilizados===
A disponibilização de cada agente pode ocorrer de quatro formas:<br>
<br>
* '''Por contexto:''' o agente é apresentado quando a Cia identifica que a tela acessada corresponde ao assunto tratado por ele. Por exemplo, um agente sobre Ordem de Produção será disponibilizado ao acessar uma página cujo contexto seja identificado como Ordem de Produção.
<br>
* '''Por parâmetro:''' o agente é apresentado quando a Cia identifica, na tela, um parâmetro com o valor esperado por ele. Por exemplo, um agente de Pedidos será disponibilizado quando existir na tela um parâmetro que contenha o código do pedido.
<br>
* '''Por contexto e parâmetro:''' o agente é apresentado somente quando as duas condições forem atendidas ao mesmo tempo.
<br>
* '''Sempre disponível:''' o agente é apresentado em qualquer tela, independentemente do contexto ou dos parâmetros.
<br>

===Resultado do processamento===
Após o processamento, o retorno do agente pode ser apresentado de duas formas, conforme o que foi executado:<br>
<br>
* Em uma '''nova guia''' do navegador, quando o agente gera algum conteúdo ou relatório como resultado.
<br>
[[Imagem:AgentesRetornoGuia.png|semmoldura|center|800px]]
<br>
* Em uma '''janela modal''', dentro da própria página em que o usuário está, quando o retorno é uma mensagem.
<br>
[[Imagem:AgentesRetornoModal.png|semmoldura|center|800px]]
<br>
<div align="justify>
A partir da versão '''Beta 261005''', quando o resultado do agente é apresentado em uma nova guia, a página passa a disponibilizar também opções para utilização e compartilhamento da análise.
</div>
<br>
[[Imagem:resultadoAnalise.png|semmoldura|center|800px]]
<br>
<div align="justify">
No cabeçalho são apresentados o nome do agente executado e as opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>
<div align="justify">
=====Compartilhamento por e-mail=====
A janela abaixo é exibida ao quando selecionada a opção '''E-mail''':
</div>
<br>
[[Imagem:modalEmail.png|semmoldura|center|800px]]
<br>
<div align="justify">

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
</div>

==Editor de Agentes==
A partir da versão '''Beta 261005''', o menu passou a disponibilizar o acesso à ferramenta '''Editor de Agentes''', que permite criar seus próprios agentes.<br>
<br>
[[Imagem:EditorAgentesCia.png|semmoldura|center|800px]]
<br>
Ao clicar na opção, será aberta uma página web no formato de assistente (wizard), com cada etapa explicada de forma detalhada. Basta preencher as informações do agente conforme a sua necessidade e avançar pelos passos até a conclusão.<br>
<br>
[[Imagem:EditorAgentesWizard.png|semmoldura|center|800px]]
<br>
Ao final do processo, será gerado um arquivo com a extensão '''.cgagt''', que contém a definição do agente criado.<br>
<br>

===Disponibilizando o agente criado===
Para que o agente passe a ser exibido nos Portais, o arquivo '''.cgagt''' precisa ser colocado na aplicação da API, dentro da pasta raiz da aplicação.<br>
<br>
É necessário que existam as pastas '''Exclusivo''' e, dentro dela, '''Agentes'''. Caso não existam, elas devem ser criadas manualmente. O arquivo deve ser colocado dentro dessa estrutura, ficando da seguinte forma:<br>
<br>
/api/exclusivo/agentes/
<br>
Assim que o arquivo é adicionado nesse local, a Cia passa a reconhecer o agente automaticamente, sem necessidade de qualquer outra configuração. Os agentes customizados são exibidos no menu da Cia nos Portais, em uma seção separada dos agentes padrão.<br>
<br>
[[Imagem:MenuAgentesCustomizados.png|semmoldura|center|800px]]
<br>
==Conversar com documentos==
<div align="justify">
A ferramenta de '''Conversar com documentos''' permite analisar, resumir e cruzar informações contidas em arquivos e relatórios através de modelos avançados de Inteligência Artificial integrados ao ERP CIGAM.

O acesso pode ser realizado a partir da tela principal da Cia Web (SaaS), clicando na opção correspondente ou digitando o assunto <code>#Documentos</code>, momento em que a aplicação é aberta em uma nova guia do navegador assim que digitada a primeira mensagem.

Além disto, podemos acessar a aplicação através dos Portais CIGAM, conforme descrito em [[GE_-_Como_Fazer_-_Cia_-_Como_acessar#Conversar_com_documentos|Como acessar]].

Para a utilização da aplicação, é necessário estar autenticado com um token de autorização CIGAM e com o endereço da API CIGAM devidamente parametrizado. Logo ao abrir, o sistema avalia o ambiente e valida a sessão do usuário em tempo real.

Estando os parâmetros validados, será gerado automaticamente um ID de conversação (''Conversation ID'') exclusivo para a sessão. Esta identificação é armazenada em cookies do navegador com validade de 24 horas, permitindo que a Cia armazene e mantenha o contexto contínuo de todas as mensagens e documentos anexados. Caso a página seja atualizada ou fechada dentro deste período, a sessão conectada e os arquivos são recuperados automaticamente.

<br>
<center>[[Arquivo:cia_conv_docs_01.png|nenhum|750px]]</center>
<br>

No primeiro acesso, é obrigatório marcar a opção '''Termo de consentimento''' para indicar ciência de que os dados e documentos selecionados para análise serão enviados aos modelos de IA de terceiros integrados com a Cia. Por segurança e conformidade, os campos de envio e a área de anexos permanecem bloqueados até que o consentimento seja confirmado. Uma vez aceito, uma mensagem de registro é inserida no histórico da conversa e a preferência é memorizada para a sessão.

Após confirmar o termo, a área de upload no painel lateral esquerdo é habilitada, permitindo anexar múltiplos arquivos simultaneamente, seja arrastando e soltando os documentos sobre a área de dropzone, seja clicando sobre ela para abrir a janela de seleção de arquivos.

A ferramenta suporta uma ampla variedade de formatos corporativos:
*'''Documentos de Texto e Portáteis:''' PDF (<code>.pdf</code>), Texto Simples (<code>.txt</code>), Word (<code>.doc</code>, <code>.docx</code>).
*'''Planilhas e Dados Tabulares:''' Planilhas Excel (<code>.xlsx</code>, <code>.xls</code>), Valores Separados por Vírgula (<code>.csv</code>).
*'''Arquivos de Estrutura de Dados:''' Arquivos <code>.json</code> e <code>.xml</code>.
*'''Imagens:''' Formatos de imagem (<code>.png</code>, <code>.jpg</code>, <code>.jpeg</code>, etc.).

No painel lateral, é possível visualizar o contador total de documentos anexados, o ícone específico do formato, o nome, o tamanho do arquivo formatado e a indicação de que o documento encontra-se ativo no contexto da conversa. Em dispositivos móveis ou telas menores, o painel lateral pode ser recolhido ou expandido através do botão retrátil no topo da barra.

Uma vez enviados para análise, os documentos permanecem registrados no contexto da conversa no servidor, não sendo necessário reenviá-los a cada nova pergunta. Caso deseje substituir ou remover os arquivos analisados, deve-se reiniciar o contexto através da opção de limpeza da conversa.

<br>
<center>[[Arquivo:cia_conv_docs_02.png|nenhum|750px]]</center>
<br>

Clicando no ícone da engrenagem localizado no canto superior direito da tela, temos acesso ao menu de opções e configurações da ferramenta:

*'''Modelo de IA:''' Permite selecionar o modelo de Inteligência Artificial desejado para o processamento documental (ex.: GPT-5.4 Recomendado, GPT-5.4 Mini, GPT-5.2 Alta Precisão, GPT-5.1 Raciocínio, GPT-4.1 Análise Documental, GPT-4o Versátil, GPT-4o Mini Econômico). A lista de modelos é atualizada dinamicamente a partir dos serviços disponíveis na Cia.
*'''Usuário Conectado:''' Exibe os dados do usuário autenticado no ERP CIGAM, incluindo nome, empresa (razão social / fantasia) e código de usuário.
*'''Ambiente & Sessão CIGAM:''' Apresenta o tipo de ambiente (produção ou depuração) e a URL da API CIGAM conectada, acompanhado de um botão de cópia rápida para facilitar diagnósticos e solicitações de suporte técnico.
*'''ID da Conversa Ativa:''' Exibe o identificador único da sessão com indicador visual de status em tempo real e botão para copiar o código do ID diretamente para a área de transferência.
*'''Limpar conversa:''' Permite reiniciar o contexto da conversa. Ao acionar esta opção, um balão interativo de confirmação é apresentado no histórico do chat (com as opções ''Limpar Conversa'' ou ''Cancelar''). Ao confirmar, o sistema solicita a exclusão da conversa no serviço da OpenAI para evitar registros órfãos, remove os documentos e cookies locais e gera um novo ID de conversação limpo.
*'''Documentação na wiki:''' Atalho que direciona diretamente aos manuais e guias de uso na CIGAM Wiki.

<br>
<center>[[Arquivo:cia_conv_docs_03.png|nenhum|750px]]</center>
<br>

Com os documentos anexados, podemos enviar perguntas e comandos no campo inferior para obter resumos executivos, explicações pontuais, cruzamento de dados entre arquivos distintos, localização de inconsistências ou extração de indicadores. Caso enviemos os arquivos sem digitar nenhuma mensagem complementar, a Cia aplicará o prompt de sistema padrão para realizar uma leitura analítica e retornar um resumo estruturado dos documentos.

O sistema dispõe de diretrizes de sistema corporativas (''System Prompt'') integradas ao ecossistema do ERP CIGAM, orientando o modelo a analisar com fidelidade os dados fornecidos, sem inventar informações ausentes.

Também é disponibilizado o recurso de '''Reconhecimento de Voz''' através do ícone de microfone (habilitado em conexões seguras HTTPS ou localhost). O recurso conta com reconhecimento inteligente de pontuação falada: ao ditar expressões como ''"vírgula"'', ''"ponto"'', ''"ponto e vírgula"'', ''"dois pontos"'', ''"interrogação"'', ''"exclamação"'', ''"hífen"'', ''"abre parênteses"'', ''"fecha parênteses"'' ou ''"nova linha"'', os termos são automaticamente substituídos pelos respectivos sinais gráficos e as frases são capitalizadas de forma automática.

<br>
<center>[[Arquivo:cia_conv_docs_04.png|nenhum|750px]]</center>
<br>

As respostas retornadas pela Cia contam com formatação Markdown avançada, estruturando o conteúdo em títulos hierárquicos, listas ordenadas ou em tópicos, citações em bloco e tabelas responsivas estilizadas.

Além disso, sempre que a análise envolver dados numéricos comparativos, demonstrativos contábeis/financeiros (como DRE, receitas e despesas), séries temporais ou valores tabulares, a Cia gera automaticamente gráficos visuais e interativos integrados diretamente na resposta:
*'''Tipos de Gráficos Gerados:''' Barras verticais, linhas de tendência, gráficos de pizza e rosca, estilizados na paleta de cores oficial da Cia e com valores numéricos formatados no padrão brasileiro (pt-BR).
*'''Exportação do Gráfico:''' Cada card de gráfico possui um botão de download no canto superior direito, permitindo baixar a imagem em formato PNG em alta resolução para inclusão imediata em relatórios, apresentações ou envio por e-mail.

<br>
<center>[[Arquivo:cia_conv_docs_05.png|nenhum|750px]]</center>
<br>

Podemos manter uma conversa contínua com diversos documentos e mensagens em múltiplos turnos de diálogo. A Cia preserva o histórico de perguntas e respostas anteriores, permitindo aprofundar análises, solicitar detalhamentos de itens específicos ou anexar novos arquivos complementares ao longo da conversa.

</div>
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, além do acesso rápido à Cia Web, algumas ferramentas do sistema disponibilizam o recurso "Analisar com a Cia".<br>

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM), disponível no menu lateral do Desktop, abre a Cia Web de forma integrada ao sistema, em uma janela do próprio CIGAM.<br>
<br>
Desde que as configurações necessárias tenham sido aplicadas, conforme [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Acesso rápido à Cia Web (SaaS)|Acesso rápido à Cia Web (SaaS)]], '''todas as funcionalidades da Cia Web estarão disponíveis normalmente''', da mesma forma que no acesso pelo navegador. Para conhecê-las, consulte a seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] desta documentação.<br>
<br>
[[Imagem:CiaAbertaDesktop.png|semmoldura|center|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''' está disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída. Em todas elas, o comportamento é o mesmo: a Cia analisa o conteúdo que está em uso na tela e gera um relatório com o resultado da análise, apresentado em uma nova página.<br>
<br>
Ao acionar a opção, o fluxo é o seguinte:<br>
<br>
'''1. Confirmação dos termos de uso'''<br>
Antes de qualquer envio, será exibida uma mensagem solicitando que o usuário concorde com o envio das informações para análise. Os dados enviados seguem as diretrizes de segurança, privacidade e não retenção descritas em [[#Recursos, configurações e segurança|Recursos, configurações e segurança]].<br>
<br>
[[Imagem:AnalisarCiaTermos.png|semmoldura|center|500px]]
<br>
'''2. Complemento do prompt (opcional)'''<br>
Em seguida, será apresentada uma caixa de texto para que o usuário complemente a solicitação, orientando a análise para algum ponto específico. O preenchimento é opcional e pode ser deixado em branco.<br>
<br>
Essa caixa de texto serve apenas para complementar o prompt base que a Cia monta automaticamente, e não altera o conteúdo que está sendo enviado. O recurso considera que o usuário já filtrou os dados na própria tela do CIGAM antes de acionar a análise. O prompt base é mantido oculto por ser extenso e técnico, evitando que o usuário precise conferi-lo a cada utilização.<br>
<br>
[[Imagem:AnalisarCiaPrompt.png|semmoldura|center|700px]]
<br>
'''3. Geração do relatório'''<br>
Após a confirmação, a Cia processa o conteúdo e apresenta o relatório em uma nova página flutuante, com a análise dos dados enviados.<br>
<br>
O próprio relatório informa a quantidade de dados que foi analisada, permitindo que o usuário veja o volume aproximado considerado e identifique se o conteúdo enviado corresponde ao que esperava.<br>
<br>
[[Imagem:AnalisarCiaRelatorio.png|semmoldura|center|700px]]
<br>

===Limite de conteúdo enviado===
Existe um limite para o volume de conteúdo enviado em cada análise, que varia conforme a versão do ambiente:<br>
<br>
* '''150 KB''' — desde a disponibilização do recurso, na versão '''250505.a'''.
* '''3 MB''' — a partir das patches '''250505.i''' e '''251103.a''', e da versão '''RC 260504'''.
<br>
Quando o conteúdo selecionado ultrapassa esse limite, a Cia exibe uma mensagem informando o tamanho excedido e a análise não é processada, ou seja, nenhum relatório será gerado.<br>
<br>
[[Imagem:AnalisarCiaLimite.png|semmoldura|center|600px]]
<br>
'''Esse limite não é parametrizável e não se trata de uma restrição imposta pela CIGAM.''' Ele decorre da própria capacidade dos modelos de IA integrados à Cia, que possuem um limite técnico de volume de dados que conseguem processar em uma única análise. Quando esse volume é ultrapassado, os modelos passam a analisar as informações por amostragem — ou seja, mesmo que fosse permitido enviar uma quantidade maior de dados, o modelo não analisaria todo o conteúdo, e o resultado seria menos preciso. O limite adotado pela Cia acompanha essa característica dos modelos e assegura que a análise seja feita sobre os dados completos.<br>
<br>
Além da qualidade da análise, há também a questão do tempo de processamento: quanto maior o volume enviado, maior o tempo de resposta do modelo, tornando a espera inviável para o uso no dia a dia.<br>
<br>
Por isso, o recurso foi feito para ser simples e direto: analisar, com um clique, os dados que o usuário já está visualizando pelos meios tradicionais do CIGAM, como grids filtrados e relatórios. Em ambientes com grande volume de dados, a prática recomendada é '''filtrar e consolidar as informações na própria tela antes de acionar a análise''', reduzindo o período ou o escopo consultado. Para análises de períodos maiores, recomenda-se utilizar dados já consolidados, como totalizadores e relatórios sintéticos, em vez de listagens analíticas completas.<br>
<br>
A CIGAM está trabalhando em outras ferramentas que, por processarem os dados de forma diferente, permitirão trabalhar com volumes maiores de informação.<br>

Para saber como acessar o recurso em cada ferramenta, consulte: [[GE - Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Configuração da Cia IA do CIGAM]]

GE - Como Fazer - Uso da Cia - IA do CIGAM

2026-10-15T12:22:45Z

Vinicius.moder: /* Análises por IA e compartilhamento */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como_Fazer_Utilidades/Diversos_6]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer - Uso da Cia - IA do CIGAM]]

=Recursos, configurações e segurança=
A Cia - IA do CIGAM oferece diversas funcionalidades e atua como um hub centralizador para os recursos de inteligência artificial utilizados nas soluções CIGAM. Para garantir o correto funcionamento desses recursos, é necessário verificar se os pré-requisitos e as configurações foram realizados adequadamente. Para mais informações, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM|Como Fazer configuração da Cia IA do CIGAM]]
<br><br>
Todas as soluções de IA do CIGAM são integradas por meio dos serviços da Cia. A Cia possui integração com diferentes provedores de IA de terceiros, como OpenAI, Google, Anthropic, entre outros. Essas integrações são realizadas por meio de contas e serviços contratados, com condições de uso que asseguram que os dados trafegados não sejam utilizados para treinamento dos modelos, identificação de origem, publicidade, anúncios ou qualquer outra finalidade não prevista.
<br><br>
No caso de IAs open-source integradas à Cia, os modelos são executados dentro dos domínios da CIGAM, mantendo as mesmas premissas aplicadas às IAs contratadas: não utilização dos dados para treinamento de modelos, não identificação da origem das informações e ausência de retenção dos dados processados.
<br><br>
Além disso, sempre que houver envio explícito de dados pelo usuário por meio das funcionalidades da Cia disponíveis nas soluções CIGAM, será apresentado um diálogo de confirmação, permitindo que o usuário aceite o envio dessas informações. Os dados enviados serão tratados conforme as mesmas diretrizes de segurança, privacidade e não retenção descritas anteriormente.
<br><br>
Esta documentação apresenta o uso da Cia e está organizada conforme a forma de acesso: [[#Cia Web (SaaS)|Cia Web (SaaS)]], [[#Portais|Portais]] e [[#Desktop|Desktop]].
<br><br>
Caso tenha dúvidas sobre onde encontrar a Cia em cada uma dessas plataformas, ou sobre quais ferramentas do CIGAM possuem recursos integrados a ela, consulte a documentação específica de acesso: [[GE - Como Fazer - Cia - Como acessar|Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Cia Web (SaaS)=
A Cia Web é a aplicação web que centraliza todas as funcionalidades da Cia. Ela pode ser acessada diretamente pelo navegador do seu computador ou dispositivo móvel, ou ainda a partir do Desktop e dos Portais, sem a necessidade de novo login.
<br><br>

<center><youtube>https://youtu.be/DFGtRtPF75A</youtube></center>
<br>

==Primeiro acesso==
A Cia Web pode ser acessada diretamente pelo navegador, utilizando o seguinte endereço: https://services.cigam.cloud/cia/index.html
<br><br>
'''Importante:''' o usuário que for realizar o login precisa ter a autenticação em duas etapas habilitada. Para saber como configurá-la, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]]
<br><br>
Ao acessar pelo endereço, será necessário preencher algumas informações para que a Cia consiga validar seu acesso e consultar seus dados:<br>
* Informar a API do seu CIGAM Server, para garantir o direcionamento correto da base de dados.<br><br>

[[Imagem:CiaAPI.png|semmoldura|center|700px]]<br>

* Informar usuário e senha de login e seu código de verificação:<br><br>

[[Imagem:CiaLogin.png|semmoldura|center|700px]]
<br>
[[Imagem:CiaCodVerif.png|semmoldura|center|700px]]<br>

* Caso não queira aguardar ou informar o código de verificação, você pode optar por responder à pergunta secreta, clicando no botão “Pergunta Secreta” exibido na imagem acima.<br><br>

[[Imagem:CiaLoginA2F.png|semmoldura|center|700px]]
<br>

==Conhecendo a tela da Cia==
Após realizar o login, a Cia carregará automaticamente as informações e dados necessários do ambiente e será iniciada no assunto '''#Geral''', identificado pelo botão localizado à esquerda da caixa de texto.

[[Imagem:CiaGeral.png|semmoldura|center|700px]]
<br><br>
Ao clicar nesse botão, será exibida uma lista com todos os assuntos disponíveis, permitindo que você selecione aquele com o qual deseja interagir.<br><br>
Além disso, você pode digitar diretamente na caixa de texto o '''#Assunto''' que deseja utilizar, e a Cia entenderá automaticamente o tema da sua mensagem.<br><br>
Também é possível '''formular uma pergunta seguida de um #Assunto''' para interagir com qualquer assunto, mesmo que ele não esteja selecionado no momento.

[[Imagem:CiaAberta.png|semmoldura|center|700px]]
<br>
Ao selecionar um assunto, serão exibidas automaticamente dicas e sugestões sobre o tema escolhido, além de exemplos clicáveis que, ao serem selecionados, são processados de forma imediata.<br><br>
Além disso, ao digitar um ponto de interrogação (?) na caixa de texto, será exibida uma lista com todas as interações disponíveis para o assunto selecionado, facilitando a descoberta de comandos e possibilidades de uso.

[[Imagem:CiaDicas.png|semmoldura|center|700px]]
<br>
Outra funcionalidade prática é a possibilidade de reenviar perguntas já feitas no chat. Para isso, basta posicionar o mouse sobre a pergunta desejada e clicar no ícone de “Reenviar”. Ao passar o mouse sobre a mensagem, também será exibido o horário de envio.
<br>
[[Imagem:CiaReenviar.png|semmoldura|center|400px]]
<br>
Além disso, você pode utilizar as setas do teclado (⬆️ para cima e ⬇️ para baixo) na caixa de texto para navegar pelas últimas perguntas enviadas para o #Assunto selecionado, facilitando o reuso de interações anteriores.

===Ícones da caixa de texto===
Na caixa de texto, você encontrará alguns ícones com as seguintes funções:

<center>
{| class="wikitable"
|-
! !! Ação
|-
|center|[[Imagem:CiaUltPerg.png]] || '''Histórico de Perguntas''' – Ao clicar, é exibido o histórico das perguntas já realizadas para o assunto selecionado.
|-
|center|[[Imagem:CiaEnviar.png]] || '''Enviar''' – Envia o conteúdo digitado na caixa de texto.
|-
|center|[[Imagem:CiaFala.png]] || '''Falar''' – Permite falar ao invés de digitar, usando o recurso de voz.
|-
|center|[[Imagem:CiaExpandir.png]] || '''Expandir''' – Aumenta a altura da caixa de texto para facilitar a digitação de mensagens longas.
|-
|center|[[Imagem:CiaRecolher.png]] || '''Recolher''' – Reduz a caixa de texto ao tamanho padrão.
|}
</center>
{{VoltarInicio}}

==Assuntos disponíveis==

===Geral===
Nesse assunto, é possível conversar livremente com a Cia sobre qualquer um dos assuntos disponíveis. Se encontrar dificuldades para obter a resposta desejada, experimente selecionar um assunto específico, o que pode gerar resultados mais precisos.<br><br>
Se houver muitas respostas correspondentes, a Cia não executará nenhuma automaticamente. Em vez disso, exibirá uma opção com os valores possíveis, permitindo que você selecione manualmente a melhor alternativa.

[[Imagem:CiaGeralOpcoes.png|semmoldura|center|700px]]
<br>
Caso a Cia encontre uma resposta com confiança significativamente maior que as demais, ela será executada automaticamente.
<br><br>
No entanto, se você selecionar a opção “Não era bem isso o que eu queria”, a Cia exibirá outras opções relacionadas ao que foi solicitado, apresentando também um indicador de semáforo com a porcentagem de confiança de cada alternativa.

[[Imagem:CiaGeralOpcaoCerta.png|semmoldura|center|600px]]

===Ajuda, Vídeos e Auditor===
Conheça melhor o ERP com a ajuda da Wiki e Cia, assista vídeos sobre o CIGAM e audite seu ambiente.

====Ajuda====
Nesse assunto, você pode acessar o Chatbot da assistente virtual, onde você pode tirar dúvidas e consultar conteúdos da CIGAM Wiki enviando perguntas diretamente nela.<br>
<br>
'''Importante:''' neste assunto, a Cia atua dedicada à Wiki, focada exclusivamente nos conteúdos da documentação. As demais funcionalidades e atalhos da Cia não estarão disponíveis nesse contexto.

====Vídeos====
Nesse assunto, é possível procurar por vídeos relacionados ao tema desejado. O resultado será apresentado em forma de lista, contendo os vídeos encontrados e os tempos exatos em que o assunto começa a ser abordado, de acordo com o termo ou palavra pesquisada.

====Auditor====
Neste assunto, é possível verificar o status do sistema e identificar possíveis problemas ou inconsistências. O resultado será exibido em forma de tabela, contendo os dados retornados para facilitar a análise.

===Painéis BI, Portais e Relatórios===
Explore dashboards do BI, interaja com Portais intuitivos e execute relatórios personalizados.

====Painéis BI====
Nesse assunto, é possível abrir dashboards do BI já configurados para o usuário, permitindo sua visualização diretamente na tela.
Ao abrir um dashboard, você também pode interagir com ele, solicitando inserção de filtros, dimensões, métricas, transformações e outros ajustes.<br>
Cada dashboard aberto exibirá uma guia com as “Interações” disponíveis para aquele painel específico.
<br><br>
Além disso, ao selecionar o assunto '''#Painéis do BI''', é possível solicitar que a Cia crie um dashboard do zero.
Por exemplo: "Crie um dashboard para ver meu fluxo de caixa". Você pode ainda solicitar que métricas, dimensões e filtros sejam adicionados durante a criação, ou pedir dashboards separados por áreas.
<br><br>
'''Importante:''' caso o usuário não possua acesso ao BI ou este não esteja implementado na base de dados, será exibida uma mensagem informativa no momento do login na Cia.

====Portais====
Quando este assunto é utilizado, o resultado será sempre a abertura de uma tela dos Portais, permitindo ao usuário acessar diretamente os conteúdos e funcionalidades disponíveis nesse ambiente.
<br><br>
Essa abertura é feita de forma integrada, garantindo uma navegação contínua entre a Cia e os Portais, sem necessidade de realizar novo login ou sair da plataforma.

====Relatórios====
Ao utilizar esse assunto, será exibida uma tela para preenchimento de filtros, permitindo a emissão de relatórios web.
<br><br>
Para que essa funcionalidade opere corretamente, é necessário garantir que a instalação da CDN e da Pesquisa Dinâmica no servidor de aplicação esteja configurada de forma adequada.
<br><br>
Os relatórios exibidos aqui são os mesmos disponíveis nos Portais CIGAM, portanto é essencial que esses componentes também estejam funcionando corretamente nesses Portais.

===Qual, Faça, Consultar, Listar, Analisar e Insights===
Crie registros, analise informações ou liste dados cadastrados no CIGAM.

====Qual====
Nesse assunto, a Cia vai consultar e processar informações diretamente no ERP, usando os dados e relacionamentos disponíveis no CIGAM, e retornar os resultados em forma de texto para você visualizar.
<br><br>
'''Importante:''' nem todas as opções estão liberadas. Para ver quais você pode usar, digite ? na caixa de texto. A Cia vai mostrar uma lista com todos os comandos e funções disponíveis.

====Faça====
Nesse assunto, a Cia sempre fará um processamento no CIGAM e retornará o status do resultado. Por exemplo, você pode solicitar que a Cia crie um alerta ou até mesmo crie uma nova empresa no sistema.
<br><br>
'''Dica:''' para saber quais treinamentos ou comandos estão disponíveis, digite ? na caixa de texto. A Cia mostrará uma lista com todas as opções implementadas para você usar.

====Consultar====
Nesse assunto, você poderá fazer consultas de dados para obter listagens de registros, conforme os treinamentos de tabelas disponíveis. O resultado será apresentado em forma de tabela, exibindo os dados retornados. Já existem diversas Views prontas, para que você possa listar informações de forma mais completa e rápida.
<br><br>
'''Dica:''' para ver exemplos de consultas já implementadas, digite ? na caixa de texto.

====Listar====
Nesse assunto, você pode montar sua própria consulta de dados, escolhendo os filtros e parâmetros para gerar uma listagem personalizada. Diferente do assunto #Consultar, aqui é possível utilizar qualquer tabela do CIGAM para montar sua consulta, escrevendo em linguagem natural o que deseja buscar.
<br><br>
'''Dica:''' para ver todas as tabelas disponíveis, digite ? na caixa de texto.

====Analisar====
Analise o arquivo selecionado para gerar gráficos interativos e informativos, apresentando insights relevantes que ajudam a identificar tendências, padrões e oportunidades de melhoria.
<br><br>
Esse recurso oferece uma visualização clara e intuitiva dos dados, facilitando a interpretação das informações e apoiando a tomada de decisões estratégicas.
<br><br>
'''Aviso:''' para utilizar esta funcionalidade, é necessário concordar que os dados enviados serão processados por modelos de IA de terceiros integrados à Cia.

[[Imagem:AnalisarCia.png|semmoldura|center|600px]]

====Insights====
Gere insights inteligentes a partir dos dados de uma consulta, com análises automáticas realizadas pela Cia, que identificam padrões, tendências e possíveis pontos de atenção. Esse recurso ajuda a transformar dados brutos em informações acionáveis, facilitando a tomada de decisões estratégicas e otimizando processos.
<br><br>
'''Aviso:''' ao utilizar o assunto “Insights”, você concorda que os dados e informações analisados poderão ser enviados para modelos de IA de terceiros integrados à Cia, exclusivamente para processamento e geração dos resultados apresentados.

===IA Generativa e Pesquisa na Internet===
Converse com a IA sobre assuntos diversos, crie conteúdos e pesquise na internet sobre qualquer coisa.

====IA Generativa====
Nesse assunto, ao interagir com a IA Generativa, você poderá fazer qualquer tipo de pergunta ou solicitação, de forma livre e criativa.
O resultado exibido será exatamente a resposta gerada pela IA, sem complementos da Cia. Você pode, por exemplo, solicitar que a IA melhore ou reformule um texto, crie conteúdos ou resuma informações.
<br><br>
'''Importante:''' nesse assunto, a Cia não estará integrada aos serviços e sistemas do CIGAM — a interação é exclusivamente com a IA Generativa.

====Pesquisa na Internet====
Use esse assunto para fazer pesquisas na internet e visualizar os resultados diretamente integrados na Cia, sem precisar sair da plataforma. Você pode pesquisar qualquer tema de interesse e abrir os links retornados para acessar conteúdos, notícias e informações de forma rápida e prática.
{{VoltarInicio}}

==Configurações==
O ícone de engrenagem, localizado no canto superior direito da página, reúne recursos de informação e gerenciamento. As opções disponíveis são:
* '''Respostas com áudio:''' quando ativado, as respostas da Cia são narradas em voz alta.
* '''Ambiente atual do CIGAM:''' exibe na tela o usuário logado e o ambiente em uso.
* '''Ver consumo:''' mostra a quantidade de tokens já utilizados e os usuários que geraram consumo.
* '''Limpar dados de navegação:''' exibe uma mensagem explicando como limpar os dados de navegação do navegador.
* '''Limpar cookies:''' apaga os dados armazenados localmente, permitindo informar novamente a API e realizar um novo login.
* '''Instalar aplicativo:''' instala a Cia como aplicativo no dispositivo, criando um atalho na tela inicial.
* '''Documentação na wiki:''' direciona para a documentação da Cia na CIGAM Wiki.
* '''Sair:''' encerra a sessão do usuário, permitindo realizar login com outro usuário.
<br>
[[Imagem:ConfiguracoesCia.png|semmoldura|center|500px]]
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, além do acesso à Cia Web pelo menu de mosaico, estão disponíveis recursos de IA que atuam diretamente nas telas em que você está trabalhando. Esses recursos não exigem parametrização e são apresentados de acordo com o contexto da tela.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia Web a partir dos Portais é feito pelo ícone de mosaico, onde está disponível o ícone da Cia - IA do CIGAM.<br>
<br>
[[Imagem:mosaicoCia.png|semmoldura|center|800px]]
<br>
A Cia será aberta de forma integrada, sem a necessidade de novo login, e todas as funcionalidades descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] estarão disponíveis normalmente.<br>

==Geração de conteúdo==
Na barra superior dos Portais está disponível um ícone com um menu de contexto que permite interagir com os '''campos de texto''' de qualquer parte dos Portais. As opções disponíveis permitem melhorar textos, criar conteúdos, revisar a gramática, entre outras ações.<br>
<br>
[[Imagem:comandosCia.png|semmoldura|center|650px]]
<br>
A partir da versão '''Beta 260601''', essas opções passaram a ser exibidas em uma seção separada, chamada '''Geração de conteúdo''', apresentada no mesmo menu em que ficam os agentes.<br>
<br>
[[Imagem:MenuGeracaoConteudoAgentes.png|semmoldura|center|800px]]
<br>
O campo processado é sempre o '''último campo em que o cursor esteve posicionado''' antes de abrir o menu da Cia. Por isso, basta clicar no campo desejado e, em seguida, acionar o menu e escolher o comando.<br>
<br>
Para que o comando seja executado, o campo precisa ser um '''campo de texto válido''' e conter, no mínimo, '''três palavras'''. Caso contrário, será apresentada uma mensagem informando que o conteúdo não atende aos requisitos.<br>
<br>
Após o processamento, o conteúdo gerado é aplicado automaticamente no campo, substituindo o texto anterior, sem necessidade de confirmação.<br>
<br>
Essa funcionalidade também está disponível em telas modais, ou seja, janelas sobrepostas com interações:<br>
<br>
[[Imagem:comandosModalCia.png|semmoldura|center|800px]]
<br>

==Agentes==
A partir da versão '''Beta 260601''', o menu da Cia nos Portais passou a disponibilizar também o acesso aos agentes, tanto nos Portais MVC quanto nos Portais React.<br>
<br>
Ao abrir o menu da Cia, os agentes disponíveis são detectados automaticamente de acordo com a tela que está sendo acessada, ou seja, as opções apresentadas variam conforme a página aberta.<br>
<br>
[[Imagem:MenuAgentesCia.png|semmoldura|center|800px]]
<br>

===Como os agentes são disponibilizados===
A disponibilização de cada agente pode ocorrer de quatro formas:<br>
<br>
* '''Por contexto:''' o agente é apresentado quando a Cia identifica que a tela acessada corresponde ao assunto tratado por ele. Por exemplo, um agente sobre Ordem de Produção será disponibilizado ao acessar uma página cujo contexto seja identificado como Ordem de Produção.
<br>
* '''Por parâmetro:''' o agente é apresentado quando a Cia identifica, na tela, um parâmetro com o valor esperado por ele. Por exemplo, um agente de Pedidos será disponibilizado quando existir na tela um parâmetro que contenha o código do pedido.
<br>
* '''Por contexto e parâmetro:''' o agente é apresentado somente quando as duas condições forem atendidas ao mesmo tempo.
<br>
* '''Sempre disponível:''' o agente é apresentado em qualquer tela, independentemente do contexto ou dos parâmetros.
<br>

===Resultado do processamento===
Após o processamento, o retorno do agente pode ser apresentado de duas formas, conforme o que foi executado:<br>
<br>
* Em uma '''nova guia''' do navegador, quando o agente gera algum conteúdo ou relatório como resultado.
<br>
[[Imagem:AgentesRetornoGuia.png|semmoldura|center|800px]]
<br>
* Em uma '''janela modal''', dentro da própria página em que o usuário está, quando o retorno é uma mensagem.
<br>
[[Imagem:AgentesRetornoModal.png|semmoldura|center|800px]]
<br>
<div align="justify>
A partir da versão '''Beta 261005''', quando o resultado do agente é apresentado em uma nova guia, a página passa a disponibilizar também opções para utilização e compartilhamento da análise.
</div>
<br>
[[Imagem:resultadoAnalise.png|semmoldura|center|800px]]
<br>
<div align="justify">
No cabeçalho são apresentados o nome do agente executado e as opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>
<div align="justify">
=====Compartilhamento por e-mail=====
A janela abaixo é exibida ao quando selecionada a opção '''E-mail''':
</div>
<br>
[[Imagem:modalEmail.png|semmoldura|center|800px]]
<br>
<div align="justify">

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
</div>

==Editor de Agentes==
A partir da versão '''Beta 261005''', o menu passou a disponibilizar o acesso à ferramenta '''Editor de Agentes''', que permite criar seus próprios agentes.<br>
<br>
[[Imagem:EditorAgentesCia.png|semmoldura|center|800px]]
<br>
Ao clicar na opção, será aberta uma página web no formato de assistente (wizard), com cada etapa explicada de forma detalhada. Basta preencher as informações do agente conforme a sua necessidade e avançar pelos passos até a conclusão.<br>
<br>
[[Imagem:EditorAgentesWizard.png|semmoldura|center|800px]]
<br>
Ao final do processo, será gerado um arquivo com a extensão '''.cgagt''', que contém a definição do agente criado.<br>
<br>

===Disponibilizando o agente criado===
Para que o agente passe a ser exibido nos Portais, o arquivo '''.cgagt''' precisa ser colocado na aplicação da API, dentro da pasta raiz da aplicação.<br>
<br>
É necessário que existam as pastas '''Exclusivo''' e, dentro dela, '''Agentes'''. Caso não existam, elas devem ser criadas manualmente. O arquivo deve ser colocado dentro dessa estrutura, ficando da seguinte forma:<br>
<br>
/api/exclusivo/agentes/
<br>
Assim que o arquivo é adicionado nesse local, a Cia passa a reconhecer o agente automaticamente, sem necessidade de qualquer outra configuração. Os agentes customizados são exibidos no menu da Cia nos Portais, em uma seção separada dos agentes padrão.<br>
<br>
[[Imagem:MenuAgentesCustomizados.png|semmoldura|center|800px]]
<br>
==Conversar com documentos==
<div align="justify">
Ao clicar na opção "Conversar com documentos" seremos direcionados à página da aplicação.

Precisamos acessar com nosso token de autorização CIGAM e termos nossa API configurada corretamente.

Tendo isto devidamente parametrizado, ao iniciar a aplicação, será gerado um ID de conversação para nossa sessão, esta informação é importante porque através deste ID a Cia armazena o contexto de todas as mensagens e documentos que enviarmos nesta conversa.

<br>
<center>[[Arquivo:cia_conv_docs_01.png|nenhum|750px]]</center>
<br>

No primeiro acesso, teremos de marcar o checkbox "Termo de consentimento" para indicar que estamos cientes de que os dados serão analisados e enviados para os modelos de IA de terceiros integrados com a Cia.

Confirmando esta opção, teremos como anexar arquivos no menu lateral esquerdo, arrastando os arquivos e soltando na área, ou clicando e selecionando, podendo selecionar múltiplos arquivos de uma única vez.

<br>
<center>[[Arquivo:cia_conv_docs_02.png|nenhum|750px]]</center>
<br>

Clicando no ícone da engrenagem localizada no canto superior direito da tela, poderemos acessar as opções.

*Podemos selecionar o modelo de IA escolhido.
*Podemos visualizar o usuário autenticado e as informações de licença.
*Podemos visualizar e copiar as informações de sessão de API.
*Podemos visualizar e copiar nosso ID de conversação.
*Podemos limpar a conversa, forçando o sistema a gerar um novo ID de conversação, com objetivo de recomeçar nosso contexto de análise. Será apresentada uma mensagem de confirmação antes de limpar o contexto.
*Podemos acessar a documentação da ferramenta na Wiki.

<br>
<center>[[Arquivo:cia_conv_docs_03.png|nenhum|750px]]</center>
<br>

Podemos enviar arquivos e mensagens para complementar a análise. O sistema possui um prompt de sistema padrão para auxiliar o modelo a analisar e retornar os dados de maneira estruturada.

Há um ícone de microfone para reconhecimento de voz.

<br>
<center>[[Arquivo:cia_conv_docs_04.png|nenhum|750px]]</center>
<br>

As análises são geradas contendo gráficos e/ou tabelas quando aplicável.

<br>
<center>[[Arquivo:cia_conv_docs_05.png|nenhum|750px]]</center>
<br>

Podemos ter diversos documentos e mensagens.

</div>
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, além do acesso rápido à Cia Web, algumas ferramentas do sistema disponibilizam o recurso "Analisar com a Cia".<br>

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM), disponível no menu lateral do Desktop, abre a Cia Web de forma integrada ao sistema, em uma janela do próprio CIGAM.<br>
<br>
Desde que as configurações necessárias tenham sido aplicadas, conforme [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Acesso rápido à Cia Web (SaaS)|Acesso rápido à Cia Web (SaaS)]], '''todas as funcionalidades da Cia Web estarão disponíveis normalmente''', da mesma forma que no acesso pelo navegador. Para conhecê-las, consulte a seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] desta documentação.<br>
<br>
[[Imagem:CiaAbertaDesktop.png|semmoldura|center|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''' está disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída. Em todas elas, o comportamento é o mesmo: a Cia analisa o conteúdo que está em uso na tela e gera um relatório com o resultado da análise, apresentado em uma nova página.<br>
<br>
Ao acionar a opção, o fluxo é o seguinte:<br>
<br>
'''1. Confirmação dos termos de uso'''<br>
Antes de qualquer envio, será exibida uma mensagem solicitando que o usuário concorde com o envio das informações para análise. Os dados enviados seguem as diretrizes de segurança, privacidade e não retenção descritas em [[#Recursos, configurações e segurança|Recursos, configurações e segurança]].<br>
<br>
[[Imagem:AnalisarCiaTermos.png|semmoldura|center|500px]]
<br>
'''2. Complemento do prompt (opcional)'''<br>
Em seguida, será apresentada uma caixa de texto para que o usuário complemente a solicitação, orientando a análise para algum ponto específico. O preenchimento é opcional e pode ser deixado em branco.<br>
<br>
Essa caixa de texto serve apenas para complementar o prompt base que a Cia monta automaticamente, e não altera o conteúdo que está sendo enviado. O recurso considera que o usuário já filtrou os dados na própria tela do CIGAM antes de acionar a análise. O prompt base é mantido oculto por ser extenso e técnico, evitando que o usuário precise conferi-lo a cada utilização.<br>
<br>
[[Imagem:AnalisarCiaPrompt.png|semmoldura|center|700px]]
<br>
'''3. Geração do relatório'''<br>
Após a confirmação, a Cia processa o conteúdo e apresenta o relatório em uma nova página flutuante, com a análise dos dados enviados.<br>
<br>
O próprio relatório informa a quantidade de dados que foi analisada, permitindo que o usuário veja o volume aproximado considerado e identifique se o conteúdo enviado corresponde ao que esperava.<br>
<br>
[[Imagem:AnalisarCiaRelatorio.png|semmoldura|center|700px]]
<br>

===Limite de conteúdo enviado===
Existe um limite para o volume de conteúdo enviado em cada análise, que varia conforme a versão do ambiente:<br>
<br>
* '''150 KB''' — desde a disponibilização do recurso, na versão '''250505.a'''.
* '''3 MB''' — a partir das patches '''250505.i''' e '''251103.a''', e da versão '''RC 260504'''.
<br>
Quando o conteúdo selecionado ultrapassa esse limite, a Cia exibe uma mensagem informando o tamanho excedido e a análise não é processada, ou seja, nenhum relatório será gerado.<br>
<br>
[[Imagem:AnalisarCiaLimite.png|semmoldura|center|600px]]
<br>
'''Esse limite não é parametrizável e não se trata de uma restrição imposta pela CIGAM.''' Ele decorre da própria capacidade dos modelos de IA integrados à Cia, que possuem um limite técnico de volume de dados que conseguem processar em uma única análise. Quando esse volume é ultrapassado, os modelos passam a analisar as informações por amostragem — ou seja, mesmo que fosse permitido enviar uma quantidade maior de dados, o modelo não analisaria todo o conteúdo, e o resultado seria menos preciso. O limite adotado pela Cia acompanha essa característica dos modelos e assegura que a análise seja feita sobre os dados completos.<br>
<br>
Além da qualidade da análise, há também a questão do tempo de processamento: quanto maior o volume enviado, maior o tempo de resposta do modelo, tornando a espera inviável para o uso no dia a dia.<br>
<br>
Por isso, o recurso foi feito para ser simples e direto: analisar, com um clique, os dados que o usuário já está visualizando pelos meios tradicionais do CIGAM, como grids filtrados e relatórios. Em ambientes com grande volume de dados, a prática recomendada é '''filtrar e consolidar as informações na própria tela antes de acionar a análise''', reduzindo o período ou o escopo consultado. Para análises de períodos maiores, recomenda-se utilizar dados já consolidados, como totalizadores e relatórios sintéticos, em vez de listagens analíticas completas.<br>
<br>
A CIGAM está trabalhando em outras ferramentas que, por processarem os dados de forma diferente, permitirão trabalhar com volumes maiores de informação.<br>

Para saber como acessar o recurso em cada ferramenta, consulte: [[GE - Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Configuração da Cia IA do CIGAM]]

Arquivo:CiaWebResultadoAnalise.png

2026-10-15T12:14:00Z

Vinicius.moder:

GE - Como Fazer - Uso da Cia - IA do CIGAM

2026-10-15T12:13:00Z

Vinicius.moder: /* Assuntos disponíveis */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como_Fazer_Utilidades/Diversos_6]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer - Uso da Cia - IA do CIGAM]]

=Recursos, configurações e segurança=
A Cia - IA do CIGAM oferece diversas funcionalidades e atua como um hub centralizador para os recursos de inteligência artificial utilizados nas soluções CIGAM. Para garantir o correto funcionamento desses recursos, é necessário verificar se os pré-requisitos e as configurações foram realizados adequadamente. Para mais informações, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM|Como Fazer configuração da Cia IA do CIGAM]]
<br><br>
Todas as soluções de IA do CIGAM são integradas por meio dos serviços da Cia. A Cia possui integração com diferentes provedores de IA de terceiros, como OpenAI, Google, Anthropic, entre outros. Essas integrações são realizadas por meio de contas e serviços contratados, com condições de uso que asseguram que os dados trafegados não sejam utilizados para treinamento dos modelos, identificação de origem, publicidade, anúncios ou qualquer outra finalidade não prevista.
<br><br>
No caso de IAs open-source integradas à Cia, os modelos são executados dentro dos domínios da CIGAM, mantendo as mesmas premissas aplicadas às IAs contratadas: não utilização dos dados para treinamento de modelos, não identificação da origem das informações e ausência de retenção dos dados processados.
<br><br>
Além disso, sempre que houver envio explícito de dados pelo usuário por meio das funcionalidades da Cia disponíveis nas soluções CIGAM, será apresentado um diálogo de confirmação, permitindo que o usuário aceite o envio dessas informações. Os dados enviados serão tratados conforme as mesmas diretrizes de segurança, privacidade e não retenção descritas anteriormente.
<br><br>
Esta documentação apresenta o uso da Cia e está organizada conforme a forma de acesso: [[#Cia Web (SaaS)|Cia Web (SaaS)]], [[#Portais|Portais]] e [[#Desktop|Desktop]].
<br><br>
Caso tenha dúvidas sobre onde encontrar a Cia em cada uma dessas plataformas, ou sobre quais ferramentas do CIGAM possuem recursos integrados a ela, consulte a documentação específica de acesso: [[GE - Como Fazer - Cia - Como acessar|Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Cia Web (SaaS)=
A Cia Web é a aplicação web que centraliza todas as funcionalidades da Cia. Ela pode ser acessada diretamente pelo navegador do seu computador ou dispositivo móvel, ou ainda a partir do Desktop e dos Portais, sem a necessidade de novo login.
<br><br>

<center><youtube>https://youtu.be/DFGtRtPF75A</youtube></center>
<br>

==Primeiro acesso==
A Cia Web pode ser acessada diretamente pelo navegador, utilizando o seguinte endereço: https://services.cigam.cloud/cia/index.html
<br><br>
'''Importante:''' o usuário que for realizar o login precisa ter a autenticação em duas etapas habilitada. Para saber como configurá-la, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]]
<br><br>
Ao acessar pelo endereço, será necessário preencher algumas informações para que a Cia consiga validar seu acesso e consultar seus dados:<br>
* Informar a API do seu CIGAM Server, para garantir o direcionamento correto da base de dados.<br><br>

[[Imagem:CiaAPI.png|semmoldura|center|700px]]<br>

* Informar usuário e senha de login e seu código de verificação:<br><br>

[[Imagem:CiaLogin.png|semmoldura|center|700px]]
<br>
[[Imagem:CiaCodVerif.png|semmoldura|center|700px]]<br>

* Caso não queira aguardar ou informar o código de verificação, você pode optar por responder à pergunta secreta, clicando no botão “Pergunta Secreta” exibido na imagem acima.<br><br>

[[Imagem:CiaLoginA2F.png|semmoldura|center|700px]]
<br>

==Conhecendo a tela da Cia==
Após realizar o login, a Cia carregará automaticamente as informações e dados necessários do ambiente e será iniciada no assunto '''#Geral''', identificado pelo botão localizado à esquerda da caixa de texto.

[[Imagem:CiaGeral.png|semmoldura|center|700px]]
<br><br>
Ao clicar nesse botão, será exibida uma lista com todos os assuntos disponíveis, permitindo que você selecione aquele com o qual deseja interagir.<br><br>
Além disso, você pode digitar diretamente na caixa de texto o '''#Assunto''' que deseja utilizar, e a Cia entenderá automaticamente o tema da sua mensagem.<br><br>
Também é possível '''formular uma pergunta seguida de um #Assunto''' para interagir com qualquer assunto, mesmo que ele não esteja selecionado no momento.

[[Imagem:CiaAberta.png|semmoldura|center|700px]]
<br>
Ao selecionar um assunto, serão exibidas automaticamente dicas e sugestões sobre o tema escolhido, além de exemplos clicáveis que, ao serem selecionados, são processados de forma imediata.<br><br>
Além disso, ao digitar um ponto de interrogação (?) na caixa de texto, será exibida uma lista com todas as interações disponíveis para o assunto selecionado, facilitando a descoberta de comandos e possibilidades de uso.

[[Imagem:CiaDicas.png|semmoldura|center|700px]]
<br>
Outra funcionalidade prática é a possibilidade de reenviar perguntas já feitas no chat. Para isso, basta posicionar o mouse sobre a pergunta desejada e clicar no ícone de “Reenviar”. Ao passar o mouse sobre a mensagem, também será exibido o horário de envio.
<br>
[[Imagem:CiaReenviar.png|semmoldura|center|400px]]
<br>
Além disso, você pode utilizar as setas do teclado (⬆️ para cima e ⬇️ para baixo) na caixa de texto para navegar pelas últimas perguntas enviadas para o #Assunto selecionado, facilitando o reuso de interações anteriores.

===Ícones da caixa de texto===
Na caixa de texto, você encontrará alguns ícones com as seguintes funções:

<center>
{| class="wikitable"
|-
! !! Ação
|-
|center|[[Imagem:CiaUltPerg.png]] || '''Histórico de Perguntas''' – Ao clicar, é exibido o histórico das perguntas já realizadas para o assunto selecionado.
|-
|center|[[Imagem:CiaEnviar.png]] || '''Enviar''' – Envia o conteúdo digitado na caixa de texto.
|-
|center|[[Imagem:CiaFala.png]] || '''Falar''' – Permite falar ao invés de digitar, usando o recurso de voz.
|-
|center|[[Imagem:CiaExpandir.png]] || '''Expandir''' – Aumenta a altura da caixa de texto para facilitar a digitação de mensagens longas.
|-
|center|[[Imagem:CiaRecolher.png]] || '''Recolher''' – Reduz a caixa de texto ao tamanho padrão.
|}
</center>
{{VoltarInicio}}

==Assuntos disponíveis==

===Geral===
Nesse assunto, é possível conversar livremente com a Cia sobre qualquer um dos assuntos disponíveis. Se encontrar dificuldades para obter a resposta desejada, experimente selecionar um assunto específico, o que pode gerar resultados mais precisos.<br><br>
Se houver muitas respostas correspondentes, a Cia não executará nenhuma automaticamente. Em vez disso, exibirá uma opção com os valores possíveis, permitindo que você selecione manualmente a melhor alternativa.

[[Imagem:CiaGeralOpcoes.png|semmoldura|center|700px]]
<br>
Caso a Cia encontre uma resposta com confiança significativamente maior que as demais, ela será executada automaticamente.
<br><br>
No entanto, se você selecionar a opção “Não era bem isso o que eu queria”, a Cia exibirá outras opções relacionadas ao que foi solicitado, apresentando também um indicador de semáforo com a porcentagem de confiança de cada alternativa.

[[Imagem:CiaGeralOpcaoCerta.png|semmoldura|center|600px]]

===Ajuda, Vídeos e Auditor===
Conheça melhor o ERP com a ajuda da Wiki e Cia, assista vídeos sobre o CIGAM e audite seu ambiente.

====Ajuda====
Nesse assunto, você pode acessar o Chatbot da assistente virtual, onde você pode tirar dúvidas e consultar conteúdos da CIGAM Wiki enviando perguntas diretamente nela.<br>
<br>
'''Importante:''' neste assunto, a Cia atua dedicada à Wiki, focada exclusivamente nos conteúdos da documentação. As demais funcionalidades e atalhos da Cia não estarão disponíveis nesse contexto.

====Vídeos====
Nesse assunto, é possível procurar por vídeos relacionados ao tema desejado. O resultado será apresentado em forma de lista, contendo os vídeos encontrados e os tempos exatos em que o assunto começa a ser abordado, de acordo com o termo ou palavra pesquisada.

====Auditor====
Neste assunto, é possível verificar o status do sistema e identificar possíveis problemas ou inconsistências. O resultado será exibido em forma de tabela, contendo os dados retornados para facilitar a análise.

===Painéis BI, Portais e Relatórios===
Explore dashboards do BI, interaja com Portais intuitivos e execute relatórios personalizados.

====Painéis BI====
Nesse assunto, é possível abrir dashboards do BI já configurados para o usuário, permitindo sua visualização diretamente na tela.
Ao abrir um dashboard, você também pode interagir com ele, solicitando inserção de filtros, dimensões, métricas, transformações e outros ajustes.<br>
Cada dashboard aberto exibirá uma guia com as “Interações” disponíveis para aquele painel específico.
<br><br>
Além disso, ao selecionar o assunto '''#Painéis do BI''', é possível solicitar que a Cia crie um dashboard do zero.
Por exemplo: "Crie um dashboard para ver meu fluxo de caixa". Você pode ainda solicitar que métricas, dimensões e filtros sejam adicionados durante a criação, ou pedir dashboards separados por áreas.
<br><br>
'''Importante:''' caso o usuário não possua acesso ao BI ou este não esteja implementado na base de dados, será exibida uma mensagem informativa no momento do login na Cia.

====Portais====
Quando este assunto é utilizado, o resultado será sempre a abertura de uma tela dos Portais, permitindo ao usuário acessar diretamente os conteúdos e funcionalidades disponíveis nesse ambiente.
<br><br>
Essa abertura é feita de forma integrada, garantindo uma navegação contínua entre a Cia e os Portais, sem necessidade de realizar novo login ou sair da plataforma.

====Relatórios====
Ao utilizar esse assunto, será exibida uma tela para preenchimento de filtros, permitindo a emissão de relatórios web.
<br><br>
Para que essa funcionalidade opere corretamente, é necessário garantir que a instalação da CDN e da Pesquisa Dinâmica no servidor de aplicação esteja configurada de forma adequada.
<br><br>
Os relatórios exibidos aqui são os mesmos disponíveis nos Portais CIGAM, portanto é essencial que esses componentes também estejam funcionando corretamente nesses Portais.

===Qual, Faça, Consultar, Listar, Analisar e Insights===
Crie registros, analise informações ou liste dados cadastrados no CIGAM.

====Qual====
Nesse assunto, a Cia vai consultar e processar informações diretamente no ERP, usando os dados e relacionamentos disponíveis no CIGAM, e retornar os resultados em forma de texto para você visualizar.
<br><br>
'''Importante:''' nem todas as opções estão liberadas. Para ver quais você pode usar, digite ? na caixa de texto. A Cia vai mostrar uma lista com todos os comandos e funções disponíveis.

====Faça====
Nesse assunto, a Cia sempre fará um processamento no CIGAM e retornará o status do resultado. Por exemplo, você pode solicitar que a Cia crie um alerta ou até mesmo crie uma nova empresa no sistema.
<br><br>
'''Dica:''' para saber quais treinamentos ou comandos estão disponíveis, digite ? na caixa de texto. A Cia mostrará uma lista com todas as opções implementadas para você usar.

====Consultar====
Nesse assunto, você poderá fazer consultas de dados para obter listagens de registros, conforme os treinamentos de tabelas disponíveis. O resultado será apresentado em forma de tabela, exibindo os dados retornados. Já existem diversas Views prontas, para que você possa listar informações de forma mais completa e rápida.
<br><br>
'''Dica:''' para ver exemplos de consultas já implementadas, digite ? na caixa de texto.

====Listar====
Nesse assunto, você pode montar sua própria consulta de dados, escolhendo os filtros e parâmetros para gerar uma listagem personalizada. Diferente do assunto #Consultar, aqui é possível utilizar qualquer tabela do CIGAM para montar sua consulta, escrevendo em linguagem natural o que deseja buscar.
<br><br>
'''Dica:''' para ver todas as tabelas disponíveis, digite ? na caixa de texto.

====Analisar====
Analise o arquivo selecionado para gerar gráficos interativos e informativos, apresentando insights relevantes que ajudam a identificar tendências, padrões e oportunidades de melhoria.
<br><br>
Esse recurso oferece uma visualização clara e intuitiva dos dados, facilitando a interpretação das informações e apoiando a tomada de decisões estratégicas.
<br><br>
'''Aviso:''' para utilizar esta funcionalidade, é necessário concordar que os dados enviados serão processados por modelos de IA de terceiros integrados à Cia.

[[Imagem:AnalisarCia.png|semmoldura|center|600px]]

====Insights====
Gere insights inteligentes a partir dos dados de uma consulta, com análises automáticas realizadas pela Cia, que identificam padrões, tendências e possíveis pontos de atenção. Esse recurso ajuda a transformar dados brutos em informações acionáveis, facilitando a tomada de decisões estratégicas e otimizando processos.
<br><br>
'''Aviso:''' ao utilizar o assunto “Insights”, você concorda que os dados e informações analisados poderão ser enviados para modelos de IA de terceiros integrados à Cia, exclusivamente para processamento e geração dos resultados apresentados.

===IA Generativa e Pesquisa na Internet===
Converse com a IA sobre assuntos diversos, crie conteúdos e pesquise na internet sobre qualquer coisa.

====IA Generativa====
Nesse assunto, ao interagir com a IA Generativa, você poderá fazer qualquer tipo de pergunta ou solicitação, de forma livre e criativa.
O resultado exibido será exatamente a resposta gerada pela IA, sem complementos da Cia. Você pode, por exemplo, solicitar que a IA melhore ou reformule um texto, crie conteúdos ou resuma informações.
<br><br>
'''Importante:''' nesse assunto, a Cia não estará integrada aos serviços e sistemas do CIGAM — a interação é exclusivamente com a IA Generativa.

====Pesquisa na Internet====
Use esse assunto para fazer pesquisas na internet e visualizar os resultados diretamente integrados na Cia, sem precisar sair da plataforma. Você pode pesquisar qualquer tema de interesse e abrir os links retornados para acessar conteúdos, notícias e informações de forma rápida e prática.
{{VoltarInicio}}

===Análises por IA e compartilhamento===

Na Cia Web, é possível gerar análises por Inteligência Artificial a partir dos dados e informações disponibilizados para processamento. Essa funcionalidade está disponível nos seguintes assuntos:

* '''#Analisar:''' permite analisar arquivos, gerando gráficos interativos e informações relevantes para identificar tendências, padrões e oportunidades de melhoria.
* '''#Insights:''' permite gerar análises automáticas a partir dos dados de uma consulta, identificando padrões, tendências e possíveis pontos de atenção.

<br>
<div align="justify">
A partir da versão '''Beta 261005''', ao gerar uma análise por IA, a página de resultado passa a disponibilizar opções para utilização e compartilhamento do conteúdo gerado.
</div>
<br>

[[Imagem:CiaWebResultadoAnalise.png|semmoldura|center|800px]]

<br>
<div align="justify">
No cabeçalho são apresentados o nome do agente executado e as opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>

=====Compartilhamento por e-mail=====

<div align="justify">
Ao selecionar a opção '''E-mail''', será apresentada uma janela para preenchimento das informações necessárias ao envio da análise.
</div>
<br>

[[Imagem:CiaWebModalEmail.png|semmoldura|center|800px]]

<br>
<div align="justify">
Após informar os destinatários e os demais dados da mensagem, basta selecionar '''Enviar'''. A análise gerada será encaminhada como um arquivo em anexo.

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
</div>

==Configurações==
O ícone de engrenagem, localizado no canto superior direito da página, reúne recursos de informação e gerenciamento. As opções disponíveis são:
* '''Respostas com áudio:''' quando ativado, as respostas da Cia são narradas em voz alta.
* '''Ambiente atual do CIGAM:''' exibe na tela o usuário logado e o ambiente em uso.
* '''Ver consumo:''' mostra a quantidade de tokens já utilizados e os usuários que geraram consumo.
* '''Limpar dados de navegação:''' exibe uma mensagem explicando como limpar os dados de navegação do navegador.
* '''Limpar cookies:''' apaga os dados armazenados localmente, permitindo informar novamente a API e realizar um novo login.
* '''Instalar aplicativo:''' instala a Cia como aplicativo no dispositivo, criando um atalho na tela inicial.
* '''Documentação na wiki:''' direciona para a documentação da Cia na CIGAM Wiki.
* '''Sair:''' encerra a sessão do usuário, permitindo realizar login com outro usuário.
<br>
[[Imagem:ConfiguracoesCia.png|semmoldura|center|500px]]
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, além do acesso à Cia Web pelo menu de mosaico, estão disponíveis recursos de IA que atuam diretamente nas telas em que você está trabalhando. Esses recursos não exigem parametrização e são apresentados de acordo com o contexto da tela.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia Web a partir dos Portais é feito pelo ícone de mosaico, onde está disponível o ícone da Cia - IA do CIGAM.<br>
<br>
[[Imagem:mosaicoCia.png|semmoldura|center|800px]]
<br>
A Cia será aberta de forma integrada, sem a necessidade de novo login, e todas as funcionalidades descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] estarão disponíveis normalmente.<br>

==Geração de conteúdo==
Na barra superior dos Portais está disponível um ícone com um menu de contexto que permite interagir com os '''campos de texto''' de qualquer parte dos Portais. As opções disponíveis permitem melhorar textos, criar conteúdos, revisar a gramática, entre outras ações.<br>
<br>
[[Imagem:comandosCia.png|semmoldura|center|650px]]
<br>
A partir da versão '''Beta 260601''', essas opções passaram a ser exibidas em uma seção separada, chamada '''Geração de conteúdo''', apresentada no mesmo menu em que ficam os agentes.<br>
<br>
[[Imagem:MenuGeracaoConteudoAgentes.png|semmoldura|center|800px]]
<br>
O campo processado é sempre o '''último campo em que o cursor esteve posicionado''' antes de abrir o menu da Cia. Por isso, basta clicar no campo desejado e, em seguida, acionar o menu e escolher o comando.<br>
<br>
Para que o comando seja executado, o campo precisa ser um '''campo de texto válido''' e conter, no mínimo, '''três palavras'''. Caso contrário, será apresentada uma mensagem informando que o conteúdo não atende aos requisitos.<br>
<br>
Após o processamento, o conteúdo gerado é aplicado automaticamente no campo, substituindo o texto anterior, sem necessidade de confirmação.<br>
<br>
Essa funcionalidade também está disponível em telas modais, ou seja, janelas sobrepostas com interações:<br>
<br>
[[Imagem:comandosModalCia.png|semmoldura|center|800px]]
<br>

==Agentes==
A partir da versão '''Beta 260601''', o menu da Cia nos Portais passou a disponibilizar também o acesso aos agentes, tanto nos Portais MVC quanto nos Portais React.<br>
<br>
Ao abrir o menu da Cia, os agentes disponíveis são detectados automaticamente de acordo com a tela que está sendo acessada, ou seja, as opções apresentadas variam conforme a página aberta.<br>
<br>
[[Imagem:MenuAgentesCia.png|semmoldura|center|800px]]
<br>

===Como os agentes são disponibilizados===
A disponibilização de cada agente pode ocorrer de quatro formas:<br>
<br>
* '''Por contexto:''' o agente é apresentado quando a Cia identifica que a tela acessada corresponde ao assunto tratado por ele. Por exemplo, um agente sobre Ordem de Produção será disponibilizado ao acessar uma página cujo contexto seja identificado como Ordem de Produção.
<br>
* '''Por parâmetro:''' o agente é apresentado quando a Cia identifica, na tela, um parâmetro com o valor esperado por ele. Por exemplo, um agente de Pedidos será disponibilizado quando existir na tela um parâmetro que contenha o código do pedido.
<br>
* '''Por contexto e parâmetro:''' o agente é apresentado somente quando as duas condições forem atendidas ao mesmo tempo.
<br>
* '''Sempre disponível:''' o agente é apresentado em qualquer tela, independentemente do contexto ou dos parâmetros.
<br>

===Resultado do processamento===
Após o processamento, o retorno do agente pode ser apresentado de duas formas, conforme o que foi executado:<br>
<br>
* Em uma '''nova guia''' do navegador, quando o agente gera algum conteúdo ou relatório como resultado.
<br>
[[Imagem:AgentesRetornoGuia.png|semmoldura|center|800px]]
<br>
* Em uma '''janela modal''', dentro da própria página em que o usuário está, quando o retorno é uma mensagem.
<br>
[[Imagem:AgentesRetornoModal.png|semmoldura|center|800px]]
<br>
<div align="justify>
A partir da versão '''Beta 261005''', quando o resultado do agente é apresentado em uma nova guia, a página passa a disponibilizar também opções para utilização e compartilhamento da análise.
</div>
<br>
[[Imagem:resultadoAnalise.png|semmoldura|center|800px]]
<br>
<div align="justify">
No cabeçalho são apresentados o nome do agente executado e as opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>
<div align="justify">
=====Compartilhamento por e-mail=====
A janela abaixo é exibida ao quando selecionada a opção '''E-mail''':
</div>
<br>
[[Imagem:modalEmail.png|semmoldura|center|800px]]
<br>
<div align="justify">

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
</div>

==Editor de Agentes==
A partir da versão '''Beta 261005''', o menu passou a disponibilizar o acesso à ferramenta '''Editor de Agentes''', que permite criar seus próprios agentes.<br>
<br>
[[Imagem:EditorAgentesCia.png|semmoldura|center|800px]]
<br>
Ao clicar na opção, será aberta uma página web no formato de assistente (wizard), com cada etapa explicada de forma detalhada. Basta preencher as informações do agente conforme a sua necessidade e avançar pelos passos até a conclusão.<br>
<br>
[[Imagem:EditorAgentesWizard.png|semmoldura|center|800px]]
<br>
Ao final do processo, será gerado um arquivo com a extensão '''.cgagt''', que contém a definição do agente criado.<br>
<br>

===Disponibilizando o agente criado===
Para que o agente passe a ser exibido nos Portais, o arquivo '''.cgagt''' precisa ser colocado na aplicação da API, dentro da pasta raiz da aplicação.<br>
<br>
É necessário que existam as pastas '''Exclusivo''' e, dentro dela, '''Agentes'''. Caso não existam, elas devem ser criadas manualmente. O arquivo deve ser colocado dentro dessa estrutura, ficando da seguinte forma:<br>
<br>
/api/exclusivo/agentes/
<br>
Assim que o arquivo é adicionado nesse local, a Cia passa a reconhecer o agente automaticamente, sem necessidade de qualquer outra configuração. Os agentes customizados são exibidos no menu da Cia nos Portais, em uma seção separada dos agentes padrão.<br>
<br>
[[Imagem:MenuAgentesCustomizados.png|semmoldura|center|800px]]
<br>
==Conversar com documentos==
<div align="justify">
Ao clicar na opção "Conversar com documentos" seremos direcionados à página da aplicação.

Precisamos acessar com nosso token de autorização CIGAM e termos nossa API configurada corretamente.

Tendo isto devidamente parametrizado, ao iniciar a aplicação, será gerado um ID de conversação para nossa sessão, esta informação é importante porque através deste ID a Cia armazena o contexto de todas as mensagens e documentos que enviarmos nesta conversa.

<br>
<center>[[Arquivo:cia_conv_docs_01.png|nenhum|750px]]</center>
<br>

No primeiro acesso, teremos de marcar o checkbox "Termo de consentimento" para indicar que estamos cientes de que os dados serão analisados e enviados para os modelos de IA de terceiros integrados com a Cia.

Confirmando esta opção, teremos como anexar arquivos no menu lateral esquerdo, arrastando os arquivos e soltando na área, ou clicando e selecionando, podendo selecionar múltiplos arquivos de uma única vez.

<br>
<center>[[Arquivo:cia_conv_docs_02.png|nenhum|750px]]</center>
<br>

Clicando no ícone da engrenagem localizada no canto superior direito da tela, poderemos acessar as opções.

*Podemos selecionar o modelo de IA escolhido.
*Podemos visualizar o usuário autenticado e as informações de licença.
*Podemos visualizar e copiar as informações de sessão de API.
*Podemos visualizar e copiar nosso ID de conversação.
*Podemos limpar a conversa, forçando o sistema a gerar um novo ID de conversação, com objetivo de recomeçar nosso contexto de análise. Será apresentada uma mensagem de confirmação antes de limpar o contexto.
*Podemos acessar a documentação da ferramenta na Wiki.

<br>
<center>[[Arquivo:cia_conv_docs_03.png|nenhum|750px]]</center>
<br>

Podemos enviar arquivos e mensagens para complementar a análise. O sistema possui um prompt de sistema padrão para auxiliar o modelo a analisar e retornar os dados de maneira estruturada.

Há um ícone de microfone para reconhecimento de voz.

<br>
<center>[[Arquivo:cia_conv_docs_04.png|nenhum|750px]]</center>
<br>

As análises são geradas contendo gráficos e/ou tabelas quando aplicável.

<br>
<center>[[Arquivo:cia_conv_docs_05.png|nenhum|750px]]</center>
<br>

Podemos ter diversos documentos e mensagens.

</div>
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, além do acesso rápido à Cia Web, algumas ferramentas do sistema disponibilizam o recurso "Analisar com a Cia".<br>

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM), disponível no menu lateral do Desktop, abre a Cia Web de forma integrada ao sistema, em uma janela do próprio CIGAM.<br>
<br>
Desde que as configurações necessárias tenham sido aplicadas, conforme [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Acesso rápido à Cia Web (SaaS)|Acesso rápido à Cia Web (SaaS)]], '''todas as funcionalidades da Cia Web estarão disponíveis normalmente''', da mesma forma que no acesso pelo navegador. Para conhecê-las, consulte a seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] desta documentação.<br>
<br>
[[Imagem:CiaAbertaDesktop.png|semmoldura|center|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''' está disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída. Em todas elas, o comportamento é o mesmo: a Cia analisa o conteúdo que está em uso na tela e gera um relatório com o resultado da análise, apresentado em uma nova página.<br>
<br>
Ao acionar a opção, o fluxo é o seguinte:<br>
<br>
'''1. Confirmação dos termos de uso'''<br>
Antes de qualquer envio, será exibida uma mensagem solicitando que o usuário concorde com o envio das informações para análise. Os dados enviados seguem as diretrizes de segurança, privacidade e não retenção descritas em [[#Recursos, configurações e segurança|Recursos, configurações e segurança]].<br>
<br>
[[Imagem:AnalisarCiaTermos.png|semmoldura|center|500px]]
<br>
'''2. Complemento do prompt (opcional)'''<br>
Em seguida, será apresentada uma caixa de texto para que o usuário complemente a solicitação, orientando a análise para algum ponto específico. O preenchimento é opcional e pode ser deixado em branco.<br>
<br>
Essa caixa de texto serve apenas para complementar o prompt base que a Cia monta automaticamente, e não altera o conteúdo que está sendo enviado. O recurso considera que o usuário já filtrou os dados na própria tela do CIGAM antes de acionar a análise. O prompt base é mantido oculto por ser extenso e técnico, evitando que o usuário precise conferi-lo a cada utilização.<br>
<br>
[[Imagem:AnalisarCiaPrompt.png|semmoldura|center|700px]]
<br>
'''3. Geração do relatório'''<br>
Após a confirmação, a Cia processa o conteúdo e apresenta o relatório em uma nova página flutuante, com a análise dos dados enviados.<br>
<br>
O próprio relatório informa a quantidade de dados que foi analisada, permitindo que o usuário veja o volume aproximado considerado e identifique se o conteúdo enviado corresponde ao que esperava.<br>
<br>
[[Imagem:AnalisarCiaRelatorio.png|semmoldura|center|700px]]
<br>

===Limite de conteúdo enviado===
Existe um limite para o volume de conteúdo enviado em cada análise, que varia conforme a versão do ambiente:<br>
<br>
* '''150 KB''' — desde a disponibilização do recurso, na versão '''250505.a'''.
* '''3 MB''' — a partir das patches '''250505.i''' e '''251103.a''', e da versão '''RC 260504'''.
<br>
Quando o conteúdo selecionado ultrapassa esse limite, a Cia exibe uma mensagem informando o tamanho excedido e a análise não é processada, ou seja, nenhum relatório será gerado.<br>
<br>
[[Imagem:AnalisarCiaLimite.png|semmoldura|center|600px]]
<br>
'''Esse limite não é parametrizável e não se trata de uma restrição imposta pela CIGAM.''' Ele decorre da própria capacidade dos modelos de IA integrados à Cia, que possuem um limite técnico de volume de dados que conseguem processar em uma única análise. Quando esse volume é ultrapassado, os modelos passam a analisar as informações por amostragem — ou seja, mesmo que fosse permitido enviar uma quantidade maior de dados, o modelo não analisaria todo o conteúdo, e o resultado seria menos preciso. O limite adotado pela Cia acompanha essa característica dos modelos e assegura que a análise seja feita sobre os dados completos.<br>
<br>
Além da qualidade da análise, há também a questão do tempo de processamento: quanto maior o volume enviado, maior o tempo de resposta do modelo, tornando a espera inviável para o uso no dia a dia.<br>
<br>
Por isso, o recurso foi feito para ser simples e direto: analisar, com um clique, os dados que o usuário já está visualizando pelos meios tradicionais do CIGAM, como grids filtrados e relatórios. Em ambientes com grande volume de dados, a prática recomendada é '''filtrar e consolidar as informações na própria tela antes de acionar a análise''', reduzindo o período ou o escopo consultado. Para análises de períodos maiores, recomenda-se utilizar dados já consolidados, como totalizadores e relatórios sintéticos, em vez de listagens analíticas completas.<br>
<br>
A CIGAM está trabalhando em outras ferramentas que, por processarem os dados de forma diferente, permitirão trabalhar com volumes maiores de informação.<br>

Para saber como acessar o recurso em cada ferramenta, consulte: [[GE - Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Configuração da Cia IA do CIGAM]]

GE - Como Fazer - Uso da Cia - IA do CIGAM

2026-10-08T18:19:56Z

Vinicius.moder: /* Resultado do processamento */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como_Fazer_Utilidades/Diversos_6]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer - Uso da Cia - IA do CIGAM]]

=Recursos, configurações e segurança=
A Cia - IA do CIGAM oferece diversas funcionalidades e atua como um hub centralizador para os recursos de inteligência artificial utilizados nas soluções CIGAM. Para garantir o correto funcionamento desses recursos, é necessário verificar se os pré-requisitos e as configurações foram realizados adequadamente. Para mais informações, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM|Como Fazer configuração da Cia IA do CIGAM]]
<br><br>
Todas as soluções de IA do CIGAM são integradas por meio dos serviços da Cia. A Cia possui integração com diferentes provedores de IA de terceiros, como OpenAI, Google, Anthropic, entre outros. Essas integrações são realizadas por meio de contas e serviços contratados, com condições de uso que asseguram que os dados trafegados não sejam utilizados para treinamento dos modelos, identificação de origem, publicidade, anúncios ou qualquer outra finalidade não prevista.
<br><br>
No caso de IAs open-source integradas à Cia, os modelos são executados dentro dos domínios da CIGAM, mantendo as mesmas premissas aplicadas às IAs contratadas: não utilização dos dados para treinamento de modelos, não identificação da origem das informações e ausência de retenção dos dados processados.
<br><br>
Além disso, sempre que houver envio explícito de dados pelo usuário por meio das funcionalidades da Cia disponíveis nas soluções CIGAM, será apresentado um diálogo de confirmação, permitindo que o usuário aceite o envio dessas informações. Os dados enviados serão tratados conforme as mesmas diretrizes de segurança, privacidade e não retenção descritas anteriormente.
<br><br>
Esta documentação apresenta o uso da Cia e está organizada conforme a forma de acesso: [[#Cia Web (SaaS)|Cia Web (SaaS)]], [[#Portais|Portais]] e [[#Desktop|Desktop]].
<br><br>
Caso tenha dúvidas sobre onde encontrar a Cia em cada uma dessas plataformas, ou sobre quais ferramentas do CIGAM possuem recursos integrados a ela, consulte a documentação específica de acesso: [[GE - Como Fazer - Cia - Como acessar|Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Cia Web (SaaS)=
A Cia Web é a aplicação web que centraliza todas as funcionalidades da Cia. Ela pode ser acessada diretamente pelo navegador do seu computador ou dispositivo móvel, ou ainda a partir do Desktop e dos Portais, sem a necessidade de novo login.
<br><br>

<center><youtube>https://youtu.be/DFGtRtPF75A</youtube></center>
<br>

==Primeiro acesso==
A Cia Web pode ser acessada diretamente pelo navegador, utilizando o seguinte endereço: https://services.cigam.cloud/cia/index.html
<br><br>
'''Importante:''' o usuário que for realizar o login precisa ter a autenticação em duas etapas habilitada. Para saber como configurá-la, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]]
<br><br>
Ao acessar pelo endereço, será necessário preencher algumas informações para que a Cia consiga validar seu acesso e consultar seus dados:<br>
* Informar a API do seu CIGAM Server, para garantir o direcionamento correto da base de dados.<br><br>

[[Imagem:CiaAPI.png|semmoldura|center|700px]]<br>

* Informar usuário e senha de login e seu código de verificação:<br><br>

[[Imagem:CiaLogin.png|semmoldura|center|700px]]
<br>
[[Imagem:CiaCodVerif.png|semmoldura|center|700px]]<br>

* Caso não queira aguardar ou informar o código de verificação, você pode optar por responder à pergunta secreta, clicando no botão “Pergunta Secreta” exibido na imagem acima.<br><br>

[[Imagem:CiaLoginA2F.png|semmoldura|center|700px]]
<br>

==Conhecendo a tela da Cia==
Após realizar o login, a Cia carregará automaticamente as informações e dados necessários do ambiente e será iniciada no assunto '''#Geral''', identificado pelo botão localizado à esquerda da caixa de texto.

[[Imagem:CiaGeral.png|semmoldura|center|700px]]
<br><br>
Ao clicar nesse botão, será exibida uma lista com todos os assuntos disponíveis, permitindo que você selecione aquele com o qual deseja interagir.<br><br>
Além disso, você pode digitar diretamente na caixa de texto o '''#Assunto''' que deseja utilizar, e a Cia entenderá automaticamente o tema da sua mensagem.<br><br>
Também é possível '''formular uma pergunta seguida de um #Assunto''' para interagir com qualquer assunto, mesmo que ele não esteja selecionado no momento.

[[Imagem:CiaAberta.png|semmoldura|center|700px]]
<br>
Ao selecionar um assunto, serão exibidas automaticamente dicas e sugestões sobre o tema escolhido, além de exemplos clicáveis que, ao serem selecionados, são processados de forma imediata.<br><br>
Além disso, ao digitar um ponto de interrogação (?) na caixa de texto, será exibida uma lista com todas as interações disponíveis para o assunto selecionado, facilitando a descoberta de comandos e possibilidades de uso.

[[Imagem:CiaDicas.png|semmoldura|center|700px]]
<br>
Outra funcionalidade prática é a possibilidade de reenviar perguntas já feitas no chat. Para isso, basta posicionar o mouse sobre a pergunta desejada e clicar no ícone de “Reenviar”. Ao passar o mouse sobre a mensagem, também será exibido o horário de envio.
<br>
[[Imagem:CiaReenviar.png|semmoldura|center|400px]]
<br>
Além disso, você pode utilizar as setas do teclado (⬆️ para cima e ⬇️ para baixo) na caixa de texto para navegar pelas últimas perguntas enviadas para o #Assunto selecionado, facilitando o reuso de interações anteriores.

===Ícones da caixa de texto===
Na caixa de texto, você encontrará alguns ícones com as seguintes funções:

<center>
{| class="wikitable"
|-
! !! Ação
|-
|center|[[Imagem:CiaUltPerg.png]] || '''Histórico de Perguntas''' – Ao clicar, é exibido o histórico das perguntas já realizadas para o assunto selecionado.
|-
|center|[[Imagem:CiaEnviar.png]] || '''Enviar''' – Envia o conteúdo digitado na caixa de texto.
|-
|center|[[Imagem:CiaFala.png]] || '''Falar''' – Permite falar ao invés de digitar, usando o recurso de voz.
|-
|center|[[Imagem:CiaExpandir.png]] || '''Expandir''' – Aumenta a altura da caixa de texto para facilitar a digitação de mensagens longas.
|-
|center|[[Imagem:CiaRecolher.png]] || '''Recolher''' – Reduz a caixa de texto ao tamanho padrão.
|}
</center>
{{VoltarInicio}}

==Assuntos disponíveis==

===Geral===
Nesse assunto, é possível conversar livremente com a Cia sobre qualquer um dos assuntos disponíveis. Se encontrar dificuldades para obter a resposta desejada, experimente selecionar um assunto específico, o que pode gerar resultados mais precisos.<br><br>
Se houver muitas respostas correspondentes, a Cia não executará nenhuma automaticamente. Em vez disso, exibirá uma opção com os valores possíveis, permitindo que você selecione manualmente a melhor alternativa.

[[Imagem:CiaGeralOpcoes.png|semmoldura|center|700px]]
<br>
Caso a Cia encontre uma resposta com confiança significativamente maior que as demais, ela será executada automaticamente.
<br><br>
No entanto, se você selecionar a opção “Não era bem isso o que eu queria”, a Cia exibirá outras opções relacionadas ao que foi solicitado, apresentando também um indicador de semáforo com a porcentagem de confiança de cada alternativa.

[[Imagem:CiaGeralOpcaoCerta.png|semmoldura|center|600px]]

===Ajuda, Vídeos e Auditor===
Conheça melhor o ERP com a ajuda da Wiki e Cia, assista vídeos sobre o CIGAM e audite seu ambiente.

====Ajuda====
Nesse assunto, você pode acessar o Chatbot da assistente virtual, onde você pode tirar dúvidas e consultar conteúdos da CIGAM Wiki enviando perguntas diretamente nela.<br>
<br>
'''Importante:''' neste assunto, a Cia atua dedicada à Wiki, focada exclusivamente nos conteúdos da documentação. As demais funcionalidades e atalhos da Cia não estarão disponíveis nesse contexto.

====Vídeos====
Nesse assunto, é possível procurar por vídeos relacionados ao tema desejado. O resultado será apresentado em forma de lista, contendo os vídeos encontrados e os tempos exatos em que o assunto começa a ser abordado, de acordo com o termo ou palavra pesquisada.

====Auditor====
Neste assunto, é possível verificar o status do sistema e identificar possíveis problemas ou inconsistências. O resultado será exibido em forma de tabela, contendo os dados retornados para facilitar a análise.

===Painéis BI, Portais e Relatórios===
Explore dashboards do BI, interaja com Portais intuitivos e execute relatórios personalizados.

====Painéis BI====
Nesse assunto, é possível abrir dashboards do BI já configurados para o usuário, permitindo sua visualização diretamente na tela.
Ao abrir um dashboard, você também pode interagir com ele, solicitando inserção de filtros, dimensões, métricas, transformações e outros ajustes.<br>
Cada dashboard aberto exibirá uma guia com as “Interações” disponíveis para aquele painel específico.
<br><br>
Além disso, ao selecionar o assunto '''#Painéis do BI''', é possível solicitar que a Cia crie um dashboard do zero.
Por exemplo: "Crie um dashboard para ver meu fluxo de caixa". Você pode ainda solicitar que métricas, dimensões e filtros sejam adicionados durante a criação, ou pedir dashboards separados por áreas.
<br><br>
'''Importante:''' caso o usuário não possua acesso ao BI ou este não esteja implementado na base de dados, será exibida uma mensagem informativa no momento do login na Cia.

====Portais====
Quando este assunto é utilizado, o resultado será sempre a abertura de uma tela dos Portais, permitindo ao usuário acessar diretamente os conteúdos e funcionalidades disponíveis nesse ambiente.
<br><br>
Essa abertura é feita de forma integrada, garantindo uma navegação contínua entre a Cia e os Portais, sem necessidade de realizar novo login ou sair da plataforma.

====Relatórios====
Ao utilizar esse assunto, será exibida uma tela para preenchimento de filtros, permitindo a emissão de relatórios web.
<br><br>
Para que essa funcionalidade opere corretamente, é necessário garantir que a instalação da CDN e da Pesquisa Dinâmica no servidor de aplicação esteja configurada de forma adequada.
<br><br>
Os relatórios exibidos aqui são os mesmos disponíveis nos Portais CIGAM, portanto é essencial que esses componentes também estejam funcionando corretamente nesses Portais.

===Qual, Faça, Consultar, Listar, Analisar e Insights===
Crie registros, analise informações ou liste dados cadastrados no CIGAM.

====Qual====
Nesse assunto, a Cia vai consultar e processar informações diretamente no ERP, usando os dados e relacionamentos disponíveis no CIGAM, e retornar os resultados em forma de texto para você visualizar.
<br><br>
'''Importante:''' nem todas as opções estão liberadas. Para ver quais você pode usar, digite ? na caixa de texto. A Cia vai mostrar uma lista com todos os comandos e funções disponíveis.

====Faça====
Nesse assunto, a Cia sempre fará um processamento no CIGAM e retornará o status do resultado. Por exemplo, você pode solicitar que a Cia crie um alerta ou até mesmo crie uma nova empresa no sistema.
<br><br>
'''Dica:''' para saber quais treinamentos ou comandos estão disponíveis, digite ? na caixa de texto. A Cia mostrará uma lista com todas as opções implementadas para você usar.

====Consultar====
Nesse assunto, você poderá fazer consultas de dados para obter listagens de registros, conforme os treinamentos de tabelas disponíveis. O resultado será apresentado em forma de tabela, exibindo os dados retornados. Já existem diversas Views prontas, para que você possa listar informações de forma mais completa e rápida.
<br><br>
'''Dica:''' para ver exemplos de consultas já implementadas, digite ? na caixa de texto.

====Listar====
Nesse assunto, você pode montar sua própria consulta de dados, escolhendo os filtros e parâmetros para gerar uma listagem personalizada. Diferente do assunto #Consultar, aqui é possível utilizar qualquer tabela do CIGAM para montar sua consulta, escrevendo em linguagem natural o que deseja buscar.
<br><br>
'''Dica:''' para ver todas as tabelas disponíveis, digite ? na caixa de texto.

====Analisar====
Analise o arquivo selecionado para gerar gráficos interativos e informativos, apresentando insights relevantes que ajudam a identificar tendências, padrões e oportunidades de melhoria.
<br><br>
Esse recurso oferece uma visualização clara e intuitiva dos dados, facilitando a interpretação das informações e apoiando a tomada de decisões estratégicas.
<br><br>
'''Aviso:''' para utilizar esta funcionalidade, é necessário concordar que os dados enviados serão processados por modelos de IA de terceiros integrados à Cia.

[[Imagem:AnalisarCia.png|semmoldura|center|600px]]

====Insights====
Gere insights inteligentes a partir dos dados de uma consulta, com análises automáticas realizadas pela Cia, que identificam padrões, tendências e possíveis pontos de atenção. Esse recurso ajuda a transformar dados brutos em informações acionáveis, facilitando a tomada de decisões estratégicas e otimizando processos.
<br><br>
'''Aviso:''' ao utilizar o assunto “Insights”, você concorda que os dados e informações analisados poderão ser enviados para modelos de IA de terceiros integrados à Cia, exclusivamente para processamento e geração dos resultados apresentados.

===IA Generativa e Pesquisa na Internet===
Converse com a IA sobre assuntos diversos, crie conteúdos e pesquise na internet sobre qualquer coisa.

====IA Generativa====
Nesse assunto, ao interagir com a IA Generativa, você poderá fazer qualquer tipo de pergunta ou solicitação, de forma livre e criativa.
O resultado exibido será exatamente a resposta gerada pela IA, sem complementos da Cia. Você pode, por exemplo, solicitar que a IA melhore ou reformule um texto, crie conteúdos ou resuma informações.
<br><br>
'''Importante:''' nesse assunto, a Cia não estará integrada aos serviços e sistemas do CIGAM — a interação é exclusivamente com a IA Generativa.

====Pesquisa na Internet====
Use esse assunto para fazer pesquisas na internet e visualizar os resultados diretamente integrados na Cia, sem precisar sair da plataforma. Você pode pesquisar qualquer tema de interesse e abrir os links retornados para acessar conteúdos, notícias e informações de forma rápida e prática.
{{VoltarInicio}}

==Configurações==
O ícone de engrenagem, localizado no canto superior direito da página, reúne recursos de informação e gerenciamento. As opções disponíveis são:
* '''Respostas com áudio:''' quando ativado, as respostas da Cia são narradas em voz alta.
* '''Ambiente atual do CIGAM:''' exibe na tela o usuário logado e o ambiente em uso.
* '''Ver consumo:''' mostra a quantidade de tokens já utilizados e os usuários que geraram consumo.
* '''Limpar dados de navegação:''' exibe uma mensagem explicando como limpar os dados de navegação do navegador.
* '''Limpar cookies:''' apaga os dados armazenados localmente, permitindo informar novamente a API e realizar um novo login.
* '''Instalar aplicativo:''' instala a Cia como aplicativo no dispositivo, criando um atalho na tela inicial.
* '''Documentação na wiki:''' direciona para a documentação da Cia na CIGAM Wiki.
* '''Sair:''' encerra a sessão do usuário, permitindo realizar login com outro usuário.
<br>
[[Imagem:ConfiguracoesCia.png|semmoldura|center|500px]]
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, além do acesso à Cia Web pelo menu de mosaico, estão disponíveis recursos de IA que atuam diretamente nas telas em que você está trabalhando. Esses recursos não exigem parametrização e são apresentados de acordo com o contexto da tela.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia Web a partir dos Portais é feito pelo ícone de mosaico, onde está disponível o ícone da Cia - IA do CIGAM.<br>
<br>
[[Imagem:mosaicoCia.png|semmoldura|center|800px]]
<br>
A Cia será aberta de forma integrada, sem a necessidade de novo login, e todas as funcionalidades descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] estarão disponíveis normalmente.<br>

==Geração de conteúdo==
Na barra superior dos Portais está disponível um ícone com um menu de contexto que permite interagir com os '''campos de texto''' de qualquer parte dos Portais. As opções disponíveis permitem melhorar textos, criar conteúdos, revisar a gramática, entre outras ações.<br>
<br>
[[Imagem:comandosCia.png|semmoldura|center|650px]]
<br>
A partir da versão '''Beta 260601''', essas opções passaram a ser exibidas em uma seção separada, chamada '''Geração de conteúdo''', apresentada no mesmo menu em que ficam os agentes.<br>
<br>
[[Imagem:MenuGeracaoConteudoAgentes.png|semmoldura|center|800px]]
<br>
O campo processado é sempre o '''último campo em que o cursor esteve posicionado''' antes de abrir o menu da Cia. Por isso, basta clicar no campo desejado e, em seguida, acionar o menu e escolher o comando.<br>
<br>
Para que o comando seja executado, o campo precisa ser um '''campo de texto válido''' e conter, no mínimo, '''três palavras'''. Caso contrário, será apresentada uma mensagem informando que o conteúdo não atende aos requisitos.<br>
<br>
Após o processamento, o conteúdo gerado é aplicado automaticamente no campo, substituindo o texto anterior, sem necessidade de confirmação.<br>
<br>
Essa funcionalidade também está disponível em telas modais, ou seja, janelas sobrepostas com interações:<br>
<br>
[[Imagem:comandosModalCia.png|semmoldura|center|800px]]
<br>

==Agentes==
A partir da versão '''Beta 260601''', o menu da Cia nos Portais passou a disponibilizar também o acesso aos agentes, tanto nos Portais MVC quanto nos Portais React.<br>
<br>
Ao abrir o menu da Cia, os agentes disponíveis são detectados automaticamente de acordo com a tela que está sendo acessada, ou seja, as opções apresentadas variam conforme a página aberta.<br>
<br>
[[Imagem:MenuAgentesCia.png|semmoldura|center|800px]]
<br>

===Como os agentes são disponibilizados===
A disponibilização de cada agente pode ocorrer de quatro formas:<br>
<br>
* '''Por contexto:''' o agente é apresentado quando a Cia identifica que a tela acessada corresponde ao assunto tratado por ele. Por exemplo, um agente sobre Ordem de Produção será disponibilizado ao acessar uma página cujo contexto seja identificado como Ordem de Produção.
<br>
* '''Por parâmetro:''' o agente é apresentado quando a Cia identifica, na tela, um parâmetro com o valor esperado por ele. Por exemplo, um agente de Pedidos será disponibilizado quando existir na tela um parâmetro que contenha o código do pedido.
<br>
* '''Por contexto e parâmetro:''' o agente é apresentado somente quando as duas condições forem atendidas ao mesmo tempo.
<br>
* '''Sempre disponível:''' o agente é apresentado em qualquer tela, independentemente do contexto ou dos parâmetros.
<br>

===Resultado do processamento===
Após o processamento, o retorno do agente pode ser apresentado de duas formas, conforme o que foi executado:<br>
<br>
* Em uma '''nova guia''' do navegador, quando o agente gera algum conteúdo ou relatório como resultado.
<br>
[[Imagem:AgentesRetornoGuia.png|semmoldura|center|800px]]
<br>
* Em uma '''janela modal''', dentro da própria página em que o usuário está, quando o retorno é uma mensagem.
<br>
[[Imagem:AgentesRetornoModal.png|semmoldura|center|800px]]
<br>
<div align="justify>
A partir da versão '''Beta 261005''', quando o resultado do agente é apresentado em uma nova guia, a página passa a disponibilizar também opções para utilização e compartilhamento da análise.
</div>
<br>
[[Imagem:resultadoAnalise.png|semmoldura|center|800px]]
<br>
<div align="justify">
No cabeçalho são apresentados o nome do agente executado e as opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>
<div align="justify">
=====Compartilhamento por e-mail=====
A janela abaixo é exibida ao quando selecionada a opção '''E-mail''':
</div>
<br>
[[Imagem:modalEmail.png|semmoldura|center|800px]]
<br>
<div align="justify">

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
</div>

==Editor de Agentes==
A partir da versão '''Beta 261005''', o menu passou a disponibilizar o acesso à ferramenta '''Editor de Agentes''', que permite criar seus próprios agentes.<br>
<br>
[[Imagem:EditorAgentesCia.png|semmoldura|center|800px]]
<br>
Ao clicar na opção, será aberta uma página web no formato de assistente (wizard), com cada etapa explicada de forma detalhada. Basta preencher as informações do agente conforme a sua necessidade e avançar pelos passos até a conclusão.<br>
<br>
[[Imagem:EditorAgentesWizard.png|semmoldura|center|800px]]
<br>
Ao final do processo, será gerado um arquivo com a extensão '''.cgagt''', que contém a definição do agente criado.<br>
<br>

===Disponibilizando o agente criado===
Para que o agente passe a ser exibido nos Portais, o arquivo '''.cgagt''' precisa ser colocado na aplicação da API, dentro da pasta raiz da aplicação.<br>
<br>
É necessário que existam as pastas '''Exclusivo''' e, dentro dela, '''Agentes'''. Caso não existam, elas devem ser criadas manualmente. O arquivo deve ser colocado dentro dessa estrutura, ficando da seguinte forma:<br>
<br>
/api/exclusivo/agentes/
<br>
Assim que o arquivo é adicionado nesse local, a Cia passa a reconhecer o agente automaticamente, sem necessidade de qualquer outra configuração. Os agentes customizados são exibidos no menu da Cia nos Portais, em uma seção separada dos agentes padrão.<br>
<br>
[[Imagem:MenuAgentesCustomizados.png|semmoldura|center|800px]]
<br>
==Conversar com documentos==
Em construção...<br>
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, além do acesso rápido à Cia Web, algumas ferramentas do sistema disponibilizam o recurso "Analisar com a Cia".<br>

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM), disponível no menu lateral do Desktop, abre a Cia Web de forma integrada ao sistema, em uma janela do próprio CIGAM.<br>
<br>
Desde que as configurações necessárias tenham sido aplicadas, conforme [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Acesso rápido à Cia Web (SaaS)|Acesso rápido à Cia Web (SaaS)]], '''todas as funcionalidades da Cia Web estarão disponíveis normalmente''', da mesma forma que no acesso pelo navegador. Para conhecê-las, consulte a seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] desta documentação.<br>
<br>
[[Imagem:CiaAbertaDesktop.png|semmoldura|center|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''' está disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída. Em todas elas, o comportamento é o mesmo: a Cia analisa o conteúdo que está em uso na tela e gera um relatório com o resultado da análise, apresentado em uma nova página.<br>
<br>
Ao acionar a opção, o fluxo é o seguinte:<br>
<br>
'''1. Confirmação dos termos de uso'''<br>
Antes de qualquer envio, será exibida uma mensagem solicitando que o usuário concorde com o envio das informações para análise. Os dados enviados seguem as diretrizes de segurança, privacidade e não retenção descritas em [[#Recursos, configurações e segurança|Recursos, configurações e segurança]].<br>
<br>
[[Imagem:AnalisarCiaTermos.png|semmoldura|center|500px]]
<br>
'''2. Complemento do prompt (opcional)'''<br>
Em seguida, será apresentada uma caixa de texto para que o usuário complemente a solicitação, orientando a análise para algum ponto específico. O preenchimento é opcional e pode ser deixado em branco.<br>
<br>
Essa caixa de texto serve apenas para complementar o prompt base que a Cia monta automaticamente, e não altera o conteúdo que está sendo enviado. O recurso considera que o usuário já filtrou os dados na própria tela do CIGAM antes de acionar a análise. O prompt base é mantido oculto por ser extenso e técnico, evitando que o usuário precise conferi-lo a cada utilização.<br>
<br>
[[Imagem:AnalisarCiaPrompt.png|semmoldura|center|700px]]
<br>
'''3. Geração do relatório'''<br>
Após a confirmação, a Cia processa o conteúdo e apresenta o relatório em uma nova página flutuante, com a análise dos dados enviados.<br>
<br>
O próprio relatório informa a quantidade de dados que foi analisada, permitindo que o usuário veja o volume aproximado considerado e identifique se o conteúdo enviado corresponde ao que esperava.<br>
<br>
[[Imagem:AnalisarCiaRelatorio.png|semmoldura|center|700px]]
<br>

===Limite de conteúdo enviado===
Existe um limite para o volume de conteúdo enviado em cada análise, que varia conforme a versão do ambiente:<br>
<br>
* '''150 KB''' — desde a disponibilização do recurso, na versão '''250505.a'''.
* '''3 MB''' — a partir das patches '''250505.i''' e '''251103.a''', e da versão '''RC 260504'''.
<br>
Quando o conteúdo selecionado ultrapassa esse limite, a Cia exibe uma mensagem informando o tamanho excedido e a análise não é processada, ou seja, nenhum relatório será gerado.<br>
<br>
[[Imagem:AnalisarCiaLimite.png|semmoldura|center|600px]]
<br>
'''Esse limite não é parametrizável e não se trata de uma restrição imposta pela CIGAM.''' Ele decorre da própria capacidade dos modelos de IA integrados à Cia, que possuem um limite técnico de volume de dados que conseguem processar em uma única análise. Quando esse volume é ultrapassado, os modelos passam a analisar as informações por amostragem — ou seja, mesmo que fosse permitido enviar uma quantidade maior de dados, o modelo não analisaria todo o conteúdo, e o resultado seria menos preciso. O limite adotado pela Cia acompanha essa característica dos modelos e assegura que a análise seja feita sobre os dados completos.<br>
<br>
Além da qualidade da análise, há também a questão do tempo de processamento: quanto maior o volume enviado, maior o tempo de resposta do modelo, tornando a espera inviável para o uso no dia a dia.<br>
<br>
Por isso, o recurso foi feito para ser simples e direto: analisar, com um clique, os dados que o usuário já está visualizando pelos meios tradicionais do CIGAM, como grids filtrados e relatórios. Em ambientes com grande volume de dados, a prática recomendada é '''filtrar e consolidar as informações na própria tela antes de acionar a análise''', reduzindo o período ou o escopo consultado. Para análises de períodos maiores, recomenda-se utilizar dados já consolidados, como totalizadores e relatórios sintéticos, em vez de listagens analíticas completas.<br>
<br>
A CIGAM está trabalhando em outras ferramentas que, por processarem os dados de forma diferente, permitirão trabalhar com volumes maiores de informação.<br>

Para saber como acessar o recurso em cada ferramenta, consulte: [[GE - Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Configuração da Cia IA do CIGAM]]

GE - Como Fazer - Uso da Cia - IA do CIGAM

2026-10-08T18:18:46Z

Vinicius.moder: /* Resultado do processamento */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como_Fazer_Utilidades/Diversos_6]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer - Uso da Cia - IA do CIGAM]]

=Recursos, configurações e segurança=
A Cia - IA do CIGAM oferece diversas funcionalidades e atua como um hub centralizador para os recursos de inteligência artificial utilizados nas soluções CIGAM. Para garantir o correto funcionamento desses recursos, é necessário verificar se os pré-requisitos e as configurações foram realizados adequadamente. Para mais informações, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM|Como Fazer configuração da Cia IA do CIGAM]]
<br><br>
Todas as soluções de IA do CIGAM são integradas por meio dos serviços da Cia. A Cia possui integração com diferentes provedores de IA de terceiros, como OpenAI, Google, Anthropic, entre outros. Essas integrações são realizadas por meio de contas e serviços contratados, com condições de uso que asseguram que os dados trafegados não sejam utilizados para treinamento dos modelos, identificação de origem, publicidade, anúncios ou qualquer outra finalidade não prevista.
<br><br>
No caso de IAs open-source integradas à Cia, os modelos são executados dentro dos domínios da CIGAM, mantendo as mesmas premissas aplicadas às IAs contratadas: não utilização dos dados para treinamento de modelos, não identificação da origem das informações e ausência de retenção dos dados processados.
<br><br>
Além disso, sempre que houver envio explícito de dados pelo usuário por meio das funcionalidades da Cia disponíveis nas soluções CIGAM, será apresentado um diálogo de confirmação, permitindo que o usuário aceite o envio dessas informações. Os dados enviados serão tratados conforme as mesmas diretrizes de segurança, privacidade e não retenção descritas anteriormente.
<br><br>
Esta documentação apresenta o uso da Cia e está organizada conforme a forma de acesso: [[#Cia Web (SaaS)|Cia Web (SaaS)]], [[#Portais|Portais]] e [[#Desktop|Desktop]].
<br><br>
Caso tenha dúvidas sobre onde encontrar a Cia em cada uma dessas plataformas, ou sobre quais ferramentas do CIGAM possuem recursos integrados a ela, consulte a documentação específica de acesso: [[GE - Como Fazer - Cia - Como acessar|Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Cia Web (SaaS)=
A Cia Web é a aplicação web que centraliza todas as funcionalidades da Cia. Ela pode ser acessada diretamente pelo navegador do seu computador ou dispositivo móvel, ou ainda a partir do Desktop e dos Portais, sem a necessidade de novo login.
<br><br>

<center><youtube>https://youtu.be/DFGtRtPF75A</youtube></center>
<br>

==Primeiro acesso==
A Cia Web pode ser acessada diretamente pelo navegador, utilizando o seguinte endereço: https://services.cigam.cloud/cia/index.html
<br><br>
'''Importante:''' o usuário que for realizar o login precisa ter a autenticação em duas etapas habilitada. Para saber como configurá-la, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]]
<br><br>
Ao acessar pelo endereço, será necessário preencher algumas informações para que a Cia consiga validar seu acesso e consultar seus dados:<br>
* Informar a API do seu CIGAM Server, para garantir o direcionamento correto da base de dados.<br><br>

[[Imagem:CiaAPI.png|semmoldura|center|700px]]<br>

* Informar usuário e senha de login e seu código de verificação:<br><br>

[[Imagem:CiaLogin.png|semmoldura|center|700px]]
<br>
[[Imagem:CiaCodVerif.png|semmoldura|center|700px]]<br>

* Caso não queira aguardar ou informar o código de verificação, você pode optar por responder à pergunta secreta, clicando no botão “Pergunta Secreta” exibido na imagem acima.<br><br>

[[Imagem:CiaLoginA2F.png|semmoldura|center|700px]]
<br>

==Conhecendo a tela da Cia==
Após realizar o login, a Cia carregará automaticamente as informações e dados necessários do ambiente e será iniciada no assunto '''#Geral''', identificado pelo botão localizado à esquerda da caixa de texto.

[[Imagem:CiaGeral.png|semmoldura|center|700px]]
<br><br>
Ao clicar nesse botão, será exibida uma lista com todos os assuntos disponíveis, permitindo que você selecione aquele com o qual deseja interagir.<br><br>
Além disso, você pode digitar diretamente na caixa de texto o '''#Assunto''' que deseja utilizar, e a Cia entenderá automaticamente o tema da sua mensagem.<br><br>
Também é possível '''formular uma pergunta seguida de um #Assunto''' para interagir com qualquer assunto, mesmo que ele não esteja selecionado no momento.

[[Imagem:CiaAberta.png|semmoldura|center|700px]]
<br>
Ao selecionar um assunto, serão exibidas automaticamente dicas e sugestões sobre o tema escolhido, além de exemplos clicáveis que, ao serem selecionados, são processados de forma imediata.<br><br>
Além disso, ao digitar um ponto de interrogação (?) na caixa de texto, será exibida uma lista com todas as interações disponíveis para o assunto selecionado, facilitando a descoberta de comandos e possibilidades de uso.

[[Imagem:CiaDicas.png|semmoldura|center|700px]]
<br>
Outra funcionalidade prática é a possibilidade de reenviar perguntas já feitas no chat. Para isso, basta posicionar o mouse sobre a pergunta desejada e clicar no ícone de “Reenviar”. Ao passar o mouse sobre a mensagem, também será exibido o horário de envio.
<br>
[[Imagem:CiaReenviar.png|semmoldura|center|400px]]
<br>
Além disso, você pode utilizar as setas do teclado (⬆️ para cima e ⬇️ para baixo) na caixa de texto para navegar pelas últimas perguntas enviadas para o #Assunto selecionado, facilitando o reuso de interações anteriores.

===Ícones da caixa de texto===
Na caixa de texto, você encontrará alguns ícones com as seguintes funções:

<center>
{| class="wikitable"
|-
! !! Ação
|-
|center|[[Imagem:CiaUltPerg.png]] || '''Histórico de Perguntas''' – Ao clicar, é exibido o histórico das perguntas já realizadas para o assunto selecionado.
|-
|center|[[Imagem:CiaEnviar.png]] || '''Enviar''' – Envia o conteúdo digitado na caixa de texto.
|-
|center|[[Imagem:CiaFala.png]] || '''Falar''' – Permite falar ao invés de digitar, usando o recurso de voz.
|-
|center|[[Imagem:CiaExpandir.png]] || '''Expandir''' – Aumenta a altura da caixa de texto para facilitar a digitação de mensagens longas.
|-
|center|[[Imagem:CiaRecolher.png]] || '''Recolher''' – Reduz a caixa de texto ao tamanho padrão.
|}
</center>
{{VoltarInicio}}

==Assuntos disponíveis==

===Geral===
Nesse assunto, é possível conversar livremente com a Cia sobre qualquer um dos assuntos disponíveis. Se encontrar dificuldades para obter a resposta desejada, experimente selecionar um assunto específico, o que pode gerar resultados mais precisos.<br><br>
Se houver muitas respostas correspondentes, a Cia não executará nenhuma automaticamente. Em vez disso, exibirá uma opção com os valores possíveis, permitindo que você selecione manualmente a melhor alternativa.

[[Imagem:CiaGeralOpcoes.png|semmoldura|center|700px]]
<br>
Caso a Cia encontre uma resposta com confiança significativamente maior que as demais, ela será executada automaticamente.
<br><br>
No entanto, se você selecionar a opção “Não era bem isso o que eu queria”, a Cia exibirá outras opções relacionadas ao que foi solicitado, apresentando também um indicador de semáforo com a porcentagem de confiança de cada alternativa.

[[Imagem:CiaGeralOpcaoCerta.png|semmoldura|center|600px]]

===Ajuda, Vídeos e Auditor===
Conheça melhor o ERP com a ajuda da Wiki e Cia, assista vídeos sobre o CIGAM e audite seu ambiente.

====Ajuda====
Nesse assunto, você pode acessar o Chatbot da assistente virtual, onde você pode tirar dúvidas e consultar conteúdos da CIGAM Wiki enviando perguntas diretamente nela.<br>
<br>
'''Importante:''' neste assunto, a Cia atua dedicada à Wiki, focada exclusivamente nos conteúdos da documentação. As demais funcionalidades e atalhos da Cia não estarão disponíveis nesse contexto.

====Vídeos====
Nesse assunto, é possível procurar por vídeos relacionados ao tema desejado. O resultado será apresentado em forma de lista, contendo os vídeos encontrados e os tempos exatos em que o assunto começa a ser abordado, de acordo com o termo ou palavra pesquisada.

====Auditor====
Neste assunto, é possível verificar o status do sistema e identificar possíveis problemas ou inconsistências. O resultado será exibido em forma de tabela, contendo os dados retornados para facilitar a análise.

===Painéis BI, Portais e Relatórios===
Explore dashboards do BI, interaja com Portais intuitivos e execute relatórios personalizados.

====Painéis BI====
Nesse assunto, é possível abrir dashboards do BI já configurados para o usuário, permitindo sua visualização diretamente na tela.
Ao abrir um dashboard, você também pode interagir com ele, solicitando inserção de filtros, dimensões, métricas, transformações e outros ajustes.<br>
Cada dashboard aberto exibirá uma guia com as “Interações” disponíveis para aquele painel específico.
<br><br>
Além disso, ao selecionar o assunto '''#Painéis do BI''', é possível solicitar que a Cia crie um dashboard do zero.
Por exemplo: "Crie um dashboard para ver meu fluxo de caixa". Você pode ainda solicitar que métricas, dimensões e filtros sejam adicionados durante a criação, ou pedir dashboards separados por áreas.
<br><br>
'''Importante:''' caso o usuário não possua acesso ao BI ou este não esteja implementado na base de dados, será exibida uma mensagem informativa no momento do login na Cia.

====Portais====
Quando este assunto é utilizado, o resultado será sempre a abertura de uma tela dos Portais, permitindo ao usuário acessar diretamente os conteúdos e funcionalidades disponíveis nesse ambiente.
<br><br>
Essa abertura é feita de forma integrada, garantindo uma navegação contínua entre a Cia e os Portais, sem necessidade de realizar novo login ou sair da plataforma.

====Relatórios====
Ao utilizar esse assunto, será exibida uma tela para preenchimento de filtros, permitindo a emissão de relatórios web.
<br><br>
Para que essa funcionalidade opere corretamente, é necessário garantir que a instalação da CDN e da Pesquisa Dinâmica no servidor de aplicação esteja configurada de forma adequada.
<br><br>
Os relatórios exibidos aqui são os mesmos disponíveis nos Portais CIGAM, portanto é essencial que esses componentes também estejam funcionando corretamente nesses Portais.

===Qual, Faça, Consultar, Listar, Analisar e Insights===
Crie registros, analise informações ou liste dados cadastrados no CIGAM.

====Qual====
Nesse assunto, a Cia vai consultar e processar informações diretamente no ERP, usando os dados e relacionamentos disponíveis no CIGAM, e retornar os resultados em forma de texto para você visualizar.
<br><br>
'''Importante:''' nem todas as opções estão liberadas. Para ver quais você pode usar, digite ? na caixa de texto. A Cia vai mostrar uma lista com todos os comandos e funções disponíveis.

====Faça====
Nesse assunto, a Cia sempre fará um processamento no CIGAM e retornará o status do resultado. Por exemplo, você pode solicitar que a Cia crie um alerta ou até mesmo crie uma nova empresa no sistema.
<br><br>
'''Dica:''' para saber quais treinamentos ou comandos estão disponíveis, digite ? na caixa de texto. A Cia mostrará uma lista com todas as opções implementadas para você usar.

====Consultar====
Nesse assunto, você poderá fazer consultas de dados para obter listagens de registros, conforme os treinamentos de tabelas disponíveis. O resultado será apresentado em forma de tabela, exibindo os dados retornados. Já existem diversas Views prontas, para que você possa listar informações de forma mais completa e rápida.
<br><br>
'''Dica:''' para ver exemplos de consultas já implementadas, digite ? na caixa de texto.

====Listar====
Nesse assunto, você pode montar sua própria consulta de dados, escolhendo os filtros e parâmetros para gerar uma listagem personalizada. Diferente do assunto #Consultar, aqui é possível utilizar qualquer tabela do CIGAM para montar sua consulta, escrevendo em linguagem natural o que deseja buscar.
<br><br>
'''Dica:''' para ver todas as tabelas disponíveis, digite ? na caixa de texto.

====Analisar====
Analise o arquivo selecionado para gerar gráficos interativos e informativos, apresentando insights relevantes que ajudam a identificar tendências, padrões e oportunidades de melhoria.
<br><br>
Esse recurso oferece uma visualização clara e intuitiva dos dados, facilitando a interpretação das informações e apoiando a tomada de decisões estratégicas.
<br><br>
'''Aviso:''' para utilizar esta funcionalidade, é necessário concordar que os dados enviados serão processados por modelos de IA de terceiros integrados à Cia.

[[Imagem:AnalisarCia.png|semmoldura|center|600px]]

====Insights====
Gere insights inteligentes a partir dos dados de uma consulta, com análises automáticas realizadas pela Cia, que identificam padrões, tendências e possíveis pontos de atenção. Esse recurso ajuda a transformar dados brutos em informações acionáveis, facilitando a tomada de decisões estratégicas e otimizando processos.
<br><br>
'''Aviso:''' ao utilizar o assunto “Insights”, você concorda que os dados e informações analisados poderão ser enviados para modelos de IA de terceiros integrados à Cia, exclusivamente para processamento e geração dos resultados apresentados.

===IA Generativa e Pesquisa na Internet===
Converse com a IA sobre assuntos diversos, crie conteúdos e pesquise na internet sobre qualquer coisa.

====IA Generativa====
Nesse assunto, ao interagir com a IA Generativa, você poderá fazer qualquer tipo de pergunta ou solicitação, de forma livre e criativa.
O resultado exibido será exatamente a resposta gerada pela IA, sem complementos da Cia. Você pode, por exemplo, solicitar que a IA melhore ou reformule um texto, crie conteúdos ou resuma informações.
<br><br>
'''Importante:''' nesse assunto, a Cia não estará integrada aos serviços e sistemas do CIGAM — a interação é exclusivamente com a IA Generativa.

====Pesquisa na Internet====
Use esse assunto para fazer pesquisas na internet e visualizar os resultados diretamente integrados na Cia, sem precisar sair da plataforma. Você pode pesquisar qualquer tema de interesse e abrir os links retornados para acessar conteúdos, notícias e informações de forma rápida e prática.
{{VoltarInicio}}

==Configurações==
O ícone de engrenagem, localizado no canto superior direito da página, reúne recursos de informação e gerenciamento. As opções disponíveis são:
* '''Respostas com áudio:''' quando ativado, as respostas da Cia são narradas em voz alta.
* '''Ambiente atual do CIGAM:''' exibe na tela o usuário logado e o ambiente em uso.
* '''Ver consumo:''' mostra a quantidade de tokens já utilizados e os usuários que geraram consumo.
* '''Limpar dados de navegação:''' exibe uma mensagem explicando como limpar os dados de navegação do navegador.
* '''Limpar cookies:''' apaga os dados armazenados localmente, permitindo informar novamente a API e realizar um novo login.
* '''Instalar aplicativo:''' instala a Cia como aplicativo no dispositivo, criando um atalho na tela inicial.
* '''Documentação na wiki:''' direciona para a documentação da Cia na CIGAM Wiki.
* '''Sair:''' encerra a sessão do usuário, permitindo realizar login com outro usuário.
<br>
[[Imagem:ConfiguracoesCia.png|semmoldura|center|500px]]
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, além do acesso à Cia Web pelo menu de mosaico, estão disponíveis recursos de IA que atuam diretamente nas telas em que você está trabalhando. Esses recursos não exigem parametrização e são apresentados de acordo com o contexto da tela.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia Web a partir dos Portais é feito pelo ícone de mosaico, onde está disponível o ícone da Cia - IA do CIGAM.<br>
<br>
[[Imagem:mosaicoCia.png|semmoldura|center|800px]]
<br>
A Cia será aberta de forma integrada, sem a necessidade de novo login, e todas as funcionalidades descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] estarão disponíveis normalmente.<br>

==Geração de conteúdo==
Na barra superior dos Portais está disponível um ícone com um menu de contexto que permite interagir com os '''campos de texto''' de qualquer parte dos Portais. As opções disponíveis permitem melhorar textos, criar conteúdos, revisar a gramática, entre outras ações.<br>
<br>
[[Imagem:comandosCia.png|semmoldura|center|650px]]
<br>
A partir da versão '''Beta 260601''', essas opções passaram a ser exibidas em uma seção separada, chamada '''Geração de conteúdo''', apresentada no mesmo menu em que ficam os agentes.<br>
<br>
[[Imagem:MenuGeracaoConteudoAgentes.png|semmoldura|center|800px]]
<br>
O campo processado é sempre o '''último campo em que o cursor esteve posicionado''' antes de abrir o menu da Cia. Por isso, basta clicar no campo desejado e, em seguida, acionar o menu e escolher o comando.<br>
<br>
Para que o comando seja executado, o campo precisa ser um '''campo de texto válido''' e conter, no mínimo, '''três palavras'''. Caso contrário, será apresentada uma mensagem informando que o conteúdo não atende aos requisitos.<br>
<br>
Após o processamento, o conteúdo gerado é aplicado automaticamente no campo, substituindo o texto anterior, sem necessidade de confirmação.<br>
<br>
Essa funcionalidade também está disponível em telas modais, ou seja, janelas sobrepostas com interações:<br>
<br>
[[Imagem:comandosModalCia.png|semmoldura|center|800px]]
<br>

==Agentes==
A partir da versão '''Beta 260601''', o menu da Cia nos Portais passou a disponibilizar também o acesso aos agentes, tanto nos Portais MVC quanto nos Portais React.<br>
<br>
Ao abrir o menu da Cia, os agentes disponíveis são detectados automaticamente de acordo com a tela que está sendo acessada, ou seja, as opções apresentadas variam conforme a página aberta.<br>
<br>
[[Imagem:MenuAgentesCia.png|semmoldura|center|800px]]
<br>

===Como os agentes são disponibilizados===
A disponibilização de cada agente pode ocorrer de quatro formas:<br>
<br>
* '''Por contexto:''' o agente é apresentado quando a Cia identifica que a tela acessada corresponde ao assunto tratado por ele. Por exemplo, um agente sobre Ordem de Produção será disponibilizado ao acessar uma página cujo contexto seja identificado como Ordem de Produção.
<br>
* '''Por parâmetro:''' o agente é apresentado quando a Cia identifica, na tela, um parâmetro com o valor esperado por ele. Por exemplo, um agente de Pedidos será disponibilizado quando existir na tela um parâmetro que contenha o código do pedido.
<br>
* '''Por contexto e parâmetro:''' o agente é apresentado somente quando as duas condições forem atendidas ao mesmo tempo.
<br>
* '''Sempre disponível:''' o agente é apresentado em qualquer tela, independentemente do contexto ou dos parâmetros.
<br>

===Resultado do processamento===
Após o processamento, o retorno do agente pode ser apresentado de duas formas, conforme o que foi executado:<br>
<br>
* Em uma '''nova guia''' do navegador, quando o agente gera algum conteúdo ou relatório como resultado.
<br>
[[Imagem:AgentesRetornoGuia.png|semmoldura|center|800px]]
<br>
* Em uma '''janela modal''', dentro da própria página em que o usuário está, quando o retorno é uma mensagem.
<br>
[[Imagem:AgentesRetornoModal.png|semmoldura|center|800px]]
<br>
<div align="justify>
A partir da versão '''Beta 261005''', quando o resultado do agente é apresentado em uma nova guia, a página passa a disponibilizar também opções para utilização e compartilhamento da análise.
</div>
[[Imagem:resultadoAnalise.png|semmoldura|center|800px]]
<div align="justify">
No cabeçalho são apresentados o nome do agente executado e as opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>
<div align="justify">
=====Compartilhamento por e-mail=====
A janela abaixo é exibida ao quando selecionada a opção '''E-mail''':
</div>
[[Imagem:modalEmail.png|semmoldura|center|800px]]
<div align="justify">

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
</div>

==Editor de Agentes==
A partir da versão '''Beta 261005''', o menu passou a disponibilizar o acesso à ferramenta '''Editor de Agentes''', que permite criar seus próprios agentes.<br>
<br>
[[Imagem:EditorAgentesCia.png|semmoldura|center|800px]]
<br>
Ao clicar na opção, será aberta uma página web no formato de assistente (wizard), com cada etapa explicada de forma detalhada. Basta preencher as informações do agente conforme a sua necessidade e avançar pelos passos até a conclusão.<br>
<br>
[[Imagem:EditorAgentesWizard.png|semmoldura|center|800px]]
<br>
Ao final do processo, será gerado um arquivo com a extensão '''.cgagt''', que contém a definição do agente criado.<br>
<br>

===Disponibilizando o agente criado===
Para que o agente passe a ser exibido nos Portais, o arquivo '''.cgagt''' precisa ser colocado na aplicação da API, dentro da pasta raiz da aplicação.<br>
<br>
É necessário que existam as pastas '''Exclusivo''' e, dentro dela, '''Agentes'''. Caso não existam, elas devem ser criadas manualmente. O arquivo deve ser colocado dentro dessa estrutura, ficando da seguinte forma:<br>
<br>
/api/exclusivo/agentes/
<br>
Assim que o arquivo é adicionado nesse local, a Cia passa a reconhecer o agente automaticamente, sem necessidade de qualquer outra configuração. Os agentes customizados são exibidos no menu da Cia nos Portais, em uma seção separada dos agentes padrão.<br>
<br>
[[Imagem:MenuAgentesCustomizados.png|semmoldura|center|800px]]
<br>
==Conversar com documentos==
Em construção...<br>
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, além do acesso rápido à Cia Web, algumas ferramentas do sistema disponibilizam o recurso "Analisar com a Cia".<br>

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM), disponível no menu lateral do Desktop, abre a Cia Web de forma integrada ao sistema, em uma janela do próprio CIGAM.<br>
<br>
Desde que as configurações necessárias tenham sido aplicadas, conforme [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Acesso rápido à Cia Web (SaaS)|Acesso rápido à Cia Web (SaaS)]], '''todas as funcionalidades da Cia Web estarão disponíveis normalmente''', da mesma forma que no acesso pelo navegador. Para conhecê-las, consulte a seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] desta documentação.<br>
<br>
[[Imagem:CiaAbertaDesktop.png|semmoldura|center|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''' está disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída. Em todas elas, o comportamento é o mesmo: a Cia analisa o conteúdo que está em uso na tela e gera um relatório com o resultado da análise, apresentado em uma nova página.<br>
<br>
Ao acionar a opção, o fluxo é o seguinte:<br>
<br>
'''1. Confirmação dos termos de uso'''<br>
Antes de qualquer envio, será exibida uma mensagem solicitando que o usuário concorde com o envio das informações para análise. Os dados enviados seguem as diretrizes de segurança, privacidade e não retenção descritas em [[#Recursos, configurações e segurança|Recursos, configurações e segurança]].<br>
<br>
[[Imagem:AnalisarCiaTermos.png|semmoldura|center|500px]]
<br>
'''2. Complemento do prompt (opcional)'''<br>
Em seguida, será apresentada uma caixa de texto para que o usuário complemente a solicitação, orientando a análise para algum ponto específico. O preenchimento é opcional e pode ser deixado em branco.<br>
<br>
Essa caixa de texto serve apenas para complementar o prompt base que a Cia monta automaticamente, e não altera o conteúdo que está sendo enviado. O recurso considera que o usuário já filtrou os dados na própria tela do CIGAM antes de acionar a análise. O prompt base é mantido oculto por ser extenso e técnico, evitando que o usuário precise conferi-lo a cada utilização.<br>
<br>
[[Imagem:AnalisarCiaPrompt.png|semmoldura|center|700px]]
<br>
'''3. Geração do relatório'''<br>
Após a confirmação, a Cia processa o conteúdo e apresenta o relatório em uma nova página flutuante, com a análise dos dados enviados.<br>
<br>
O próprio relatório informa a quantidade de dados que foi analisada, permitindo que o usuário veja o volume aproximado considerado e identifique se o conteúdo enviado corresponde ao que esperava.<br>
<br>
[[Imagem:AnalisarCiaRelatorio.png|semmoldura|center|700px]]
<br>

===Limite de conteúdo enviado===
Existe um limite para o volume de conteúdo enviado em cada análise, que varia conforme a versão do ambiente:<br>
<br>
* '''150 KB''' — desde a disponibilização do recurso, na versão '''250505.a'''.
* '''3 MB''' — a partir das patches '''250505.i''' e '''251103.a''', e da versão '''RC 260504'''.
<br>
Quando o conteúdo selecionado ultrapassa esse limite, a Cia exibe uma mensagem informando o tamanho excedido e a análise não é processada, ou seja, nenhum relatório será gerado.<br>
<br>
[[Imagem:AnalisarCiaLimite.png|semmoldura|center|600px]]
<br>
'''Esse limite não é parametrizável e não se trata de uma restrição imposta pela CIGAM.''' Ele decorre da própria capacidade dos modelos de IA integrados à Cia, que possuem um limite técnico de volume de dados que conseguem processar em uma única análise. Quando esse volume é ultrapassado, os modelos passam a analisar as informações por amostragem — ou seja, mesmo que fosse permitido enviar uma quantidade maior de dados, o modelo não analisaria todo o conteúdo, e o resultado seria menos preciso. O limite adotado pela Cia acompanha essa característica dos modelos e assegura que a análise seja feita sobre os dados completos.<br>
<br>
Além da qualidade da análise, há também a questão do tempo de processamento: quanto maior o volume enviado, maior o tempo de resposta do modelo, tornando a espera inviável para o uso no dia a dia.<br>
<br>
Por isso, o recurso foi feito para ser simples e direto: analisar, com um clique, os dados que o usuário já está visualizando pelos meios tradicionais do CIGAM, como grids filtrados e relatórios. Em ambientes com grande volume de dados, a prática recomendada é '''filtrar e consolidar as informações na própria tela antes de acionar a análise''', reduzindo o período ou o escopo consultado. Para análises de períodos maiores, recomenda-se utilizar dados já consolidados, como totalizadores e relatórios sintéticos, em vez de listagens analíticas completas.<br>
<br>
A CIGAM está trabalhando em outras ferramentas que, por processarem os dados de forma diferente, permitirão trabalhar com volumes maiores de informação.<br>

Para saber como acessar o recurso em cada ferramenta, consulte: [[GE - Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Configuração da Cia IA do CIGAM]]

GE - Como Fazer - Uso da Cia - IA do CIGAM

2026-10-08T18:18:00Z

Vinicius.moder: /* Resultado do processamento */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como_Fazer_Utilidades/Diversos_6]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer - Uso da Cia - IA do CIGAM]]

=Recursos, configurações e segurança=
A Cia - IA do CIGAM oferece diversas funcionalidades e atua como um hub centralizador para os recursos de inteligência artificial utilizados nas soluções CIGAM. Para garantir o correto funcionamento desses recursos, é necessário verificar se os pré-requisitos e as configurações foram realizados adequadamente. Para mais informações, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM|Como Fazer configuração da Cia IA do CIGAM]]
<br><br>
Todas as soluções de IA do CIGAM são integradas por meio dos serviços da Cia. A Cia possui integração com diferentes provedores de IA de terceiros, como OpenAI, Google, Anthropic, entre outros. Essas integrações são realizadas por meio de contas e serviços contratados, com condições de uso que asseguram que os dados trafegados não sejam utilizados para treinamento dos modelos, identificação de origem, publicidade, anúncios ou qualquer outra finalidade não prevista.
<br><br>
No caso de IAs open-source integradas à Cia, os modelos são executados dentro dos domínios da CIGAM, mantendo as mesmas premissas aplicadas às IAs contratadas: não utilização dos dados para treinamento de modelos, não identificação da origem das informações e ausência de retenção dos dados processados.
<br><br>
Além disso, sempre que houver envio explícito de dados pelo usuário por meio das funcionalidades da Cia disponíveis nas soluções CIGAM, será apresentado um diálogo de confirmação, permitindo que o usuário aceite o envio dessas informações. Os dados enviados serão tratados conforme as mesmas diretrizes de segurança, privacidade e não retenção descritas anteriormente.
<br><br>
Esta documentação apresenta o uso da Cia e está organizada conforme a forma de acesso: [[#Cia Web (SaaS)|Cia Web (SaaS)]], [[#Portais|Portais]] e [[#Desktop|Desktop]].
<br><br>
Caso tenha dúvidas sobre onde encontrar a Cia em cada uma dessas plataformas, ou sobre quais ferramentas do CIGAM possuem recursos integrados a ela, consulte a documentação específica de acesso: [[GE - Como Fazer - Cia - Como acessar|Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Cia Web (SaaS)=
A Cia Web é a aplicação web que centraliza todas as funcionalidades da Cia. Ela pode ser acessada diretamente pelo navegador do seu computador ou dispositivo móvel, ou ainda a partir do Desktop e dos Portais, sem a necessidade de novo login.
<br><br>

<center><youtube>https://youtu.be/DFGtRtPF75A</youtube></center>
<br>

==Primeiro acesso==
A Cia Web pode ser acessada diretamente pelo navegador, utilizando o seguinte endereço: https://services.cigam.cloud/cia/index.html
<br><br>
'''Importante:''' o usuário que for realizar o login precisa ter a autenticação em duas etapas habilitada. Para saber como configurá-la, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]]
<br><br>
Ao acessar pelo endereço, será necessário preencher algumas informações para que a Cia consiga validar seu acesso e consultar seus dados:<br>
* Informar a API do seu CIGAM Server, para garantir o direcionamento correto da base de dados.<br><br>

[[Imagem:CiaAPI.png|semmoldura|center|700px]]<br>

* Informar usuário e senha de login e seu código de verificação:<br><br>

[[Imagem:CiaLogin.png|semmoldura|center|700px]]
<br>
[[Imagem:CiaCodVerif.png|semmoldura|center|700px]]<br>

* Caso não queira aguardar ou informar o código de verificação, você pode optar por responder à pergunta secreta, clicando no botão “Pergunta Secreta” exibido na imagem acima.<br><br>

[[Imagem:CiaLoginA2F.png|semmoldura|center|700px]]
<br>

==Conhecendo a tela da Cia==
Após realizar o login, a Cia carregará automaticamente as informações e dados necessários do ambiente e será iniciada no assunto '''#Geral''', identificado pelo botão localizado à esquerda da caixa de texto.

[[Imagem:CiaGeral.png|semmoldura|center|700px]]
<br><br>
Ao clicar nesse botão, será exibida uma lista com todos os assuntos disponíveis, permitindo que você selecione aquele com o qual deseja interagir.<br><br>
Além disso, você pode digitar diretamente na caixa de texto o '''#Assunto''' que deseja utilizar, e a Cia entenderá automaticamente o tema da sua mensagem.<br><br>
Também é possível '''formular uma pergunta seguida de um #Assunto''' para interagir com qualquer assunto, mesmo que ele não esteja selecionado no momento.

[[Imagem:CiaAberta.png|semmoldura|center|700px]]
<br>
Ao selecionar um assunto, serão exibidas automaticamente dicas e sugestões sobre o tema escolhido, além de exemplos clicáveis que, ao serem selecionados, são processados de forma imediata.<br><br>
Além disso, ao digitar um ponto de interrogação (?) na caixa de texto, será exibida uma lista com todas as interações disponíveis para o assunto selecionado, facilitando a descoberta de comandos e possibilidades de uso.

[[Imagem:CiaDicas.png|semmoldura|center|700px]]
<br>
Outra funcionalidade prática é a possibilidade de reenviar perguntas já feitas no chat. Para isso, basta posicionar o mouse sobre a pergunta desejada e clicar no ícone de “Reenviar”. Ao passar o mouse sobre a mensagem, também será exibido o horário de envio.
<br>
[[Imagem:CiaReenviar.png|semmoldura|center|400px]]
<br>
Além disso, você pode utilizar as setas do teclado (⬆️ para cima e ⬇️ para baixo) na caixa de texto para navegar pelas últimas perguntas enviadas para o #Assunto selecionado, facilitando o reuso de interações anteriores.

===Ícones da caixa de texto===
Na caixa de texto, você encontrará alguns ícones com as seguintes funções:

<center>
{| class="wikitable"
|-
! !! Ação
|-
|center|[[Imagem:CiaUltPerg.png]] || '''Histórico de Perguntas''' – Ao clicar, é exibido o histórico das perguntas já realizadas para o assunto selecionado.
|-
|center|[[Imagem:CiaEnviar.png]] || '''Enviar''' – Envia o conteúdo digitado na caixa de texto.
|-
|center|[[Imagem:CiaFala.png]] || '''Falar''' – Permite falar ao invés de digitar, usando o recurso de voz.
|-
|center|[[Imagem:CiaExpandir.png]] || '''Expandir''' – Aumenta a altura da caixa de texto para facilitar a digitação de mensagens longas.
|-
|center|[[Imagem:CiaRecolher.png]] || '''Recolher''' – Reduz a caixa de texto ao tamanho padrão.
|}
</center>
{{VoltarInicio}}

==Assuntos disponíveis==

===Geral===
Nesse assunto, é possível conversar livremente com a Cia sobre qualquer um dos assuntos disponíveis. Se encontrar dificuldades para obter a resposta desejada, experimente selecionar um assunto específico, o que pode gerar resultados mais precisos.<br><br>
Se houver muitas respostas correspondentes, a Cia não executará nenhuma automaticamente. Em vez disso, exibirá uma opção com os valores possíveis, permitindo que você selecione manualmente a melhor alternativa.

[[Imagem:CiaGeralOpcoes.png|semmoldura|center|700px]]
<br>
Caso a Cia encontre uma resposta com confiança significativamente maior que as demais, ela será executada automaticamente.
<br><br>
No entanto, se você selecionar a opção “Não era bem isso o que eu queria”, a Cia exibirá outras opções relacionadas ao que foi solicitado, apresentando também um indicador de semáforo com a porcentagem de confiança de cada alternativa.

[[Imagem:CiaGeralOpcaoCerta.png|semmoldura|center|600px]]

===Ajuda, Vídeos e Auditor===
Conheça melhor o ERP com a ajuda da Wiki e Cia, assista vídeos sobre o CIGAM e audite seu ambiente.

====Ajuda====
Nesse assunto, você pode acessar o Chatbot da assistente virtual, onde você pode tirar dúvidas e consultar conteúdos da CIGAM Wiki enviando perguntas diretamente nela.<br>
<br>
'''Importante:''' neste assunto, a Cia atua dedicada à Wiki, focada exclusivamente nos conteúdos da documentação. As demais funcionalidades e atalhos da Cia não estarão disponíveis nesse contexto.

====Vídeos====
Nesse assunto, é possível procurar por vídeos relacionados ao tema desejado. O resultado será apresentado em forma de lista, contendo os vídeos encontrados e os tempos exatos em que o assunto começa a ser abordado, de acordo com o termo ou palavra pesquisada.

====Auditor====
Neste assunto, é possível verificar o status do sistema e identificar possíveis problemas ou inconsistências. O resultado será exibido em forma de tabela, contendo os dados retornados para facilitar a análise.

===Painéis BI, Portais e Relatórios===
Explore dashboards do BI, interaja com Portais intuitivos e execute relatórios personalizados.

====Painéis BI====
Nesse assunto, é possível abrir dashboards do BI já configurados para o usuário, permitindo sua visualização diretamente na tela.
Ao abrir um dashboard, você também pode interagir com ele, solicitando inserção de filtros, dimensões, métricas, transformações e outros ajustes.<br>
Cada dashboard aberto exibirá uma guia com as “Interações” disponíveis para aquele painel específico.
<br><br>
Além disso, ao selecionar o assunto '''#Painéis do BI''', é possível solicitar que a Cia crie um dashboard do zero.
Por exemplo: "Crie um dashboard para ver meu fluxo de caixa". Você pode ainda solicitar que métricas, dimensões e filtros sejam adicionados durante a criação, ou pedir dashboards separados por áreas.
<br><br>
'''Importante:''' caso o usuário não possua acesso ao BI ou este não esteja implementado na base de dados, será exibida uma mensagem informativa no momento do login na Cia.

====Portais====
Quando este assunto é utilizado, o resultado será sempre a abertura de uma tela dos Portais, permitindo ao usuário acessar diretamente os conteúdos e funcionalidades disponíveis nesse ambiente.
<br><br>
Essa abertura é feita de forma integrada, garantindo uma navegação contínua entre a Cia e os Portais, sem necessidade de realizar novo login ou sair da plataforma.

====Relatórios====
Ao utilizar esse assunto, será exibida uma tela para preenchimento de filtros, permitindo a emissão de relatórios web.
<br><br>
Para que essa funcionalidade opere corretamente, é necessário garantir que a instalação da CDN e da Pesquisa Dinâmica no servidor de aplicação esteja configurada de forma adequada.
<br><br>
Os relatórios exibidos aqui são os mesmos disponíveis nos Portais CIGAM, portanto é essencial que esses componentes também estejam funcionando corretamente nesses Portais.

===Qual, Faça, Consultar, Listar, Analisar e Insights===
Crie registros, analise informações ou liste dados cadastrados no CIGAM.

====Qual====
Nesse assunto, a Cia vai consultar e processar informações diretamente no ERP, usando os dados e relacionamentos disponíveis no CIGAM, e retornar os resultados em forma de texto para você visualizar.
<br><br>
'''Importante:''' nem todas as opções estão liberadas. Para ver quais você pode usar, digite ? na caixa de texto. A Cia vai mostrar uma lista com todos os comandos e funções disponíveis.

====Faça====
Nesse assunto, a Cia sempre fará um processamento no CIGAM e retornará o status do resultado. Por exemplo, você pode solicitar que a Cia crie um alerta ou até mesmo crie uma nova empresa no sistema.
<br><br>
'''Dica:''' para saber quais treinamentos ou comandos estão disponíveis, digite ? na caixa de texto. A Cia mostrará uma lista com todas as opções implementadas para você usar.

====Consultar====
Nesse assunto, você poderá fazer consultas de dados para obter listagens de registros, conforme os treinamentos de tabelas disponíveis. O resultado será apresentado em forma de tabela, exibindo os dados retornados. Já existem diversas Views prontas, para que você possa listar informações de forma mais completa e rápida.
<br><br>
'''Dica:''' para ver exemplos de consultas já implementadas, digite ? na caixa de texto.

====Listar====
Nesse assunto, você pode montar sua própria consulta de dados, escolhendo os filtros e parâmetros para gerar uma listagem personalizada. Diferente do assunto #Consultar, aqui é possível utilizar qualquer tabela do CIGAM para montar sua consulta, escrevendo em linguagem natural o que deseja buscar.
<br><br>
'''Dica:''' para ver todas as tabelas disponíveis, digite ? na caixa de texto.

====Analisar====
Analise o arquivo selecionado para gerar gráficos interativos e informativos, apresentando insights relevantes que ajudam a identificar tendências, padrões e oportunidades de melhoria.
<br><br>
Esse recurso oferece uma visualização clara e intuitiva dos dados, facilitando a interpretação das informações e apoiando a tomada de decisões estratégicas.
<br><br>
'''Aviso:''' para utilizar esta funcionalidade, é necessário concordar que os dados enviados serão processados por modelos de IA de terceiros integrados à Cia.

[[Imagem:AnalisarCia.png|semmoldura|center|600px]]

====Insights====
Gere insights inteligentes a partir dos dados de uma consulta, com análises automáticas realizadas pela Cia, que identificam padrões, tendências e possíveis pontos de atenção. Esse recurso ajuda a transformar dados brutos em informações acionáveis, facilitando a tomada de decisões estratégicas e otimizando processos.
<br><br>
'''Aviso:''' ao utilizar o assunto “Insights”, você concorda que os dados e informações analisados poderão ser enviados para modelos de IA de terceiros integrados à Cia, exclusivamente para processamento e geração dos resultados apresentados.

===IA Generativa e Pesquisa na Internet===
Converse com a IA sobre assuntos diversos, crie conteúdos e pesquise na internet sobre qualquer coisa.

====IA Generativa====
Nesse assunto, ao interagir com a IA Generativa, você poderá fazer qualquer tipo de pergunta ou solicitação, de forma livre e criativa.
O resultado exibido será exatamente a resposta gerada pela IA, sem complementos da Cia. Você pode, por exemplo, solicitar que a IA melhore ou reformule um texto, crie conteúdos ou resuma informações.
<br><br>
'''Importante:''' nesse assunto, a Cia não estará integrada aos serviços e sistemas do CIGAM — a interação é exclusivamente com a IA Generativa.

====Pesquisa na Internet====
Use esse assunto para fazer pesquisas na internet e visualizar os resultados diretamente integrados na Cia, sem precisar sair da plataforma. Você pode pesquisar qualquer tema de interesse e abrir os links retornados para acessar conteúdos, notícias e informações de forma rápida e prática.
{{VoltarInicio}}

==Configurações==
O ícone de engrenagem, localizado no canto superior direito da página, reúne recursos de informação e gerenciamento. As opções disponíveis são:
* '''Respostas com áudio:''' quando ativado, as respostas da Cia são narradas em voz alta.
* '''Ambiente atual do CIGAM:''' exibe na tela o usuário logado e o ambiente em uso.
* '''Ver consumo:''' mostra a quantidade de tokens já utilizados e os usuários que geraram consumo.
* '''Limpar dados de navegação:''' exibe uma mensagem explicando como limpar os dados de navegação do navegador.
* '''Limpar cookies:''' apaga os dados armazenados localmente, permitindo informar novamente a API e realizar um novo login.
* '''Instalar aplicativo:''' instala a Cia como aplicativo no dispositivo, criando um atalho na tela inicial.
* '''Documentação na wiki:''' direciona para a documentação da Cia na CIGAM Wiki.
* '''Sair:''' encerra a sessão do usuário, permitindo realizar login com outro usuário.
<br>
[[Imagem:ConfiguracoesCia.png|semmoldura|center|500px]]
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, além do acesso à Cia Web pelo menu de mosaico, estão disponíveis recursos de IA que atuam diretamente nas telas em que você está trabalhando. Esses recursos não exigem parametrização e são apresentados de acordo com o contexto da tela.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia Web a partir dos Portais é feito pelo ícone de mosaico, onde está disponível o ícone da Cia - IA do CIGAM.<br>
<br>
[[Imagem:mosaicoCia.png|semmoldura|center|800px]]
<br>
A Cia será aberta de forma integrada, sem a necessidade de novo login, e todas as funcionalidades descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] estarão disponíveis normalmente.<br>

==Geração de conteúdo==
Na barra superior dos Portais está disponível um ícone com um menu de contexto que permite interagir com os '''campos de texto''' de qualquer parte dos Portais. As opções disponíveis permitem melhorar textos, criar conteúdos, revisar a gramática, entre outras ações.<br>
<br>
[[Imagem:comandosCia.png|semmoldura|center|650px]]
<br>
A partir da versão '''Beta 260601''', essas opções passaram a ser exibidas em uma seção separada, chamada '''Geração de conteúdo''', apresentada no mesmo menu em que ficam os agentes.<br>
<br>
[[Imagem:MenuGeracaoConteudoAgentes.png|semmoldura|center|800px]]
<br>
O campo processado é sempre o '''último campo em que o cursor esteve posicionado''' antes de abrir o menu da Cia. Por isso, basta clicar no campo desejado e, em seguida, acionar o menu e escolher o comando.<br>
<br>
Para que o comando seja executado, o campo precisa ser um '''campo de texto válido''' e conter, no mínimo, '''três palavras'''. Caso contrário, será apresentada uma mensagem informando que o conteúdo não atende aos requisitos.<br>
<br>
Após o processamento, o conteúdo gerado é aplicado automaticamente no campo, substituindo o texto anterior, sem necessidade de confirmação.<br>
<br>
Essa funcionalidade também está disponível em telas modais, ou seja, janelas sobrepostas com interações:<br>
<br>
[[Imagem:comandosModalCia.png|semmoldura|center|800px]]
<br>

==Agentes==
A partir da versão '''Beta 260601''', o menu da Cia nos Portais passou a disponibilizar também o acesso aos agentes, tanto nos Portais MVC quanto nos Portais React.<br>
<br>
Ao abrir o menu da Cia, os agentes disponíveis são detectados automaticamente de acordo com a tela que está sendo acessada, ou seja, as opções apresentadas variam conforme a página aberta.<br>
<br>
[[Imagem:MenuAgentesCia.png|semmoldura|center|800px]]
<br>

===Como os agentes são disponibilizados===
A disponibilização de cada agente pode ocorrer de quatro formas:<br>
<br>
* '''Por contexto:''' o agente é apresentado quando a Cia identifica que a tela acessada corresponde ao assunto tratado por ele. Por exemplo, um agente sobre Ordem de Produção será disponibilizado ao acessar uma página cujo contexto seja identificado como Ordem de Produção.
<br>
* '''Por parâmetro:''' o agente é apresentado quando a Cia identifica, na tela, um parâmetro com o valor esperado por ele. Por exemplo, um agente de Pedidos será disponibilizado quando existir na tela um parâmetro que contenha o código do pedido.
<br>
* '''Por contexto e parâmetro:''' o agente é apresentado somente quando as duas condições forem atendidas ao mesmo tempo.
<br>
* '''Sempre disponível:''' o agente é apresentado em qualquer tela, independentemente do contexto ou dos parâmetros.
<br>

===Resultado do processamento===
Após o processamento, o retorno do agente pode ser apresentado de duas formas, conforme o que foi executado:<br>
<br>
* Em uma '''nova guia''' do navegador, quando o agente gera algum conteúdo ou relatório como resultado.
<br>
[[Imagem:AgentesRetornoGuia.png|semmoldura|center|800px]]
<br>
* Em uma '''janela modal''', dentro da própria página em que o usuário está, quando o retorno é uma mensagem.
<br>
[[Imagem:AgentesRetornoModal.png|semmoldura|center|800px]]
<br>
<div align="justify>
A partir da versão '''Beta 261005''', quando o resultado do agente é apresentado em uma nova guia, a página passa a disponibilizar também opções para utilização e compartilhamento da análise. O nome do agente executado também é exibido no cabeçalho:
</div>
[[Imagem:resultadoAnalise.png|semmoldura|center|800px]]
<div align="justify">
No cabeçalho são apresentados o nome do agente executado e as opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>
<div align="justify">
=====Compartilhamento por e-mail=====
A janela abaixo é exibida ao quando selecionada a opção '''E-mail''':
</div>
[[Imagem:modalEmail.png|semmoldura|center|800px]]
<div align="justify">

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
</div>

==Editor de Agentes==
A partir da versão '''Beta 261005''', o menu passou a disponibilizar o acesso à ferramenta '''Editor de Agentes''', que permite criar seus próprios agentes.<br>
<br>
[[Imagem:EditorAgentesCia.png|semmoldura|center|800px]]
<br>
Ao clicar na opção, será aberta uma página web no formato de assistente (wizard), com cada etapa explicada de forma detalhada. Basta preencher as informações do agente conforme a sua necessidade e avançar pelos passos até a conclusão.<br>
<br>
[[Imagem:EditorAgentesWizard.png|semmoldura|center|800px]]
<br>
Ao final do processo, será gerado um arquivo com a extensão '''.cgagt''', que contém a definição do agente criado.<br>
<br>

===Disponibilizando o agente criado===
Para que o agente passe a ser exibido nos Portais, o arquivo '''.cgagt''' precisa ser colocado na aplicação da API, dentro da pasta raiz da aplicação.<br>
<br>
É necessário que existam as pastas '''Exclusivo''' e, dentro dela, '''Agentes'''. Caso não existam, elas devem ser criadas manualmente. O arquivo deve ser colocado dentro dessa estrutura, ficando da seguinte forma:<br>
<br>
/api/exclusivo/agentes/
<br>
Assim que o arquivo é adicionado nesse local, a Cia passa a reconhecer o agente automaticamente, sem necessidade de qualquer outra configuração. Os agentes customizados são exibidos no menu da Cia nos Portais, em uma seção separada dos agentes padrão.<br>
<br>
[[Imagem:MenuAgentesCustomizados.png|semmoldura|center|800px]]
<br>
==Conversar com documentos==
Em construção...<br>
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, além do acesso rápido à Cia Web, algumas ferramentas do sistema disponibilizam o recurso "Analisar com a Cia".<br>

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM), disponível no menu lateral do Desktop, abre a Cia Web de forma integrada ao sistema, em uma janela do próprio CIGAM.<br>
<br>
Desde que as configurações necessárias tenham sido aplicadas, conforme [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Acesso rápido à Cia Web (SaaS)|Acesso rápido à Cia Web (SaaS)]], '''todas as funcionalidades da Cia Web estarão disponíveis normalmente''', da mesma forma que no acesso pelo navegador. Para conhecê-las, consulte a seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] desta documentação.<br>
<br>
[[Imagem:CiaAbertaDesktop.png|semmoldura|center|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''' está disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída. Em todas elas, o comportamento é o mesmo: a Cia analisa o conteúdo que está em uso na tela e gera um relatório com o resultado da análise, apresentado em uma nova página.<br>
<br>
Ao acionar a opção, o fluxo é o seguinte:<br>
<br>
'''1. Confirmação dos termos de uso'''<br>
Antes de qualquer envio, será exibida uma mensagem solicitando que o usuário concorde com o envio das informações para análise. Os dados enviados seguem as diretrizes de segurança, privacidade e não retenção descritas em [[#Recursos, configurações e segurança|Recursos, configurações e segurança]].<br>
<br>
[[Imagem:AnalisarCiaTermos.png|semmoldura|center|500px]]
<br>
'''2. Complemento do prompt (opcional)'''<br>
Em seguida, será apresentada uma caixa de texto para que o usuário complemente a solicitação, orientando a análise para algum ponto específico. O preenchimento é opcional e pode ser deixado em branco.<br>
<br>
Essa caixa de texto serve apenas para complementar o prompt base que a Cia monta automaticamente, e não altera o conteúdo que está sendo enviado. O recurso considera que o usuário já filtrou os dados na própria tela do CIGAM antes de acionar a análise. O prompt base é mantido oculto por ser extenso e técnico, evitando que o usuário precise conferi-lo a cada utilização.<br>
<br>
[[Imagem:AnalisarCiaPrompt.png|semmoldura|center|700px]]
<br>
'''3. Geração do relatório'''<br>
Após a confirmação, a Cia processa o conteúdo e apresenta o relatório em uma nova página flutuante, com a análise dos dados enviados.<br>
<br>
O próprio relatório informa a quantidade de dados que foi analisada, permitindo que o usuário veja o volume aproximado considerado e identifique se o conteúdo enviado corresponde ao que esperava.<br>
<br>
[[Imagem:AnalisarCiaRelatorio.png|semmoldura|center|700px]]
<br>

===Limite de conteúdo enviado===
Existe um limite para o volume de conteúdo enviado em cada análise, que varia conforme a versão do ambiente:<br>
<br>
* '''150 KB''' — desde a disponibilização do recurso, na versão '''250505.a'''.
* '''3 MB''' — a partir das patches '''250505.i''' e '''251103.a''', e da versão '''RC 260504'''.
<br>
Quando o conteúdo selecionado ultrapassa esse limite, a Cia exibe uma mensagem informando o tamanho excedido e a análise não é processada, ou seja, nenhum relatório será gerado.<br>
<br>
[[Imagem:AnalisarCiaLimite.png|semmoldura|center|600px]]
<br>
'''Esse limite não é parametrizável e não se trata de uma restrição imposta pela CIGAM.''' Ele decorre da própria capacidade dos modelos de IA integrados à Cia, que possuem um limite técnico de volume de dados que conseguem processar em uma única análise. Quando esse volume é ultrapassado, os modelos passam a analisar as informações por amostragem — ou seja, mesmo que fosse permitido enviar uma quantidade maior de dados, o modelo não analisaria todo o conteúdo, e o resultado seria menos preciso. O limite adotado pela Cia acompanha essa característica dos modelos e assegura que a análise seja feita sobre os dados completos.<br>
<br>
Além da qualidade da análise, há também a questão do tempo de processamento: quanto maior o volume enviado, maior o tempo de resposta do modelo, tornando a espera inviável para o uso no dia a dia.<br>
<br>
Por isso, o recurso foi feito para ser simples e direto: analisar, com um clique, os dados que o usuário já está visualizando pelos meios tradicionais do CIGAM, como grids filtrados e relatórios. Em ambientes com grande volume de dados, a prática recomendada é '''filtrar e consolidar as informações na própria tela antes de acionar a análise''', reduzindo o período ou o escopo consultado. Para análises de períodos maiores, recomenda-se utilizar dados já consolidados, como totalizadores e relatórios sintéticos, em vez de listagens analíticas completas.<br>
<br>
A CIGAM está trabalhando em outras ferramentas que, por processarem os dados de forma diferente, permitirão trabalhar com volumes maiores de informação.<br>

Para saber como acessar o recurso em cada ferramenta, consulte: [[GE - Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Configuração da Cia IA do CIGAM]]

Arquivo:ModalEmail.png

2026-10-08T18:16:14Z

Vinicius.moder:

Arquivo:ResultadoAnalise.png

2026-10-08T18:14:49Z

Vinicius.moder:

GE - Como Fazer - Uso da Cia - IA do CIGAM

2026-10-08T18:02:50Z

Vinicius.moder: /* Compartilhamento por e-mail */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como_Fazer_Utilidades/Diversos_6]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer - Uso da Cia - IA do CIGAM]]

=Recursos, configurações e segurança=
A Cia - IA do CIGAM oferece diversas funcionalidades e atua como um hub centralizador para os recursos de inteligência artificial utilizados nas soluções CIGAM. Para garantir o correto funcionamento desses recursos, é necessário verificar se os pré-requisitos e as configurações foram realizados adequadamente. Para mais informações, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM|Como Fazer configuração da Cia IA do CIGAM]]
<br><br>
Todas as soluções de IA do CIGAM são integradas por meio dos serviços da Cia. A Cia possui integração com diferentes provedores de IA de terceiros, como OpenAI, Google, Anthropic, entre outros. Essas integrações são realizadas por meio de contas e serviços contratados, com condições de uso que asseguram que os dados trafegados não sejam utilizados para treinamento dos modelos, identificação de origem, publicidade, anúncios ou qualquer outra finalidade não prevista.
<br><br>
No caso de IAs open-source integradas à Cia, os modelos são executados dentro dos domínios da CIGAM, mantendo as mesmas premissas aplicadas às IAs contratadas: não utilização dos dados para treinamento de modelos, não identificação da origem das informações e ausência de retenção dos dados processados.
<br><br>
Além disso, sempre que houver envio explícito de dados pelo usuário por meio das funcionalidades da Cia disponíveis nas soluções CIGAM, será apresentado um diálogo de confirmação, permitindo que o usuário aceite o envio dessas informações. Os dados enviados serão tratados conforme as mesmas diretrizes de segurança, privacidade e não retenção descritas anteriormente.
<br><br>
Esta documentação apresenta o uso da Cia e está organizada conforme a forma de acesso: [[#Cia Web (SaaS)|Cia Web (SaaS)]], [[#Portais|Portais]] e [[#Desktop|Desktop]].
<br><br>
Caso tenha dúvidas sobre onde encontrar a Cia em cada uma dessas plataformas, ou sobre quais ferramentas do CIGAM possuem recursos integrados a ela, consulte a documentação específica de acesso: [[GE - Como Fazer - Cia - Como acessar|Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Cia Web (SaaS)=
A Cia Web é a aplicação web que centraliza todas as funcionalidades da Cia. Ela pode ser acessada diretamente pelo navegador do seu computador ou dispositivo móvel, ou ainda a partir do Desktop e dos Portais, sem a necessidade de novo login.
<br><br>

<center><youtube>https://youtu.be/DFGtRtPF75A</youtube></center>
<br>

==Primeiro acesso==
A Cia Web pode ser acessada diretamente pelo navegador, utilizando o seguinte endereço: https://services.cigam.cloud/cia/index.html
<br><br>
'''Importante:''' o usuário que for realizar o login precisa ter a autenticação em duas etapas habilitada. Para saber como configurá-la, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]]
<br><br>
Ao acessar pelo endereço, será necessário preencher algumas informações para que a Cia consiga validar seu acesso e consultar seus dados:<br>
* Informar a API do seu CIGAM Server, para garantir o direcionamento correto da base de dados.<br><br>

[[Imagem:CiaAPI.png|semmoldura|center|700px]]<br>

* Informar usuário e senha de login e seu código de verificação:<br><br>

[[Imagem:CiaLogin.png|semmoldura|center|700px]]
<br>
[[Imagem:CiaCodVerif.png|semmoldura|center|700px]]<br>

* Caso não queira aguardar ou informar o código de verificação, você pode optar por responder à pergunta secreta, clicando no botão “Pergunta Secreta” exibido na imagem acima.<br><br>

[[Imagem:CiaLoginA2F.png|semmoldura|center|700px]]
<br>

==Conhecendo a tela da Cia==
Após realizar o login, a Cia carregará automaticamente as informações e dados necessários do ambiente e será iniciada no assunto '''#Geral''', identificado pelo botão localizado à esquerda da caixa de texto.

[[Imagem:CiaGeral.png|semmoldura|center|700px]]
<br><br>
Ao clicar nesse botão, será exibida uma lista com todos os assuntos disponíveis, permitindo que você selecione aquele com o qual deseja interagir.<br><br>
Além disso, você pode digitar diretamente na caixa de texto o '''#Assunto''' que deseja utilizar, e a Cia entenderá automaticamente o tema da sua mensagem.<br><br>
Também é possível '''formular uma pergunta seguida de um #Assunto''' para interagir com qualquer assunto, mesmo que ele não esteja selecionado no momento.

[[Imagem:CiaAberta.png|semmoldura|center|700px]]
<br>
Ao selecionar um assunto, serão exibidas automaticamente dicas e sugestões sobre o tema escolhido, além de exemplos clicáveis que, ao serem selecionados, são processados de forma imediata.<br><br>
Além disso, ao digitar um ponto de interrogação (?) na caixa de texto, será exibida uma lista com todas as interações disponíveis para o assunto selecionado, facilitando a descoberta de comandos e possibilidades de uso.

[[Imagem:CiaDicas.png|semmoldura|center|700px]]
<br>
Outra funcionalidade prática é a possibilidade de reenviar perguntas já feitas no chat. Para isso, basta posicionar o mouse sobre a pergunta desejada e clicar no ícone de “Reenviar”. Ao passar o mouse sobre a mensagem, também será exibido o horário de envio.
<br>
[[Imagem:CiaReenviar.png|semmoldura|center|400px]]
<br>
Além disso, você pode utilizar as setas do teclado (⬆️ para cima e ⬇️ para baixo) na caixa de texto para navegar pelas últimas perguntas enviadas para o #Assunto selecionado, facilitando o reuso de interações anteriores.

===Ícones da caixa de texto===
Na caixa de texto, você encontrará alguns ícones com as seguintes funções:

<center>
{| class="wikitable"
|-
! !! Ação
|-
|center|[[Imagem:CiaUltPerg.png]] || '''Histórico de Perguntas''' – Ao clicar, é exibido o histórico das perguntas já realizadas para o assunto selecionado.
|-
|center|[[Imagem:CiaEnviar.png]] || '''Enviar''' – Envia o conteúdo digitado na caixa de texto.
|-
|center|[[Imagem:CiaFala.png]] || '''Falar''' – Permite falar ao invés de digitar, usando o recurso de voz.
|-
|center|[[Imagem:CiaExpandir.png]] || '''Expandir''' – Aumenta a altura da caixa de texto para facilitar a digitação de mensagens longas.
|-
|center|[[Imagem:CiaRecolher.png]] || '''Recolher''' – Reduz a caixa de texto ao tamanho padrão.
|}
</center>
{{VoltarInicio}}

==Assuntos disponíveis==

===Geral===
Nesse assunto, é possível conversar livremente com a Cia sobre qualquer um dos assuntos disponíveis. Se encontrar dificuldades para obter a resposta desejada, experimente selecionar um assunto específico, o que pode gerar resultados mais precisos.<br><br>
Se houver muitas respostas correspondentes, a Cia não executará nenhuma automaticamente. Em vez disso, exibirá uma opção com os valores possíveis, permitindo que você selecione manualmente a melhor alternativa.

[[Imagem:CiaGeralOpcoes.png|semmoldura|center|700px]]
<br>
Caso a Cia encontre uma resposta com confiança significativamente maior que as demais, ela será executada automaticamente.
<br><br>
No entanto, se você selecionar a opção “Não era bem isso o que eu queria”, a Cia exibirá outras opções relacionadas ao que foi solicitado, apresentando também um indicador de semáforo com a porcentagem de confiança de cada alternativa.

[[Imagem:CiaGeralOpcaoCerta.png|semmoldura|center|600px]]

===Ajuda, Vídeos e Auditor===
Conheça melhor o ERP com a ajuda da Wiki e Cia, assista vídeos sobre o CIGAM e audite seu ambiente.

====Ajuda====
Nesse assunto, você pode acessar o Chatbot da assistente virtual, onde você pode tirar dúvidas e consultar conteúdos da CIGAM Wiki enviando perguntas diretamente nela.<br>
<br>
'''Importante:''' neste assunto, a Cia atua dedicada à Wiki, focada exclusivamente nos conteúdos da documentação. As demais funcionalidades e atalhos da Cia não estarão disponíveis nesse contexto.

====Vídeos====
Nesse assunto, é possível procurar por vídeos relacionados ao tema desejado. O resultado será apresentado em forma de lista, contendo os vídeos encontrados e os tempos exatos em que o assunto começa a ser abordado, de acordo com o termo ou palavra pesquisada.

====Auditor====
Neste assunto, é possível verificar o status do sistema e identificar possíveis problemas ou inconsistências. O resultado será exibido em forma de tabela, contendo os dados retornados para facilitar a análise.

===Painéis BI, Portais e Relatórios===
Explore dashboards do BI, interaja com Portais intuitivos e execute relatórios personalizados.

====Painéis BI====
Nesse assunto, é possível abrir dashboards do BI já configurados para o usuário, permitindo sua visualização diretamente na tela.
Ao abrir um dashboard, você também pode interagir com ele, solicitando inserção de filtros, dimensões, métricas, transformações e outros ajustes.<br>
Cada dashboard aberto exibirá uma guia com as “Interações” disponíveis para aquele painel específico.
<br><br>
Além disso, ao selecionar o assunto '''#Painéis do BI''', é possível solicitar que a Cia crie um dashboard do zero.
Por exemplo: "Crie um dashboard para ver meu fluxo de caixa". Você pode ainda solicitar que métricas, dimensões e filtros sejam adicionados durante a criação, ou pedir dashboards separados por áreas.
<br><br>
'''Importante:''' caso o usuário não possua acesso ao BI ou este não esteja implementado na base de dados, será exibida uma mensagem informativa no momento do login na Cia.

====Portais====
Quando este assunto é utilizado, o resultado será sempre a abertura de uma tela dos Portais, permitindo ao usuário acessar diretamente os conteúdos e funcionalidades disponíveis nesse ambiente.
<br><br>
Essa abertura é feita de forma integrada, garantindo uma navegação contínua entre a Cia e os Portais, sem necessidade de realizar novo login ou sair da plataforma.

====Relatórios====
Ao utilizar esse assunto, será exibida uma tela para preenchimento de filtros, permitindo a emissão de relatórios web.
<br><br>
Para que essa funcionalidade opere corretamente, é necessário garantir que a instalação da CDN e da Pesquisa Dinâmica no servidor de aplicação esteja configurada de forma adequada.
<br><br>
Os relatórios exibidos aqui são os mesmos disponíveis nos Portais CIGAM, portanto é essencial que esses componentes também estejam funcionando corretamente nesses Portais.

===Qual, Faça, Consultar, Listar, Analisar e Insights===
Crie registros, analise informações ou liste dados cadastrados no CIGAM.

====Qual====
Nesse assunto, a Cia vai consultar e processar informações diretamente no ERP, usando os dados e relacionamentos disponíveis no CIGAM, e retornar os resultados em forma de texto para você visualizar.
<br><br>
'''Importante:''' nem todas as opções estão liberadas. Para ver quais você pode usar, digite ? na caixa de texto. A Cia vai mostrar uma lista com todos os comandos e funções disponíveis.

====Faça====
Nesse assunto, a Cia sempre fará um processamento no CIGAM e retornará o status do resultado. Por exemplo, você pode solicitar que a Cia crie um alerta ou até mesmo crie uma nova empresa no sistema.
<br><br>
'''Dica:''' para saber quais treinamentos ou comandos estão disponíveis, digite ? na caixa de texto. A Cia mostrará uma lista com todas as opções implementadas para você usar.

====Consultar====
Nesse assunto, você poderá fazer consultas de dados para obter listagens de registros, conforme os treinamentos de tabelas disponíveis. O resultado será apresentado em forma de tabela, exibindo os dados retornados. Já existem diversas Views prontas, para que você possa listar informações de forma mais completa e rápida.
<br><br>
'''Dica:''' para ver exemplos de consultas já implementadas, digite ? na caixa de texto.

====Listar====
Nesse assunto, você pode montar sua própria consulta de dados, escolhendo os filtros e parâmetros para gerar uma listagem personalizada. Diferente do assunto #Consultar, aqui é possível utilizar qualquer tabela do CIGAM para montar sua consulta, escrevendo em linguagem natural o que deseja buscar.
<br><br>
'''Dica:''' para ver todas as tabelas disponíveis, digite ? na caixa de texto.

====Analisar====
Analise o arquivo selecionado para gerar gráficos interativos e informativos, apresentando insights relevantes que ajudam a identificar tendências, padrões e oportunidades de melhoria.
<br><br>
Esse recurso oferece uma visualização clara e intuitiva dos dados, facilitando a interpretação das informações e apoiando a tomada de decisões estratégicas.
<br><br>
'''Aviso:''' para utilizar esta funcionalidade, é necessário concordar que os dados enviados serão processados por modelos de IA de terceiros integrados à Cia.

[[Imagem:AnalisarCia.png|semmoldura|center|600px]]

====Insights====
Gere insights inteligentes a partir dos dados de uma consulta, com análises automáticas realizadas pela Cia, que identificam padrões, tendências e possíveis pontos de atenção. Esse recurso ajuda a transformar dados brutos em informações acionáveis, facilitando a tomada de decisões estratégicas e otimizando processos.
<br><br>
'''Aviso:''' ao utilizar o assunto “Insights”, você concorda que os dados e informações analisados poderão ser enviados para modelos de IA de terceiros integrados à Cia, exclusivamente para processamento e geração dos resultados apresentados.

===IA Generativa e Pesquisa na Internet===
Converse com a IA sobre assuntos diversos, crie conteúdos e pesquise na internet sobre qualquer coisa.

====IA Generativa====
Nesse assunto, ao interagir com a IA Generativa, você poderá fazer qualquer tipo de pergunta ou solicitação, de forma livre e criativa.
O resultado exibido será exatamente a resposta gerada pela IA, sem complementos da Cia. Você pode, por exemplo, solicitar que a IA melhore ou reformule um texto, crie conteúdos ou resuma informações.
<br><br>
'''Importante:''' nesse assunto, a Cia não estará integrada aos serviços e sistemas do CIGAM — a interação é exclusivamente com a IA Generativa.

====Pesquisa na Internet====
Use esse assunto para fazer pesquisas na internet e visualizar os resultados diretamente integrados na Cia, sem precisar sair da plataforma. Você pode pesquisar qualquer tema de interesse e abrir os links retornados para acessar conteúdos, notícias e informações de forma rápida e prática.
{{VoltarInicio}}

==Configurações==
O ícone de engrenagem, localizado no canto superior direito da página, reúne recursos de informação e gerenciamento. As opções disponíveis são:
* '''Respostas com áudio:''' quando ativado, as respostas da Cia são narradas em voz alta.
* '''Ambiente atual do CIGAM:''' exibe na tela o usuário logado e o ambiente em uso.
* '''Ver consumo:''' mostra a quantidade de tokens já utilizados e os usuários que geraram consumo.
* '''Limpar dados de navegação:''' exibe uma mensagem explicando como limpar os dados de navegação do navegador.
* '''Limpar cookies:''' apaga os dados armazenados localmente, permitindo informar novamente a API e realizar um novo login.
* '''Instalar aplicativo:''' instala a Cia como aplicativo no dispositivo, criando um atalho na tela inicial.
* '''Documentação na wiki:''' direciona para a documentação da Cia na CIGAM Wiki.
* '''Sair:''' encerra a sessão do usuário, permitindo realizar login com outro usuário.
<br>
[[Imagem:ConfiguracoesCia.png|semmoldura|center|500px]]
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, além do acesso à Cia Web pelo menu de mosaico, estão disponíveis recursos de IA que atuam diretamente nas telas em que você está trabalhando. Esses recursos não exigem parametrização e são apresentados de acordo com o contexto da tela.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia Web a partir dos Portais é feito pelo ícone de mosaico, onde está disponível o ícone da Cia - IA do CIGAM.<br>
<br>
[[Imagem:mosaicoCia.png|semmoldura|center|800px]]
<br>
A Cia será aberta de forma integrada, sem a necessidade de novo login, e todas as funcionalidades descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] estarão disponíveis normalmente.<br>

==Geração de conteúdo==
Na barra superior dos Portais está disponível um ícone com um menu de contexto que permite interagir com os '''campos de texto''' de qualquer parte dos Portais. As opções disponíveis permitem melhorar textos, criar conteúdos, revisar a gramática, entre outras ações.<br>
<br>
[[Imagem:comandosCia.png|semmoldura|center|650px]]
<br>
A partir da versão '''Beta 260601''', essas opções passaram a ser exibidas em uma seção separada, chamada '''Geração de conteúdo''', apresentada no mesmo menu em que ficam os agentes.<br>
<br>
[[Imagem:MenuGeracaoConteudoAgentes.png|semmoldura|center|800px]]
<br>
O campo processado é sempre o '''último campo em que o cursor esteve posicionado''' antes de abrir o menu da Cia. Por isso, basta clicar no campo desejado e, em seguida, acionar o menu e escolher o comando.<br>
<br>
Para que o comando seja executado, o campo precisa ser um '''campo de texto válido''' e conter, no mínimo, '''três palavras'''. Caso contrário, será apresentada uma mensagem informando que o conteúdo não atende aos requisitos.<br>
<br>
Após o processamento, o conteúdo gerado é aplicado automaticamente no campo, substituindo o texto anterior, sem necessidade de confirmação.<br>
<br>
Essa funcionalidade também está disponível em telas modais, ou seja, janelas sobrepostas com interações:<br>
<br>
[[Imagem:comandosModalCia.png|semmoldura|center|800px]]
<br>

==Agentes==
A partir da versão '''Beta 260601''', o menu da Cia nos Portais passou a disponibilizar também o acesso aos agentes, tanto nos Portais MVC quanto nos Portais React.<br>
<br>
Ao abrir o menu da Cia, os agentes disponíveis são detectados automaticamente de acordo com a tela que está sendo acessada, ou seja, as opções apresentadas variam conforme a página aberta.<br>
<br>
[[Imagem:MenuAgentesCia.png|semmoldura|center|800px]]
<br>

===Como os agentes são disponibilizados===
A disponibilização de cada agente pode ocorrer de quatro formas:<br>
<br>
* '''Por contexto:''' o agente é apresentado quando a Cia identifica que a tela acessada corresponde ao assunto tratado por ele. Por exemplo, um agente sobre Ordem de Produção será disponibilizado ao acessar uma página cujo contexto seja identificado como Ordem de Produção.
<br>
* '''Por parâmetro:''' o agente é apresentado quando a Cia identifica, na tela, um parâmetro com o valor esperado por ele. Por exemplo, um agente de Pedidos será disponibilizado quando existir na tela um parâmetro que contenha o código do pedido.
<br>
* '''Por contexto e parâmetro:''' o agente é apresentado somente quando as duas condições forem atendidas ao mesmo tempo.
<br>
* '''Sempre disponível:''' o agente é apresentado em qualquer tela, independentemente do contexto ou dos parâmetros.
<br>

===Resultado do processamento===
Após o processamento, o retorno do agente pode ser apresentado de duas formas, conforme o que foi executado:<br>
<br>
* Em uma '''nova guia''' do navegador, quando o agente gera algum conteúdo ou relatório como resultado.
<br>
[[Imagem:AgentesRetornoGuia.png|semmoldura|center|800px]]
<br>
* Em uma '''janela modal''', dentro da própria página em que o usuário está, quando o retorno é uma mensagem.
<br>
[[Imagem:AgentesRetornoModal.png|semmoldura|center|800px]]
<br>
<div align="justify>
A partir da versão '''Beta 261005''', quando o resultado do agente é apresentado em uma nova guia, a página passa a disponibilizar também opções para utilização e compartilhamento da análise.
</div>
[[Imagem:resultadoAnalise.png|semmoldura|center|800px]]
<div align="justify">
No cabeçalho são apresentados o nome do agente executado e as opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>
<div align="justify">
=====Compartilhamento por e-mail=====
A janela abaixo é exibida ao quando selecionada a opção '''E-mail''':
</div>
[[Imagem:modalEmail.png|semmoldura|center|800px]]
<div align="justify">

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
</div>

==Editor de Agentes==
A partir da versão '''Beta 261005''', o menu passou a disponibilizar o acesso à ferramenta '''Editor de Agentes''', que permite criar seus próprios agentes.<br>
<br>
[[Imagem:EditorAgentesCia.png|semmoldura|center|800px]]
<br>
Ao clicar na opção, será aberta uma página web no formato de assistente (wizard), com cada etapa explicada de forma detalhada. Basta preencher as informações do agente conforme a sua necessidade e avançar pelos passos até a conclusão.<br>
<br>
[[Imagem:EditorAgentesWizard.png|semmoldura|center|800px]]
<br>
Ao final do processo, será gerado um arquivo com a extensão '''.cgagt''', que contém a definição do agente criado.<br>
<br>

===Disponibilizando o agente criado===
Para que o agente passe a ser exibido nos Portais, o arquivo '''.cgagt''' precisa ser colocado na aplicação da API, dentro da pasta raiz da aplicação.<br>
<br>
É necessário que existam as pastas '''Exclusivo''' e, dentro dela, '''Agentes'''. Caso não existam, elas devem ser criadas manualmente. O arquivo deve ser colocado dentro dessa estrutura, ficando da seguinte forma:<br>
<br>
/api/exclusivo/agentes/
<br>
Assim que o arquivo é adicionado nesse local, a Cia passa a reconhecer o agente automaticamente, sem necessidade de qualquer outra configuração. Os agentes customizados são exibidos no menu da Cia nos Portais, em uma seção separada dos agentes padrão.<br>
<br>
[[Imagem:MenuAgentesCustomizados.png|semmoldura|center|800px]]
<br>
==Conversar com documentos==
Em construção...<br>
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, além do acesso rápido à Cia Web, algumas ferramentas do sistema disponibilizam o recurso "Analisar com a Cia".<br>

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM), disponível no menu lateral do Desktop, abre a Cia Web de forma integrada ao sistema, em uma janela do próprio CIGAM.<br>
<br>
Desde que as configurações necessárias tenham sido aplicadas, conforme [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Acesso rápido à Cia Web (SaaS)|Acesso rápido à Cia Web (SaaS)]], '''todas as funcionalidades da Cia Web estarão disponíveis normalmente''', da mesma forma que no acesso pelo navegador. Para conhecê-las, consulte a seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] desta documentação.<br>
<br>
[[Imagem:CiaAbertaDesktop.png|semmoldura|center|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''' está disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída. Em todas elas, o comportamento é o mesmo: a Cia analisa o conteúdo que está em uso na tela e gera um relatório com o resultado da análise, apresentado em uma nova página.<br>
<br>
Ao acionar a opção, o fluxo é o seguinte:<br>
<br>
'''1. Confirmação dos termos de uso'''<br>
Antes de qualquer envio, será exibida uma mensagem solicitando que o usuário concorde com o envio das informações para análise. Os dados enviados seguem as diretrizes de segurança, privacidade e não retenção descritas em [[#Recursos, configurações e segurança|Recursos, configurações e segurança]].<br>
<br>
[[Imagem:AnalisarCiaTermos.png|semmoldura|center|500px]]
<br>
'''2. Complemento do prompt (opcional)'''<br>
Em seguida, será apresentada uma caixa de texto para que o usuário complemente a solicitação, orientando a análise para algum ponto específico. O preenchimento é opcional e pode ser deixado em branco.<br>
<br>
Essa caixa de texto serve apenas para complementar o prompt base que a Cia monta automaticamente, e não altera o conteúdo que está sendo enviado. O recurso considera que o usuário já filtrou os dados na própria tela do CIGAM antes de acionar a análise. O prompt base é mantido oculto por ser extenso e técnico, evitando que o usuário precise conferi-lo a cada utilização.<br>
<br>
[[Imagem:AnalisarCiaPrompt.png|semmoldura|center|700px]]
<br>
'''3. Geração do relatório'''<br>
Após a confirmação, a Cia processa o conteúdo e apresenta o relatório em uma nova página flutuante, com a análise dos dados enviados.<br>
<br>
O próprio relatório informa a quantidade de dados que foi analisada, permitindo que o usuário veja o volume aproximado considerado e identifique se o conteúdo enviado corresponde ao que esperava.<br>
<br>
[[Imagem:AnalisarCiaRelatorio.png|semmoldura|center|700px]]
<br>

===Limite de conteúdo enviado===
Existe um limite para o volume de conteúdo enviado em cada análise, que varia conforme a versão do ambiente:<br>
<br>
* '''150 KB''' — desde a disponibilização do recurso, na versão '''250505.a'''.
* '''3 MB''' — a partir das patches '''250505.i''' e '''251103.a''', e da versão '''RC 260504'''.
<br>
Quando o conteúdo selecionado ultrapassa esse limite, a Cia exibe uma mensagem informando o tamanho excedido e a análise não é processada, ou seja, nenhum relatório será gerado.<br>
<br>
[[Imagem:AnalisarCiaLimite.png|semmoldura|center|600px]]
<br>
'''Esse limite não é parametrizável e não se trata de uma restrição imposta pela CIGAM.''' Ele decorre da própria capacidade dos modelos de IA integrados à Cia, que possuem um limite técnico de volume de dados que conseguem processar em uma única análise. Quando esse volume é ultrapassado, os modelos passam a analisar as informações por amostragem — ou seja, mesmo que fosse permitido enviar uma quantidade maior de dados, o modelo não analisaria todo o conteúdo, e o resultado seria menos preciso. O limite adotado pela Cia acompanha essa característica dos modelos e assegura que a análise seja feita sobre os dados completos.<br>
<br>
Além da qualidade da análise, há também a questão do tempo de processamento: quanto maior o volume enviado, maior o tempo de resposta do modelo, tornando a espera inviável para o uso no dia a dia.<br>
<br>
Por isso, o recurso foi feito para ser simples e direto: analisar, com um clique, os dados que o usuário já está visualizando pelos meios tradicionais do CIGAM, como grids filtrados e relatórios. Em ambientes com grande volume de dados, a prática recomendada é '''filtrar e consolidar as informações na própria tela antes de acionar a análise''', reduzindo o período ou o escopo consultado. Para análises de períodos maiores, recomenda-se utilizar dados já consolidados, como totalizadores e relatórios sintéticos, em vez de listagens analíticas completas.<br>
<br>
A CIGAM está trabalhando em outras ferramentas que, por processarem os dados de forma diferente, permitirão trabalhar com volumes maiores de informação.<br>

Para saber como acessar o recurso em cada ferramenta, consulte: [[GE - Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Configuração da Cia IA do CIGAM]]

GE - Como Fazer - Uso da Cia - IA do CIGAM

2026-10-08T18:01:24Z

Vinicius.moder: /* Resultado do processamento */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como_Fazer_Utilidades/Diversos_6]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer - Uso da Cia - IA do CIGAM]]

=Recursos, configurações e segurança=
A Cia - IA do CIGAM oferece diversas funcionalidades e atua como um hub centralizador para os recursos de inteligência artificial utilizados nas soluções CIGAM. Para garantir o correto funcionamento desses recursos, é necessário verificar se os pré-requisitos e as configurações foram realizados adequadamente. Para mais informações, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM|Como Fazer configuração da Cia IA do CIGAM]]
<br><br>
Todas as soluções de IA do CIGAM são integradas por meio dos serviços da Cia. A Cia possui integração com diferentes provedores de IA de terceiros, como OpenAI, Google, Anthropic, entre outros. Essas integrações são realizadas por meio de contas e serviços contratados, com condições de uso que asseguram que os dados trafegados não sejam utilizados para treinamento dos modelos, identificação de origem, publicidade, anúncios ou qualquer outra finalidade não prevista.
<br><br>
No caso de IAs open-source integradas à Cia, os modelos são executados dentro dos domínios da CIGAM, mantendo as mesmas premissas aplicadas às IAs contratadas: não utilização dos dados para treinamento de modelos, não identificação da origem das informações e ausência de retenção dos dados processados.
<br><br>
Além disso, sempre que houver envio explícito de dados pelo usuário por meio das funcionalidades da Cia disponíveis nas soluções CIGAM, será apresentado um diálogo de confirmação, permitindo que o usuário aceite o envio dessas informações. Os dados enviados serão tratados conforme as mesmas diretrizes de segurança, privacidade e não retenção descritas anteriormente.
<br><br>
Esta documentação apresenta o uso da Cia e está organizada conforme a forma de acesso: [[#Cia Web (SaaS)|Cia Web (SaaS)]], [[#Portais|Portais]] e [[#Desktop|Desktop]].
<br><br>
Caso tenha dúvidas sobre onde encontrar a Cia em cada uma dessas plataformas, ou sobre quais ferramentas do CIGAM possuem recursos integrados a ela, consulte a documentação específica de acesso: [[GE - Como Fazer - Cia - Como acessar|Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Cia Web (SaaS)=
A Cia Web é a aplicação web que centraliza todas as funcionalidades da Cia. Ela pode ser acessada diretamente pelo navegador do seu computador ou dispositivo móvel, ou ainda a partir do Desktop e dos Portais, sem a necessidade de novo login.
<br><br>

<center><youtube>https://youtu.be/DFGtRtPF75A</youtube></center>
<br>

==Primeiro acesso==
A Cia Web pode ser acessada diretamente pelo navegador, utilizando o seguinte endereço: https://services.cigam.cloud/cia/index.html
<br><br>
'''Importante:''' o usuário que for realizar o login precisa ter a autenticação em duas etapas habilitada. Para saber como configurá-la, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]]
<br><br>
Ao acessar pelo endereço, será necessário preencher algumas informações para que a Cia consiga validar seu acesso e consultar seus dados:<br>
* Informar a API do seu CIGAM Server, para garantir o direcionamento correto da base de dados.<br><br>

[[Imagem:CiaAPI.png|semmoldura|center|700px]]<br>

* Informar usuário e senha de login e seu código de verificação:<br><br>

[[Imagem:CiaLogin.png|semmoldura|center|700px]]
<br>
[[Imagem:CiaCodVerif.png|semmoldura|center|700px]]<br>

* Caso não queira aguardar ou informar o código de verificação, você pode optar por responder à pergunta secreta, clicando no botão “Pergunta Secreta” exibido na imagem acima.<br><br>

[[Imagem:CiaLoginA2F.png|semmoldura|center|700px]]
<br>

==Conhecendo a tela da Cia==
Após realizar o login, a Cia carregará automaticamente as informações e dados necessários do ambiente e será iniciada no assunto '''#Geral''', identificado pelo botão localizado à esquerda da caixa de texto.

[[Imagem:CiaGeral.png|semmoldura|center|700px]]
<br><br>
Ao clicar nesse botão, será exibida uma lista com todos os assuntos disponíveis, permitindo que você selecione aquele com o qual deseja interagir.<br><br>
Além disso, você pode digitar diretamente na caixa de texto o '''#Assunto''' que deseja utilizar, e a Cia entenderá automaticamente o tema da sua mensagem.<br><br>
Também é possível '''formular uma pergunta seguida de um #Assunto''' para interagir com qualquer assunto, mesmo que ele não esteja selecionado no momento.

[[Imagem:CiaAberta.png|semmoldura|center|700px]]
<br>
Ao selecionar um assunto, serão exibidas automaticamente dicas e sugestões sobre o tema escolhido, além de exemplos clicáveis que, ao serem selecionados, são processados de forma imediata.<br><br>
Além disso, ao digitar um ponto de interrogação (?) na caixa de texto, será exibida uma lista com todas as interações disponíveis para o assunto selecionado, facilitando a descoberta de comandos e possibilidades de uso.

[[Imagem:CiaDicas.png|semmoldura|center|700px]]
<br>
Outra funcionalidade prática é a possibilidade de reenviar perguntas já feitas no chat. Para isso, basta posicionar o mouse sobre a pergunta desejada e clicar no ícone de “Reenviar”. Ao passar o mouse sobre a mensagem, também será exibido o horário de envio.
<br>
[[Imagem:CiaReenviar.png|semmoldura|center|400px]]
<br>
Além disso, você pode utilizar as setas do teclado (⬆️ para cima e ⬇️ para baixo) na caixa de texto para navegar pelas últimas perguntas enviadas para o #Assunto selecionado, facilitando o reuso de interações anteriores.

===Ícones da caixa de texto===
Na caixa de texto, você encontrará alguns ícones com as seguintes funções:

<center>
{| class="wikitable"
|-
! !! Ação
|-
|center|[[Imagem:CiaUltPerg.png]] || '''Histórico de Perguntas''' – Ao clicar, é exibido o histórico das perguntas já realizadas para o assunto selecionado.
|-
|center|[[Imagem:CiaEnviar.png]] || '''Enviar''' – Envia o conteúdo digitado na caixa de texto.
|-
|center|[[Imagem:CiaFala.png]] || '''Falar''' – Permite falar ao invés de digitar, usando o recurso de voz.
|-
|center|[[Imagem:CiaExpandir.png]] || '''Expandir''' – Aumenta a altura da caixa de texto para facilitar a digitação de mensagens longas.
|-
|center|[[Imagem:CiaRecolher.png]] || '''Recolher''' – Reduz a caixa de texto ao tamanho padrão.
|}
</center>
{{VoltarInicio}}

==Assuntos disponíveis==

===Geral===
Nesse assunto, é possível conversar livremente com a Cia sobre qualquer um dos assuntos disponíveis. Se encontrar dificuldades para obter a resposta desejada, experimente selecionar um assunto específico, o que pode gerar resultados mais precisos.<br><br>
Se houver muitas respostas correspondentes, a Cia não executará nenhuma automaticamente. Em vez disso, exibirá uma opção com os valores possíveis, permitindo que você selecione manualmente a melhor alternativa.

[[Imagem:CiaGeralOpcoes.png|semmoldura|center|700px]]
<br>
Caso a Cia encontre uma resposta com confiança significativamente maior que as demais, ela será executada automaticamente.
<br><br>
No entanto, se você selecionar a opção “Não era bem isso o que eu queria”, a Cia exibirá outras opções relacionadas ao que foi solicitado, apresentando também um indicador de semáforo com a porcentagem de confiança de cada alternativa.

[[Imagem:CiaGeralOpcaoCerta.png|semmoldura|center|600px]]

===Ajuda, Vídeos e Auditor===
Conheça melhor o ERP com a ajuda da Wiki e Cia, assista vídeos sobre o CIGAM e audite seu ambiente.

====Ajuda====
Nesse assunto, você pode acessar o Chatbot da assistente virtual, onde você pode tirar dúvidas e consultar conteúdos da CIGAM Wiki enviando perguntas diretamente nela.<br>
<br>
'''Importante:''' neste assunto, a Cia atua dedicada à Wiki, focada exclusivamente nos conteúdos da documentação. As demais funcionalidades e atalhos da Cia não estarão disponíveis nesse contexto.

====Vídeos====
Nesse assunto, é possível procurar por vídeos relacionados ao tema desejado. O resultado será apresentado em forma de lista, contendo os vídeos encontrados e os tempos exatos em que o assunto começa a ser abordado, de acordo com o termo ou palavra pesquisada.

====Auditor====
Neste assunto, é possível verificar o status do sistema e identificar possíveis problemas ou inconsistências. O resultado será exibido em forma de tabela, contendo os dados retornados para facilitar a análise.

===Painéis BI, Portais e Relatórios===
Explore dashboards do BI, interaja com Portais intuitivos e execute relatórios personalizados.

====Painéis BI====
Nesse assunto, é possível abrir dashboards do BI já configurados para o usuário, permitindo sua visualização diretamente na tela.
Ao abrir um dashboard, você também pode interagir com ele, solicitando inserção de filtros, dimensões, métricas, transformações e outros ajustes.<br>
Cada dashboard aberto exibirá uma guia com as “Interações” disponíveis para aquele painel específico.
<br><br>
Além disso, ao selecionar o assunto '''#Painéis do BI''', é possível solicitar que a Cia crie um dashboard do zero.
Por exemplo: "Crie um dashboard para ver meu fluxo de caixa". Você pode ainda solicitar que métricas, dimensões e filtros sejam adicionados durante a criação, ou pedir dashboards separados por áreas.
<br><br>
'''Importante:''' caso o usuário não possua acesso ao BI ou este não esteja implementado na base de dados, será exibida uma mensagem informativa no momento do login na Cia.

====Portais====
Quando este assunto é utilizado, o resultado será sempre a abertura de uma tela dos Portais, permitindo ao usuário acessar diretamente os conteúdos e funcionalidades disponíveis nesse ambiente.
<br><br>
Essa abertura é feita de forma integrada, garantindo uma navegação contínua entre a Cia e os Portais, sem necessidade de realizar novo login ou sair da plataforma.

====Relatórios====
Ao utilizar esse assunto, será exibida uma tela para preenchimento de filtros, permitindo a emissão de relatórios web.
<br><br>
Para que essa funcionalidade opere corretamente, é necessário garantir que a instalação da CDN e da Pesquisa Dinâmica no servidor de aplicação esteja configurada de forma adequada.
<br><br>
Os relatórios exibidos aqui são os mesmos disponíveis nos Portais CIGAM, portanto é essencial que esses componentes também estejam funcionando corretamente nesses Portais.

===Qual, Faça, Consultar, Listar, Analisar e Insights===
Crie registros, analise informações ou liste dados cadastrados no CIGAM.

====Qual====
Nesse assunto, a Cia vai consultar e processar informações diretamente no ERP, usando os dados e relacionamentos disponíveis no CIGAM, e retornar os resultados em forma de texto para você visualizar.
<br><br>
'''Importante:''' nem todas as opções estão liberadas. Para ver quais você pode usar, digite ? na caixa de texto. A Cia vai mostrar uma lista com todos os comandos e funções disponíveis.

====Faça====
Nesse assunto, a Cia sempre fará um processamento no CIGAM e retornará o status do resultado. Por exemplo, você pode solicitar que a Cia crie um alerta ou até mesmo crie uma nova empresa no sistema.
<br><br>
'''Dica:''' para saber quais treinamentos ou comandos estão disponíveis, digite ? na caixa de texto. A Cia mostrará uma lista com todas as opções implementadas para você usar.

====Consultar====
Nesse assunto, você poderá fazer consultas de dados para obter listagens de registros, conforme os treinamentos de tabelas disponíveis. O resultado será apresentado em forma de tabela, exibindo os dados retornados. Já existem diversas Views prontas, para que você possa listar informações de forma mais completa e rápida.
<br><br>
'''Dica:''' para ver exemplos de consultas já implementadas, digite ? na caixa de texto.

====Listar====
Nesse assunto, você pode montar sua própria consulta de dados, escolhendo os filtros e parâmetros para gerar uma listagem personalizada. Diferente do assunto #Consultar, aqui é possível utilizar qualquer tabela do CIGAM para montar sua consulta, escrevendo em linguagem natural o que deseja buscar.
<br><br>
'''Dica:''' para ver todas as tabelas disponíveis, digite ? na caixa de texto.

====Analisar====
Analise o arquivo selecionado para gerar gráficos interativos e informativos, apresentando insights relevantes que ajudam a identificar tendências, padrões e oportunidades de melhoria.
<br><br>
Esse recurso oferece uma visualização clara e intuitiva dos dados, facilitando a interpretação das informações e apoiando a tomada de decisões estratégicas.
<br><br>
'''Aviso:''' para utilizar esta funcionalidade, é necessário concordar que os dados enviados serão processados por modelos de IA de terceiros integrados à Cia.

[[Imagem:AnalisarCia.png|semmoldura|center|600px]]

====Insights====
Gere insights inteligentes a partir dos dados de uma consulta, com análises automáticas realizadas pela Cia, que identificam padrões, tendências e possíveis pontos de atenção. Esse recurso ajuda a transformar dados brutos em informações acionáveis, facilitando a tomada de decisões estratégicas e otimizando processos.
<br><br>
'''Aviso:''' ao utilizar o assunto “Insights”, você concorda que os dados e informações analisados poderão ser enviados para modelos de IA de terceiros integrados à Cia, exclusivamente para processamento e geração dos resultados apresentados.

===IA Generativa e Pesquisa na Internet===
Converse com a IA sobre assuntos diversos, crie conteúdos e pesquise na internet sobre qualquer coisa.

====IA Generativa====
Nesse assunto, ao interagir com a IA Generativa, você poderá fazer qualquer tipo de pergunta ou solicitação, de forma livre e criativa.
O resultado exibido será exatamente a resposta gerada pela IA, sem complementos da Cia. Você pode, por exemplo, solicitar que a IA melhore ou reformule um texto, crie conteúdos ou resuma informações.
<br><br>
'''Importante:''' nesse assunto, a Cia não estará integrada aos serviços e sistemas do CIGAM — a interação é exclusivamente com a IA Generativa.

====Pesquisa na Internet====
Use esse assunto para fazer pesquisas na internet e visualizar os resultados diretamente integrados na Cia, sem precisar sair da plataforma. Você pode pesquisar qualquer tema de interesse e abrir os links retornados para acessar conteúdos, notícias e informações de forma rápida e prática.
{{VoltarInicio}}

==Configurações==
O ícone de engrenagem, localizado no canto superior direito da página, reúne recursos de informação e gerenciamento. As opções disponíveis são:
* '''Respostas com áudio:''' quando ativado, as respostas da Cia são narradas em voz alta.
* '''Ambiente atual do CIGAM:''' exibe na tela o usuário logado e o ambiente em uso.
* '''Ver consumo:''' mostra a quantidade de tokens já utilizados e os usuários que geraram consumo.
* '''Limpar dados de navegação:''' exibe uma mensagem explicando como limpar os dados de navegação do navegador.
* '''Limpar cookies:''' apaga os dados armazenados localmente, permitindo informar novamente a API e realizar um novo login.
* '''Instalar aplicativo:''' instala a Cia como aplicativo no dispositivo, criando um atalho na tela inicial.
* '''Documentação na wiki:''' direciona para a documentação da Cia na CIGAM Wiki.
* '''Sair:''' encerra a sessão do usuário, permitindo realizar login com outro usuário.
<br>
[[Imagem:ConfiguracoesCia.png|semmoldura|center|500px]]
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, além do acesso à Cia Web pelo menu de mosaico, estão disponíveis recursos de IA que atuam diretamente nas telas em que você está trabalhando. Esses recursos não exigem parametrização e são apresentados de acordo com o contexto da tela.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia Web a partir dos Portais é feito pelo ícone de mosaico, onde está disponível o ícone da Cia - IA do CIGAM.<br>
<br>
[[Imagem:mosaicoCia.png|semmoldura|center|800px]]
<br>
A Cia será aberta de forma integrada, sem a necessidade de novo login, e todas as funcionalidades descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] estarão disponíveis normalmente.<br>

==Geração de conteúdo==
Na barra superior dos Portais está disponível um ícone com um menu de contexto que permite interagir com os '''campos de texto''' de qualquer parte dos Portais. As opções disponíveis permitem melhorar textos, criar conteúdos, revisar a gramática, entre outras ações.<br>
<br>
[[Imagem:comandosCia.png|semmoldura|center|650px]]
<br>
A partir da versão '''Beta 260601''', essas opções passaram a ser exibidas em uma seção separada, chamada '''Geração de conteúdo''', apresentada no mesmo menu em que ficam os agentes.<br>
<br>
[[Imagem:MenuGeracaoConteudoAgentes.png|semmoldura|center|800px]]
<br>
O campo processado é sempre o '''último campo em que o cursor esteve posicionado''' antes de abrir o menu da Cia. Por isso, basta clicar no campo desejado e, em seguida, acionar o menu e escolher o comando.<br>
<br>
Para que o comando seja executado, o campo precisa ser um '''campo de texto válido''' e conter, no mínimo, '''três palavras'''. Caso contrário, será apresentada uma mensagem informando que o conteúdo não atende aos requisitos.<br>
<br>
Após o processamento, o conteúdo gerado é aplicado automaticamente no campo, substituindo o texto anterior, sem necessidade de confirmação.<br>
<br>
Essa funcionalidade também está disponível em telas modais, ou seja, janelas sobrepostas com interações:<br>
<br>
[[Imagem:comandosModalCia.png|semmoldura|center|800px]]
<br>

==Agentes==
A partir da versão '''Beta 260601''', o menu da Cia nos Portais passou a disponibilizar também o acesso aos agentes, tanto nos Portais MVC quanto nos Portais React.<br>
<br>
Ao abrir o menu da Cia, os agentes disponíveis são detectados automaticamente de acordo com a tela que está sendo acessada, ou seja, as opções apresentadas variam conforme a página aberta.<br>
<br>
[[Imagem:MenuAgentesCia.png|semmoldura|center|800px]]
<br>

===Como os agentes são disponibilizados===
A disponibilização de cada agente pode ocorrer de quatro formas:<br>
<br>
* '''Por contexto:''' o agente é apresentado quando a Cia identifica que a tela acessada corresponde ao assunto tratado por ele. Por exemplo, um agente sobre Ordem de Produção será disponibilizado ao acessar uma página cujo contexto seja identificado como Ordem de Produção.
<br>
* '''Por parâmetro:''' o agente é apresentado quando a Cia identifica, na tela, um parâmetro com o valor esperado por ele. Por exemplo, um agente de Pedidos será disponibilizado quando existir na tela um parâmetro que contenha o código do pedido.
<br>
* '''Por contexto e parâmetro:''' o agente é apresentado somente quando as duas condições forem atendidas ao mesmo tempo.
<br>
* '''Sempre disponível:''' o agente é apresentado em qualquer tela, independentemente do contexto ou dos parâmetros.
<br>

===Resultado do processamento===
Após o processamento, o retorno do agente pode ser apresentado de duas formas, conforme o que foi executado:<br>
<br>
* Em uma '''nova guia''' do navegador, quando o agente gera algum conteúdo ou relatório como resultado.
<br>
[[Imagem:AgentesRetornoGuia.png|semmoldura|center|800px]]
<br>
* Em uma '''janela modal''', dentro da própria página em que o usuário está, quando o retorno é uma mensagem.
<br>
[[Imagem:AgentesRetornoModal.png|semmoldura|center|800px]]
<br>
<div align="justify>
A partir da versão '''Beta 261005''', quando o resultado do agente é apresentado em uma nova guia, a página passa a disponibilizar também opções para utilização e compartilhamento da análise.
</div>
[[Imagem:resultadoAnalise.png|semmoldura|center|800px]]
<div align="justify">
No cabeçalho são apresentados o nome do agente executado e as opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>
<div align="justify">
=====Compartilhamento por e-mail=====
A janela abaixo é exibida ao quando selecionada a opção '''E-mail''':
</div>
[[Imagem:modalEmail.png|semmoldura|center|800px]]
<div align="justify">
Após informar os dados desejados e confirmar o envio, a análise gerada pelo agente será encaminhada ao destinatário como um arquivo em anexo.

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
</div>

==Editor de Agentes==
A partir da versão '''Beta 261005''', o menu passou a disponibilizar o acesso à ferramenta '''Editor de Agentes''', que permite criar seus próprios agentes.<br>
<br>
[[Imagem:EditorAgentesCia.png|semmoldura|center|800px]]
<br>
Ao clicar na opção, será aberta uma página web no formato de assistente (wizard), com cada etapa explicada de forma detalhada. Basta preencher as informações do agente conforme a sua necessidade e avançar pelos passos até a conclusão.<br>
<br>
[[Imagem:EditorAgentesWizard.png|semmoldura|center|800px]]
<br>
Ao final do processo, será gerado um arquivo com a extensão '''.cgagt''', que contém a definição do agente criado.<br>
<br>

===Disponibilizando o agente criado===
Para que o agente passe a ser exibido nos Portais, o arquivo '''.cgagt''' precisa ser colocado na aplicação da API, dentro da pasta raiz da aplicação.<br>
<br>
É necessário que existam as pastas '''Exclusivo''' e, dentro dela, '''Agentes'''. Caso não existam, elas devem ser criadas manualmente. O arquivo deve ser colocado dentro dessa estrutura, ficando da seguinte forma:<br>
<br>
/api/exclusivo/agentes/
<br>
Assim que o arquivo é adicionado nesse local, a Cia passa a reconhecer o agente automaticamente, sem necessidade de qualquer outra configuração. Os agentes customizados são exibidos no menu da Cia nos Portais, em uma seção separada dos agentes padrão.<br>
<br>
[[Imagem:MenuAgentesCustomizados.png|semmoldura|center|800px]]
<br>
==Conversar com documentos==
Em construção...<br>
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, além do acesso rápido à Cia Web, algumas ferramentas do sistema disponibilizam o recurso "Analisar com a Cia".<br>

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM), disponível no menu lateral do Desktop, abre a Cia Web de forma integrada ao sistema, em uma janela do próprio CIGAM.<br>
<br>
Desde que as configurações necessárias tenham sido aplicadas, conforme [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Acesso rápido à Cia Web (SaaS)|Acesso rápido à Cia Web (SaaS)]], '''todas as funcionalidades da Cia Web estarão disponíveis normalmente''', da mesma forma que no acesso pelo navegador. Para conhecê-las, consulte a seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] desta documentação.<br>
<br>
[[Imagem:CiaAbertaDesktop.png|semmoldura|center|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''' está disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída. Em todas elas, o comportamento é o mesmo: a Cia analisa o conteúdo que está em uso na tela e gera um relatório com o resultado da análise, apresentado em uma nova página.<br>
<br>
Ao acionar a opção, o fluxo é o seguinte:<br>
<br>
'''1. Confirmação dos termos de uso'''<br>
Antes de qualquer envio, será exibida uma mensagem solicitando que o usuário concorde com o envio das informações para análise. Os dados enviados seguem as diretrizes de segurança, privacidade e não retenção descritas em [[#Recursos, configurações e segurança|Recursos, configurações e segurança]].<br>
<br>
[[Imagem:AnalisarCiaTermos.png|semmoldura|center|500px]]
<br>
'''2. Complemento do prompt (opcional)'''<br>
Em seguida, será apresentada uma caixa de texto para que o usuário complemente a solicitação, orientando a análise para algum ponto específico. O preenchimento é opcional e pode ser deixado em branco.<br>
<br>
Essa caixa de texto serve apenas para complementar o prompt base que a Cia monta automaticamente, e não altera o conteúdo que está sendo enviado. O recurso considera que o usuário já filtrou os dados na própria tela do CIGAM antes de acionar a análise. O prompt base é mantido oculto por ser extenso e técnico, evitando que o usuário precise conferi-lo a cada utilização.<br>
<br>
[[Imagem:AnalisarCiaPrompt.png|semmoldura|center|700px]]
<br>
'''3. Geração do relatório'''<br>
Após a confirmação, a Cia processa o conteúdo e apresenta o relatório em uma nova página flutuante, com a análise dos dados enviados.<br>
<br>
O próprio relatório informa a quantidade de dados que foi analisada, permitindo que o usuário veja o volume aproximado considerado e identifique se o conteúdo enviado corresponde ao que esperava.<br>
<br>
[[Imagem:AnalisarCiaRelatorio.png|semmoldura|center|700px]]
<br>

===Limite de conteúdo enviado===
Existe um limite para o volume de conteúdo enviado em cada análise, que varia conforme a versão do ambiente:<br>
<br>
* '''150 KB''' — desde a disponibilização do recurso, na versão '''250505.a'''.
* '''3 MB''' — a partir das patches '''250505.i''' e '''251103.a''', e da versão '''RC 260504'''.
<br>
Quando o conteúdo selecionado ultrapassa esse limite, a Cia exibe uma mensagem informando o tamanho excedido e a análise não é processada, ou seja, nenhum relatório será gerado.<br>
<br>
[[Imagem:AnalisarCiaLimite.png|semmoldura|center|600px]]
<br>
'''Esse limite não é parametrizável e não se trata de uma restrição imposta pela CIGAM.''' Ele decorre da própria capacidade dos modelos de IA integrados à Cia, que possuem um limite técnico de volume de dados que conseguem processar em uma única análise. Quando esse volume é ultrapassado, os modelos passam a analisar as informações por amostragem — ou seja, mesmo que fosse permitido enviar uma quantidade maior de dados, o modelo não analisaria todo o conteúdo, e o resultado seria menos preciso. O limite adotado pela Cia acompanha essa característica dos modelos e assegura que a análise seja feita sobre os dados completos.<br>
<br>
Além da qualidade da análise, há também a questão do tempo de processamento: quanto maior o volume enviado, maior o tempo de resposta do modelo, tornando a espera inviável para o uso no dia a dia.<br>
<br>
Por isso, o recurso foi feito para ser simples e direto: analisar, com um clique, os dados que o usuário já está visualizando pelos meios tradicionais do CIGAM, como grids filtrados e relatórios. Em ambientes com grande volume de dados, a prática recomendada é '''filtrar e consolidar as informações na própria tela antes de acionar a análise''', reduzindo o período ou o escopo consultado. Para análises de períodos maiores, recomenda-se utilizar dados já consolidados, como totalizadores e relatórios sintéticos, em vez de listagens analíticas completas.<br>
<br>
A CIGAM está trabalhando em outras ferramentas que, por processarem os dados de forma diferente, permitirão trabalhar com volumes maiores de informação.<br>

Para saber como acessar o recurso em cada ferramenta, consulte: [[GE - Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Configuração da Cia IA do CIGAM]]

GE - Como Fazer - Uso da Cia - IA do CIGAM

2026-10-08T17:50:21Z

Vinicius.moder: /* Resultado do processamento */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como_Fazer_Utilidades/Diversos_6]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer - Uso da Cia - IA do CIGAM]]

=Recursos, configurações e segurança=
A Cia - IA do CIGAM oferece diversas funcionalidades e atua como um hub centralizador para os recursos de inteligência artificial utilizados nas soluções CIGAM. Para garantir o correto funcionamento desses recursos, é necessário verificar se os pré-requisitos e as configurações foram realizados adequadamente. Para mais informações, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM|Como Fazer configuração da Cia IA do CIGAM]]
<br><br>
Todas as soluções de IA do CIGAM são integradas por meio dos serviços da Cia. A Cia possui integração com diferentes provedores de IA de terceiros, como OpenAI, Google, Anthropic, entre outros. Essas integrações são realizadas por meio de contas e serviços contratados, com condições de uso que asseguram que os dados trafegados não sejam utilizados para treinamento dos modelos, identificação de origem, publicidade, anúncios ou qualquer outra finalidade não prevista.
<br><br>
No caso de IAs open-source integradas à Cia, os modelos são executados dentro dos domínios da CIGAM, mantendo as mesmas premissas aplicadas às IAs contratadas: não utilização dos dados para treinamento de modelos, não identificação da origem das informações e ausência de retenção dos dados processados.
<br><br>
Além disso, sempre que houver envio explícito de dados pelo usuário por meio das funcionalidades da Cia disponíveis nas soluções CIGAM, será apresentado um diálogo de confirmação, permitindo que o usuário aceite o envio dessas informações. Os dados enviados serão tratados conforme as mesmas diretrizes de segurança, privacidade e não retenção descritas anteriormente.
<br><br>
Esta documentação apresenta o uso da Cia e está organizada conforme a forma de acesso: [[#Cia Web (SaaS)|Cia Web (SaaS)]], [[#Portais|Portais]] e [[#Desktop|Desktop]].
<br><br>
Caso tenha dúvidas sobre onde encontrar a Cia em cada uma dessas plataformas, ou sobre quais ferramentas do CIGAM possuem recursos integrados a ela, consulte a documentação específica de acesso: [[GE - Como Fazer - Cia - Como acessar|Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Cia Web (SaaS)=
A Cia Web é a aplicação web que centraliza todas as funcionalidades da Cia. Ela pode ser acessada diretamente pelo navegador do seu computador ou dispositivo móvel, ou ainda a partir do Desktop e dos Portais, sem a necessidade de novo login.
<br><br>

<center><youtube>https://youtu.be/DFGtRtPF75A</youtube></center>
<br>

==Primeiro acesso==
A Cia Web pode ser acessada diretamente pelo navegador, utilizando o seguinte endereço: https://services.cigam.cloud/cia/index.html
<br><br>
'''Importante:''' o usuário que for realizar o login precisa ter a autenticação em duas etapas habilitada. Para saber como configurá-la, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]]
<br><br>
Ao acessar pelo endereço, será necessário preencher algumas informações para que a Cia consiga validar seu acesso e consultar seus dados:<br>
* Informar a API do seu CIGAM Server, para garantir o direcionamento correto da base de dados.<br><br>

[[Imagem:CiaAPI.png|semmoldura|center|700px]]<br>

* Informar usuário e senha de login e seu código de verificação:<br><br>

[[Imagem:CiaLogin.png|semmoldura|center|700px]]
<br>
[[Imagem:CiaCodVerif.png|semmoldura|center|700px]]<br>

* Caso não queira aguardar ou informar o código de verificação, você pode optar por responder à pergunta secreta, clicando no botão “Pergunta Secreta” exibido na imagem acima.<br><br>

[[Imagem:CiaLoginA2F.png|semmoldura|center|700px]]
<br>

==Conhecendo a tela da Cia==
Após realizar o login, a Cia carregará automaticamente as informações e dados necessários do ambiente e será iniciada no assunto '''#Geral''', identificado pelo botão localizado à esquerda da caixa de texto.

[[Imagem:CiaGeral.png|semmoldura|center|700px]]
<br><br>
Ao clicar nesse botão, será exibida uma lista com todos os assuntos disponíveis, permitindo que você selecione aquele com o qual deseja interagir.<br><br>
Além disso, você pode digitar diretamente na caixa de texto o '''#Assunto''' que deseja utilizar, e a Cia entenderá automaticamente o tema da sua mensagem.<br><br>
Também é possível '''formular uma pergunta seguida de um #Assunto''' para interagir com qualquer assunto, mesmo que ele não esteja selecionado no momento.

[[Imagem:CiaAberta.png|semmoldura|center|700px]]
<br>
Ao selecionar um assunto, serão exibidas automaticamente dicas e sugestões sobre o tema escolhido, além de exemplos clicáveis que, ao serem selecionados, são processados de forma imediata.<br><br>
Além disso, ao digitar um ponto de interrogação (?) na caixa de texto, será exibida uma lista com todas as interações disponíveis para o assunto selecionado, facilitando a descoberta de comandos e possibilidades de uso.

[[Imagem:CiaDicas.png|semmoldura|center|700px]]
<br>
Outra funcionalidade prática é a possibilidade de reenviar perguntas já feitas no chat. Para isso, basta posicionar o mouse sobre a pergunta desejada e clicar no ícone de “Reenviar”. Ao passar o mouse sobre a mensagem, também será exibido o horário de envio.
<br>
[[Imagem:CiaReenviar.png|semmoldura|center|400px]]
<br>
Além disso, você pode utilizar as setas do teclado (⬆️ para cima e ⬇️ para baixo) na caixa de texto para navegar pelas últimas perguntas enviadas para o #Assunto selecionado, facilitando o reuso de interações anteriores.

===Ícones da caixa de texto===
Na caixa de texto, você encontrará alguns ícones com as seguintes funções:

<center>
{| class="wikitable"
|-
! !! Ação
|-
|center|[[Imagem:CiaUltPerg.png]] || '''Histórico de Perguntas''' – Ao clicar, é exibido o histórico das perguntas já realizadas para o assunto selecionado.
|-
|center|[[Imagem:CiaEnviar.png]] || '''Enviar''' – Envia o conteúdo digitado na caixa de texto.
|-
|center|[[Imagem:CiaFala.png]] || '''Falar''' – Permite falar ao invés de digitar, usando o recurso de voz.
|-
|center|[[Imagem:CiaExpandir.png]] || '''Expandir''' – Aumenta a altura da caixa de texto para facilitar a digitação de mensagens longas.
|-
|center|[[Imagem:CiaRecolher.png]] || '''Recolher''' – Reduz a caixa de texto ao tamanho padrão.
|}
</center>
{{VoltarInicio}}

==Assuntos disponíveis==

===Geral===
Nesse assunto, é possível conversar livremente com a Cia sobre qualquer um dos assuntos disponíveis. Se encontrar dificuldades para obter a resposta desejada, experimente selecionar um assunto específico, o que pode gerar resultados mais precisos.<br><br>
Se houver muitas respostas correspondentes, a Cia não executará nenhuma automaticamente. Em vez disso, exibirá uma opção com os valores possíveis, permitindo que você selecione manualmente a melhor alternativa.

[[Imagem:CiaGeralOpcoes.png|semmoldura|center|700px]]
<br>
Caso a Cia encontre uma resposta com confiança significativamente maior que as demais, ela será executada automaticamente.
<br><br>
No entanto, se você selecionar a opção “Não era bem isso o que eu queria”, a Cia exibirá outras opções relacionadas ao que foi solicitado, apresentando também um indicador de semáforo com a porcentagem de confiança de cada alternativa.

[[Imagem:CiaGeralOpcaoCerta.png|semmoldura|center|600px]]

===Ajuda, Vídeos e Auditor===
Conheça melhor o ERP com a ajuda da Wiki e Cia, assista vídeos sobre o CIGAM e audite seu ambiente.

====Ajuda====
Nesse assunto, você pode acessar o Chatbot da assistente virtual, onde você pode tirar dúvidas e consultar conteúdos da CIGAM Wiki enviando perguntas diretamente nela.<br>
<br>
'''Importante:''' neste assunto, a Cia atua dedicada à Wiki, focada exclusivamente nos conteúdos da documentação. As demais funcionalidades e atalhos da Cia não estarão disponíveis nesse contexto.

====Vídeos====
Nesse assunto, é possível procurar por vídeos relacionados ao tema desejado. O resultado será apresentado em forma de lista, contendo os vídeos encontrados e os tempos exatos em que o assunto começa a ser abordado, de acordo com o termo ou palavra pesquisada.

====Auditor====
Neste assunto, é possível verificar o status do sistema e identificar possíveis problemas ou inconsistências. O resultado será exibido em forma de tabela, contendo os dados retornados para facilitar a análise.

===Painéis BI, Portais e Relatórios===
Explore dashboards do BI, interaja com Portais intuitivos e execute relatórios personalizados.

====Painéis BI====
Nesse assunto, é possível abrir dashboards do BI já configurados para o usuário, permitindo sua visualização diretamente na tela.
Ao abrir um dashboard, você também pode interagir com ele, solicitando inserção de filtros, dimensões, métricas, transformações e outros ajustes.<br>
Cada dashboard aberto exibirá uma guia com as “Interações” disponíveis para aquele painel específico.
<br><br>
Além disso, ao selecionar o assunto '''#Painéis do BI''', é possível solicitar que a Cia crie um dashboard do zero.
Por exemplo: "Crie um dashboard para ver meu fluxo de caixa". Você pode ainda solicitar que métricas, dimensões e filtros sejam adicionados durante a criação, ou pedir dashboards separados por áreas.
<br><br>
'''Importante:''' caso o usuário não possua acesso ao BI ou este não esteja implementado na base de dados, será exibida uma mensagem informativa no momento do login na Cia.

====Portais====
Quando este assunto é utilizado, o resultado será sempre a abertura de uma tela dos Portais, permitindo ao usuário acessar diretamente os conteúdos e funcionalidades disponíveis nesse ambiente.
<br><br>
Essa abertura é feita de forma integrada, garantindo uma navegação contínua entre a Cia e os Portais, sem necessidade de realizar novo login ou sair da plataforma.

====Relatórios====
Ao utilizar esse assunto, será exibida uma tela para preenchimento de filtros, permitindo a emissão de relatórios web.
<br><br>
Para que essa funcionalidade opere corretamente, é necessário garantir que a instalação da CDN e da Pesquisa Dinâmica no servidor de aplicação esteja configurada de forma adequada.
<br><br>
Os relatórios exibidos aqui são os mesmos disponíveis nos Portais CIGAM, portanto é essencial que esses componentes também estejam funcionando corretamente nesses Portais.

===Qual, Faça, Consultar, Listar, Analisar e Insights===
Crie registros, analise informações ou liste dados cadastrados no CIGAM.

====Qual====
Nesse assunto, a Cia vai consultar e processar informações diretamente no ERP, usando os dados e relacionamentos disponíveis no CIGAM, e retornar os resultados em forma de texto para você visualizar.
<br><br>
'''Importante:''' nem todas as opções estão liberadas. Para ver quais você pode usar, digite ? na caixa de texto. A Cia vai mostrar uma lista com todos os comandos e funções disponíveis.

====Faça====
Nesse assunto, a Cia sempre fará um processamento no CIGAM e retornará o status do resultado. Por exemplo, você pode solicitar que a Cia crie um alerta ou até mesmo crie uma nova empresa no sistema.
<br><br>
'''Dica:''' para saber quais treinamentos ou comandos estão disponíveis, digite ? na caixa de texto. A Cia mostrará uma lista com todas as opções implementadas para você usar.

====Consultar====
Nesse assunto, você poderá fazer consultas de dados para obter listagens de registros, conforme os treinamentos de tabelas disponíveis. O resultado será apresentado em forma de tabela, exibindo os dados retornados. Já existem diversas Views prontas, para que você possa listar informações de forma mais completa e rápida.
<br><br>
'''Dica:''' para ver exemplos de consultas já implementadas, digite ? na caixa de texto.

====Listar====
Nesse assunto, você pode montar sua própria consulta de dados, escolhendo os filtros e parâmetros para gerar uma listagem personalizada. Diferente do assunto #Consultar, aqui é possível utilizar qualquer tabela do CIGAM para montar sua consulta, escrevendo em linguagem natural o que deseja buscar.
<br><br>
'''Dica:''' para ver todas as tabelas disponíveis, digite ? na caixa de texto.

====Analisar====
Analise o arquivo selecionado para gerar gráficos interativos e informativos, apresentando insights relevantes que ajudam a identificar tendências, padrões e oportunidades de melhoria.
<br><br>
Esse recurso oferece uma visualização clara e intuitiva dos dados, facilitando a interpretação das informações e apoiando a tomada de decisões estratégicas.
<br><br>
'''Aviso:''' para utilizar esta funcionalidade, é necessário concordar que os dados enviados serão processados por modelos de IA de terceiros integrados à Cia.

[[Imagem:AnalisarCia.png|semmoldura|center|600px]]

====Insights====
Gere insights inteligentes a partir dos dados de uma consulta, com análises automáticas realizadas pela Cia, que identificam padrões, tendências e possíveis pontos de atenção. Esse recurso ajuda a transformar dados brutos em informações acionáveis, facilitando a tomada de decisões estratégicas e otimizando processos.
<br><br>
'''Aviso:''' ao utilizar o assunto “Insights”, você concorda que os dados e informações analisados poderão ser enviados para modelos de IA de terceiros integrados à Cia, exclusivamente para processamento e geração dos resultados apresentados.

===IA Generativa e Pesquisa na Internet===
Converse com a IA sobre assuntos diversos, crie conteúdos e pesquise na internet sobre qualquer coisa.

====IA Generativa====
Nesse assunto, ao interagir com a IA Generativa, você poderá fazer qualquer tipo de pergunta ou solicitação, de forma livre e criativa.
O resultado exibido será exatamente a resposta gerada pela IA, sem complementos da Cia. Você pode, por exemplo, solicitar que a IA melhore ou reformule um texto, crie conteúdos ou resuma informações.
<br><br>
'''Importante:''' nesse assunto, a Cia não estará integrada aos serviços e sistemas do CIGAM — a interação é exclusivamente com a IA Generativa.

====Pesquisa na Internet====
Use esse assunto para fazer pesquisas na internet e visualizar os resultados diretamente integrados na Cia, sem precisar sair da plataforma. Você pode pesquisar qualquer tema de interesse e abrir os links retornados para acessar conteúdos, notícias e informações de forma rápida e prática.
{{VoltarInicio}}

==Configurações==
O ícone de engrenagem, localizado no canto superior direito da página, reúne recursos de informação e gerenciamento. As opções disponíveis são:
* '''Respostas com áudio:''' quando ativado, as respostas da Cia são narradas em voz alta.
* '''Ambiente atual do CIGAM:''' exibe na tela o usuário logado e o ambiente em uso.
* '''Ver consumo:''' mostra a quantidade de tokens já utilizados e os usuários que geraram consumo.
* '''Limpar dados de navegação:''' exibe uma mensagem explicando como limpar os dados de navegação do navegador.
* '''Limpar cookies:''' apaga os dados armazenados localmente, permitindo informar novamente a API e realizar um novo login.
* '''Instalar aplicativo:''' instala a Cia como aplicativo no dispositivo, criando um atalho na tela inicial.
* '''Documentação na wiki:''' direciona para a documentação da Cia na CIGAM Wiki.
* '''Sair:''' encerra a sessão do usuário, permitindo realizar login com outro usuário.
<br>
[[Imagem:ConfiguracoesCia.png|semmoldura|center|500px]]
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, além do acesso à Cia Web pelo menu de mosaico, estão disponíveis recursos de IA que atuam diretamente nas telas em que você está trabalhando. Esses recursos não exigem parametrização e são apresentados de acordo com o contexto da tela.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia Web a partir dos Portais é feito pelo ícone de mosaico, onde está disponível o ícone da Cia - IA do CIGAM.<br>
<br>
[[Imagem:mosaicoCia.png|semmoldura|center|800px]]
<br>
A Cia será aberta de forma integrada, sem a necessidade de novo login, e todas as funcionalidades descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] estarão disponíveis normalmente.<br>

==Geração de conteúdo==
Na barra superior dos Portais está disponível um ícone com um menu de contexto que permite interagir com os '''campos de texto''' de qualquer parte dos Portais. As opções disponíveis permitem melhorar textos, criar conteúdos, revisar a gramática, entre outras ações.<br>
<br>
[[Imagem:comandosCia.png|semmoldura|center|650px]]
<br>
A partir da versão '''Beta 260601''', essas opções passaram a ser exibidas em uma seção separada, chamada '''Geração de conteúdo''', apresentada no mesmo menu em que ficam os agentes.<br>
<br>
[[Imagem:MenuGeracaoConteudoAgentes.png|semmoldura|center|800px]]
<br>
O campo processado é sempre o '''último campo em que o cursor esteve posicionado''' antes de abrir o menu da Cia. Por isso, basta clicar no campo desejado e, em seguida, acionar o menu e escolher o comando.<br>
<br>
Para que o comando seja executado, o campo precisa ser um '''campo de texto válido''' e conter, no mínimo, '''três palavras'''. Caso contrário, será apresentada uma mensagem informando que o conteúdo não atende aos requisitos.<br>
<br>
Após o processamento, o conteúdo gerado é aplicado automaticamente no campo, substituindo o texto anterior, sem necessidade de confirmação.<br>
<br>
Essa funcionalidade também está disponível em telas modais, ou seja, janelas sobrepostas com interações:<br>
<br>
[[Imagem:comandosModalCia.png|semmoldura|center|800px]]
<br>

==Agentes==
A partir da versão '''Beta 260601''', o menu da Cia nos Portais passou a disponibilizar também o acesso aos agentes, tanto nos Portais MVC quanto nos Portais React.<br>
<br>
Ao abrir o menu da Cia, os agentes disponíveis são detectados automaticamente de acordo com a tela que está sendo acessada, ou seja, as opções apresentadas variam conforme a página aberta.<br>
<br>
[[Imagem:MenuAgentesCia.png|semmoldura|center|800px]]
<br>

===Como os agentes são disponibilizados===
A disponibilização de cada agente pode ocorrer de quatro formas:<br>
<br>
* '''Por contexto:''' o agente é apresentado quando a Cia identifica que a tela acessada corresponde ao assunto tratado por ele. Por exemplo, um agente sobre Ordem de Produção será disponibilizado ao acessar uma página cujo contexto seja identificado como Ordem de Produção.
<br>
* '''Por parâmetro:''' o agente é apresentado quando a Cia identifica, na tela, um parâmetro com o valor esperado por ele. Por exemplo, um agente de Pedidos será disponibilizado quando existir na tela um parâmetro que contenha o código do pedido.
<br>
* '''Por contexto e parâmetro:''' o agente é apresentado somente quando as duas condições forem atendidas ao mesmo tempo.
<br>
* '''Sempre disponível:''' o agente é apresentado em qualquer tela, independentemente do contexto ou dos parâmetros.
<br>

===Resultado do processamento===
Após o processamento, o retorno do agente pode ser apresentado de duas formas, conforme o que foi executado:<br>
<br>
* Em uma '''nova guia''' do navegador, quando o agente gera algum conteúdo ou relatório como resultado.
<br>
[[Imagem:AgentesRetornoGuia.png|semmoldura|center|800px]]
<br>
* Em uma '''janela modal''', dentro da própria página em que o usuário está, quando o retorno é uma mensagem.
<br>
[[Imagem:AgentesRetornoModal.png|semmoldura|center|800px]]
<br>
<div align="justify>
A partir da versão '''Beta 261005''', quando o resultado do agente é apresentado em uma nova guia, a página passa a disponibilizar também opções para utilização e compartilhamento da análise.
</div>
[[Imagem:resultadoAnalise.png|semmoldura|center|800px]]
<div align="justify">
No cabeçalho são apresentados o nome do agente executado e as opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>
<div align="justify">
=====Compartilhamento por e-mail=====
Ao selecionar a opção E-mail, será apresentada uma janela para preenchimento das informações necessárias para o envio.
</div>
[[Imagem:modalEmail.png|semmoldura|center|800px]]
<div align="justify">
Após informar os dados desejados e confirmar o envio, a análise gerada pelo agente será encaminhada ao destinatário como um arquivo em anexo.

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]].
</div>

==Editor de Agentes==
A partir da versão '''Beta 261005''', o menu passou a disponibilizar o acesso à ferramenta '''Editor de Agentes''', que permite criar seus próprios agentes.<br>
<br>
[[Imagem:EditorAgentesCia.png|semmoldura|center|800px]]
<br>
Ao clicar na opção, será aberta uma página web no formato de assistente (wizard), com cada etapa explicada de forma detalhada. Basta preencher as informações do agente conforme a sua necessidade e avançar pelos passos até a conclusão.<br>
<br>
[[Imagem:EditorAgentesWizard.png|semmoldura|center|800px]]
<br>
Ao final do processo, será gerado um arquivo com a extensão '''.cgagt''', que contém a definição do agente criado.<br>
<br>

===Disponibilizando o agente criado===
Para que o agente passe a ser exibido nos Portais, o arquivo '''.cgagt''' precisa ser colocado na aplicação da API, dentro da pasta raiz da aplicação.<br>
<br>
É necessário que existam as pastas '''Exclusivo''' e, dentro dela, '''Agentes'''. Caso não existam, elas devem ser criadas manualmente. O arquivo deve ser colocado dentro dessa estrutura, ficando da seguinte forma:<br>
<br>
/api/exclusivo/agentes/
<br>
Assim que o arquivo é adicionado nesse local, a Cia passa a reconhecer o agente automaticamente, sem necessidade de qualquer outra configuração. Os agentes customizados são exibidos no menu da Cia nos Portais, em uma seção separada dos agentes padrão.<br>
<br>
[[Imagem:MenuAgentesCustomizados.png|semmoldura|center|800px]]
<br>
==Conversar com documentos==
Em construção...<br>
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, além do acesso rápido à Cia Web, algumas ferramentas do sistema disponibilizam o recurso "Analisar com a Cia".<br>

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM), disponível no menu lateral do Desktop, abre a Cia Web de forma integrada ao sistema, em uma janela do próprio CIGAM.<br>
<br>
Desde que as configurações necessárias tenham sido aplicadas, conforme [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Acesso rápido à Cia Web (SaaS)|Acesso rápido à Cia Web (SaaS)]], '''todas as funcionalidades da Cia Web estarão disponíveis normalmente''', da mesma forma que no acesso pelo navegador. Para conhecê-las, consulte a seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] desta documentação.<br>
<br>
[[Imagem:CiaAbertaDesktop.png|semmoldura|center|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''' está disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída. Em todas elas, o comportamento é o mesmo: a Cia analisa o conteúdo que está em uso na tela e gera um relatório com o resultado da análise, apresentado em uma nova página.<br>
<br>
Ao acionar a opção, o fluxo é o seguinte:<br>
<br>
'''1. Confirmação dos termos de uso'''<br>
Antes de qualquer envio, será exibida uma mensagem solicitando que o usuário concorde com o envio das informações para análise. Os dados enviados seguem as diretrizes de segurança, privacidade e não retenção descritas em [[#Recursos, configurações e segurança|Recursos, configurações e segurança]].<br>
<br>
[[Imagem:AnalisarCiaTermos.png|semmoldura|center|500px]]
<br>
'''2. Complemento do prompt (opcional)'''<br>
Em seguida, será apresentada uma caixa de texto para que o usuário complemente a solicitação, orientando a análise para algum ponto específico. O preenchimento é opcional e pode ser deixado em branco.<br>
<br>
Essa caixa de texto serve apenas para complementar o prompt base que a Cia monta automaticamente, e não altera o conteúdo que está sendo enviado. O recurso considera que o usuário já filtrou os dados na própria tela do CIGAM antes de acionar a análise. O prompt base é mantido oculto por ser extenso e técnico, evitando que o usuário precise conferi-lo a cada utilização.<br>
<br>
[[Imagem:AnalisarCiaPrompt.png|semmoldura|center|700px]]
<br>
'''3. Geração do relatório'''<br>
Após a confirmação, a Cia processa o conteúdo e apresenta o relatório em uma nova página flutuante, com a análise dos dados enviados.<br>
<br>
O próprio relatório informa a quantidade de dados que foi analisada, permitindo que o usuário veja o volume aproximado considerado e identifique se o conteúdo enviado corresponde ao que esperava.<br>
<br>
[[Imagem:AnalisarCiaRelatorio.png|semmoldura|center|700px]]
<br>

===Limite de conteúdo enviado===
Existe um limite para o volume de conteúdo enviado em cada análise, que varia conforme a versão do ambiente:<br>
<br>
* '''150 KB''' — desde a disponibilização do recurso, na versão '''250505.a'''.
* '''3 MB''' — a partir das patches '''250505.i''' e '''251103.a''', e da versão '''RC 260504'''.
<br>
Quando o conteúdo selecionado ultrapassa esse limite, a Cia exibe uma mensagem informando o tamanho excedido e a análise não é processada, ou seja, nenhum relatório será gerado.<br>
<br>
[[Imagem:AnalisarCiaLimite.png|semmoldura|center|600px]]
<br>
'''Esse limite não é parametrizável e não se trata de uma restrição imposta pela CIGAM.''' Ele decorre da própria capacidade dos modelos de IA integrados à Cia, que possuem um limite técnico de volume de dados que conseguem processar em uma única análise. Quando esse volume é ultrapassado, os modelos passam a analisar as informações por amostragem — ou seja, mesmo que fosse permitido enviar uma quantidade maior de dados, o modelo não analisaria todo o conteúdo, e o resultado seria menos preciso. O limite adotado pela Cia acompanha essa característica dos modelos e assegura que a análise seja feita sobre os dados completos.<br>
<br>
Além da qualidade da análise, há também a questão do tempo de processamento: quanto maior o volume enviado, maior o tempo de resposta do modelo, tornando a espera inviável para o uso no dia a dia.<br>
<br>
Por isso, o recurso foi feito para ser simples e direto: analisar, com um clique, os dados que o usuário já está visualizando pelos meios tradicionais do CIGAM, como grids filtrados e relatórios. Em ambientes com grande volume de dados, a prática recomendada é '''filtrar e consolidar as informações na própria tela antes de acionar a análise''', reduzindo o período ou o escopo consultado. Para análises de períodos maiores, recomenda-se utilizar dados já consolidados, como totalizadores e relatórios sintéticos, em vez de listagens analíticas completas.<br>
<br>
A CIGAM está trabalhando em outras ferramentas que, por processarem os dados de forma diferente, permitirão trabalhar com volumes maiores de informação.<br>

Para saber como acessar o recurso em cada ferramenta, consulte: [[GE - Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Configuração da Cia IA do CIGAM]]

GE - Como Fazer - Uso da Cia - IA do CIGAM

2026-10-08T17:45:24Z

Vinicius.moder: /* Resultado do processamento */

{{VoltarPagina}}
<br>
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[categoria:Como_Fazer_Utilidades/Diversos_6]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Uso da Cia - IA do CIGAM|Como Fazer - Uso da Cia - IA do CIGAM]]

=Recursos, configurações e segurança=
A Cia - IA do CIGAM oferece diversas funcionalidades e atua como um hub centralizador para os recursos de inteligência artificial utilizados nas soluções CIGAM. Para garantir o correto funcionamento desses recursos, é necessário verificar se os pré-requisitos e as configurações foram realizados adequadamente. Para mais informações, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM|Como Fazer configuração da Cia IA do CIGAM]]
<br><br>
Todas as soluções de IA do CIGAM são integradas por meio dos serviços da Cia. A Cia possui integração com diferentes provedores de IA de terceiros, como OpenAI, Google, Anthropic, entre outros. Essas integrações são realizadas por meio de contas e serviços contratados, com condições de uso que asseguram que os dados trafegados não sejam utilizados para treinamento dos modelos, identificação de origem, publicidade, anúncios ou qualquer outra finalidade não prevista.
<br><br>
No caso de IAs open-source integradas à Cia, os modelos são executados dentro dos domínios da CIGAM, mantendo as mesmas premissas aplicadas às IAs contratadas: não utilização dos dados para treinamento de modelos, não identificação da origem das informações e ausência de retenção dos dados processados.
<br><br>
Além disso, sempre que houver envio explícito de dados pelo usuário por meio das funcionalidades da Cia disponíveis nas soluções CIGAM, será apresentado um diálogo de confirmação, permitindo que o usuário aceite o envio dessas informações. Os dados enviados serão tratados conforme as mesmas diretrizes de segurança, privacidade e não retenção descritas anteriormente.
<br><br>
Esta documentação apresenta o uso da Cia e está organizada conforme a forma de acesso: [[#Cia Web (SaaS)|Cia Web (SaaS)]], [[#Portais|Portais]] e [[#Desktop|Desktop]].
<br><br>
Caso tenha dúvidas sobre onde encontrar a Cia em cada uma dessas plataformas, ou sobre quais ferramentas do CIGAM possuem recursos integrados a ela, consulte a documentação específica de acesso: [[GE - Como Fazer - Cia - Como acessar|Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Cia Web (SaaS)=
A Cia Web é a aplicação web que centraliza todas as funcionalidades da Cia. Ela pode ser acessada diretamente pelo navegador do seu computador ou dispositivo móvel, ou ainda a partir do Desktop e dos Portais, sem a necessidade de novo login.
<br><br>

<center><youtube>https://youtu.be/DFGtRtPF75A</youtube></center>
<br>

==Primeiro acesso==
A Cia Web pode ser acessada diretamente pelo navegador, utilizando o seguinte endereço: https://services.cigam.cloud/cia/index.html
<br><br>
'''Importante:''' o usuário que for realizar o login precisa ter a autenticação em duas etapas habilitada. Para saber como configurá-la, consulte: [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Autenticação em duas etapas e configurações de envio de e-mail|Autenticação em duas etapas e configurações de envio de e-mail]]
<br><br>
Ao acessar pelo endereço, será necessário preencher algumas informações para que a Cia consiga validar seu acesso e consultar seus dados:<br>
* Informar a API do seu CIGAM Server, para garantir o direcionamento correto da base de dados.<br><br>

[[Imagem:CiaAPI.png|semmoldura|center|700px]]<br>

* Informar usuário e senha de login e seu código de verificação:<br><br>

[[Imagem:CiaLogin.png|semmoldura|center|700px]]
<br>
[[Imagem:CiaCodVerif.png|semmoldura|center|700px]]<br>

* Caso não queira aguardar ou informar o código de verificação, você pode optar por responder à pergunta secreta, clicando no botão “Pergunta Secreta” exibido na imagem acima.<br><br>

[[Imagem:CiaLoginA2F.png|semmoldura|center|700px]]
<br>

==Conhecendo a tela da Cia==
Após realizar o login, a Cia carregará automaticamente as informações e dados necessários do ambiente e será iniciada no assunto '''#Geral''', identificado pelo botão localizado à esquerda da caixa de texto.

[[Imagem:CiaGeral.png|semmoldura|center|700px]]
<br><br>
Ao clicar nesse botão, será exibida uma lista com todos os assuntos disponíveis, permitindo que você selecione aquele com o qual deseja interagir.<br><br>
Além disso, você pode digitar diretamente na caixa de texto o '''#Assunto''' que deseja utilizar, e a Cia entenderá automaticamente o tema da sua mensagem.<br><br>
Também é possível '''formular uma pergunta seguida de um #Assunto''' para interagir com qualquer assunto, mesmo que ele não esteja selecionado no momento.

[[Imagem:CiaAberta.png|semmoldura|center|700px]]
<br>
Ao selecionar um assunto, serão exibidas automaticamente dicas e sugestões sobre o tema escolhido, além de exemplos clicáveis que, ao serem selecionados, são processados de forma imediata.<br><br>
Além disso, ao digitar um ponto de interrogação (?) na caixa de texto, será exibida uma lista com todas as interações disponíveis para o assunto selecionado, facilitando a descoberta de comandos e possibilidades de uso.

[[Imagem:CiaDicas.png|semmoldura|center|700px]]
<br>
Outra funcionalidade prática é a possibilidade de reenviar perguntas já feitas no chat. Para isso, basta posicionar o mouse sobre a pergunta desejada e clicar no ícone de “Reenviar”. Ao passar o mouse sobre a mensagem, também será exibido o horário de envio.
<br>
[[Imagem:CiaReenviar.png|semmoldura|center|400px]]
<br>
Além disso, você pode utilizar as setas do teclado (⬆️ para cima e ⬇️ para baixo) na caixa de texto para navegar pelas últimas perguntas enviadas para o #Assunto selecionado, facilitando o reuso de interações anteriores.

===Ícones da caixa de texto===
Na caixa de texto, você encontrará alguns ícones com as seguintes funções:

<center>
{| class="wikitable"
|-
! !! Ação
|-
|center|[[Imagem:CiaUltPerg.png]] || '''Histórico de Perguntas''' – Ao clicar, é exibido o histórico das perguntas já realizadas para o assunto selecionado.
|-
|center|[[Imagem:CiaEnviar.png]] || '''Enviar''' – Envia o conteúdo digitado na caixa de texto.
|-
|center|[[Imagem:CiaFala.png]] || '''Falar''' – Permite falar ao invés de digitar, usando o recurso de voz.
|-
|center|[[Imagem:CiaExpandir.png]] || '''Expandir''' – Aumenta a altura da caixa de texto para facilitar a digitação de mensagens longas.
|-
|center|[[Imagem:CiaRecolher.png]] || '''Recolher''' – Reduz a caixa de texto ao tamanho padrão.
|}
</center>
{{VoltarInicio}}

==Assuntos disponíveis==

===Geral===
Nesse assunto, é possível conversar livremente com a Cia sobre qualquer um dos assuntos disponíveis. Se encontrar dificuldades para obter a resposta desejada, experimente selecionar um assunto específico, o que pode gerar resultados mais precisos.<br><br>
Se houver muitas respostas correspondentes, a Cia não executará nenhuma automaticamente. Em vez disso, exibirá uma opção com os valores possíveis, permitindo que você selecione manualmente a melhor alternativa.

[[Imagem:CiaGeralOpcoes.png|semmoldura|center|700px]]
<br>
Caso a Cia encontre uma resposta com confiança significativamente maior que as demais, ela será executada automaticamente.
<br><br>
No entanto, se você selecionar a opção “Não era bem isso o que eu queria”, a Cia exibirá outras opções relacionadas ao que foi solicitado, apresentando também um indicador de semáforo com a porcentagem de confiança de cada alternativa.

[[Imagem:CiaGeralOpcaoCerta.png|semmoldura|center|600px]]

===Ajuda, Vídeos e Auditor===
Conheça melhor o ERP com a ajuda da Wiki e Cia, assista vídeos sobre o CIGAM e audite seu ambiente.

====Ajuda====
Nesse assunto, você pode acessar o Chatbot da assistente virtual, onde você pode tirar dúvidas e consultar conteúdos da CIGAM Wiki enviando perguntas diretamente nela.<br>
<br>
'''Importante:''' neste assunto, a Cia atua dedicada à Wiki, focada exclusivamente nos conteúdos da documentação. As demais funcionalidades e atalhos da Cia não estarão disponíveis nesse contexto.

====Vídeos====
Nesse assunto, é possível procurar por vídeos relacionados ao tema desejado. O resultado será apresentado em forma de lista, contendo os vídeos encontrados e os tempos exatos em que o assunto começa a ser abordado, de acordo com o termo ou palavra pesquisada.

====Auditor====
Neste assunto, é possível verificar o status do sistema e identificar possíveis problemas ou inconsistências. O resultado será exibido em forma de tabela, contendo os dados retornados para facilitar a análise.

===Painéis BI, Portais e Relatórios===
Explore dashboards do BI, interaja com Portais intuitivos e execute relatórios personalizados.

====Painéis BI====
Nesse assunto, é possível abrir dashboards do BI já configurados para o usuário, permitindo sua visualização diretamente na tela.
Ao abrir um dashboard, você também pode interagir com ele, solicitando inserção de filtros, dimensões, métricas, transformações e outros ajustes.<br>
Cada dashboard aberto exibirá uma guia com as “Interações” disponíveis para aquele painel específico.
<br><br>
Além disso, ao selecionar o assunto '''#Painéis do BI''', é possível solicitar que a Cia crie um dashboard do zero.
Por exemplo: "Crie um dashboard para ver meu fluxo de caixa". Você pode ainda solicitar que métricas, dimensões e filtros sejam adicionados durante a criação, ou pedir dashboards separados por áreas.
<br><br>
'''Importante:''' caso o usuário não possua acesso ao BI ou este não esteja implementado na base de dados, será exibida uma mensagem informativa no momento do login na Cia.

====Portais====
Quando este assunto é utilizado, o resultado será sempre a abertura de uma tela dos Portais, permitindo ao usuário acessar diretamente os conteúdos e funcionalidades disponíveis nesse ambiente.
<br><br>
Essa abertura é feita de forma integrada, garantindo uma navegação contínua entre a Cia e os Portais, sem necessidade de realizar novo login ou sair da plataforma.

====Relatórios====
Ao utilizar esse assunto, será exibida uma tela para preenchimento de filtros, permitindo a emissão de relatórios web.
<br><br>
Para que essa funcionalidade opere corretamente, é necessário garantir que a instalação da CDN e da Pesquisa Dinâmica no servidor de aplicação esteja configurada de forma adequada.
<br><br>
Os relatórios exibidos aqui são os mesmos disponíveis nos Portais CIGAM, portanto é essencial que esses componentes também estejam funcionando corretamente nesses Portais.

===Qual, Faça, Consultar, Listar, Analisar e Insights===
Crie registros, analise informações ou liste dados cadastrados no CIGAM.

====Qual====
Nesse assunto, a Cia vai consultar e processar informações diretamente no ERP, usando os dados e relacionamentos disponíveis no CIGAM, e retornar os resultados em forma de texto para você visualizar.
<br><br>
'''Importante:''' nem todas as opções estão liberadas. Para ver quais você pode usar, digite ? na caixa de texto. A Cia vai mostrar uma lista com todos os comandos e funções disponíveis.

====Faça====
Nesse assunto, a Cia sempre fará um processamento no CIGAM e retornará o status do resultado. Por exemplo, você pode solicitar que a Cia crie um alerta ou até mesmo crie uma nova empresa no sistema.
<br><br>
'''Dica:''' para saber quais treinamentos ou comandos estão disponíveis, digite ? na caixa de texto. A Cia mostrará uma lista com todas as opções implementadas para você usar.

====Consultar====
Nesse assunto, você poderá fazer consultas de dados para obter listagens de registros, conforme os treinamentos de tabelas disponíveis. O resultado será apresentado em forma de tabela, exibindo os dados retornados. Já existem diversas Views prontas, para que você possa listar informações de forma mais completa e rápida.
<br><br>
'''Dica:''' para ver exemplos de consultas já implementadas, digite ? na caixa de texto.

====Listar====
Nesse assunto, você pode montar sua própria consulta de dados, escolhendo os filtros e parâmetros para gerar uma listagem personalizada. Diferente do assunto #Consultar, aqui é possível utilizar qualquer tabela do CIGAM para montar sua consulta, escrevendo em linguagem natural o que deseja buscar.
<br><br>
'''Dica:''' para ver todas as tabelas disponíveis, digite ? na caixa de texto.

====Analisar====
Analise o arquivo selecionado para gerar gráficos interativos e informativos, apresentando insights relevantes que ajudam a identificar tendências, padrões e oportunidades de melhoria.
<br><br>
Esse recurso oferece uma visualização clara e intuitiva dos dados, facilitando a interpretação das informações e apoiando a tomada de decisões estratégicas.
<br><br>
'''Aviso:''' para utilizar esta funcionalidade, é necessário concordar que os dados enviados serão processados por modelos de IA de terceiros integrados à Cia.

[[Imagem:AnalisarCia.png|semmoldura|center|600px]]

====Insights====
Gere insights inteligentes a partir dos dados de uma consulta, com análises automáticas realizadas pela Cia, que identificam padrões, tendências e possíveis pontos de atenção. Esse recurso ajuda a transformar dados brutos em informações acionáveis, facilitando a tomada de decisões estratégicas e otimizando processos.
<br><br>
'''Aviso:''' ao utilizar o assunto “Insights”, você concorda que os dados e informações analisados poderão ser enviados para modelos de IA de terceiros integrados à Cia, exclusivamente para processamento e geração dos resultados apresentados.

===IA Generativa e Pesquisa na Internet===
Converse com a IA sobre assuntos diversos, crie conteúdos e pesquise na internet sobre qualquer coisa.

====IA Generativa====
Nesse assunto, ao interagir com a IA Generativa, você poderá fazer qualquer tipo de pergunta ou solicitação, de forma livre e criativa.
O resultado exibido será exatamente a resposta gerada pela IA, sem complementos da Cia. Você pode, por exemplo, solicitar que a IA melhore ou reformule um texto, crie conteúdos ou resuma informações.
<br><br>
'''Importante:''' nesse assunto, a Cia não estará integrada aos serviços e sistemas do CIGAM — a interação é exclusivamente com a IA Generativa.

====Pesquisa na Internet====
Use esse assunto para fazer pesquisas na internet e visualizar os resultados diretamente integrados na Cia, sem precisar sair da plataforma. Você pode pesquisar qualquer tema de interesse e abrir os links retornados para acessar conteúdos, notícias e informações de forma rápida e prática.
{{VoltarInicio}}

==Configurações==
O ícone de engrenagem, localizado no canto superior direito da página, reúne recursos de informação e gerenciamento. As opções disponíveis são:
* '''Respostas com áudio:''' quando ativado, as respostas da Cia são narradas em voz alta.
* '''Ambiente atual do CIGAM:''' exibe na tela o usuário logado e o ambiente em uso.
* '''Ver consumo:''' mostra a quantidade de tokens já utilizados e os usuários que geraram consumo.
* '''Limpar dados de navegação:''' exibe uma mensagem explicando como limpar os dados de navegação do navegador.
* '''Limpar cookies:''' apaga os dados armazenados localmente, permitindo informar novamente a API e realizar um novo login.
* '''Instalar aplicativo:''' instala a Cia como aplicativo no dispositivo, criando um atalho na tela inicial.
* '''Documentação na wiki:''' direciona para a documentação da Cia na CIGAM Wiki.
* '''Sair:''' encerra a sessão do usuário, permitindo realizar login com outro usuário.
<br>
[[Imagem:ConfiguracoesCia.png|semmoldura|center|500px]]
{{VoltarInicio}}

=Portais=
Nos Portais CIGAM, além do acesso à Cia Web pelo menu de mosaico, estão disponíveis recursos de IA que atuam diretamente nas telas em que você está trabalhando. Esses recursos não exigem parametrização e são apresentados de acordo com o contexto da tela.<br>

==Acesso à Cia Web (SaaS) pelo menu mosaico==
O acesso à Cia Web a partir dos Portais é feito pelo ícone de mosaico, onde está disponível o ícone da Cia - IA do CIGAM.<br>
<br>
[[Imagem:mosaicoCia.png|semmoldura|center|800px]]
<br>
A Cia será aberta de forma integrada, sem a necessidade de novo login, e todas as funcionalidades descritas na seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] estarão disponíveis normalmente.<br>

==Geração de conteúdo==
Na barra superior dos Portais está disponível um ícone com um menu de contexto que permite interagir com os '''campos de texto''' de qualquer parte dos Portais. As opções disponíveis permitem melhorar textos, criar conteúdos, revisar a gramática, entre outras ações.<br>
<br>
[[Imagem:comandosCia.png|semmoldura|center|650px]]
<br>
A partir da versão '''Beta 260601''', essas opções passaram a ser exibidas em uma seção separada, chamada '''Geração de conteúdo''', apresentada no mesmo menu em que ficam os agentes.<br>
<br>
[[Imagem:MenuGeracaoConteudoAgentes.png|semmoldura|center|800px]]
<br>
O campo processado é sempre o '''último campo em que o cursor esteve posicionado''' antes de abrir o menu da Cia. Por isso, basta clicar no campo desejado e, em seguida, acionar o menu e escolher o comando.<br>
<br>
Para que o comando seja executado, o campo precisa ser um '''campo de texto válido''' e conter, no mínimo, '''três palavras'''. Caso contrário, será apresentada uma mensagem informando que o conteúdo não atende aos requisitos.<br>
<br>
Após o processamento, o conteúdo gerado é aplicado automaticamente no campo, substituindo o texto anterior, sem necessidade de confirmação.<br>
<br>
Essa funcionalidade também está disponível em telas modais, ou seja, janelas sobrepostas com interações:<br>
<br>
[[Imagem:comandosModalCia.png|semmoldura|center|800px]]
<br>

==Agentes==
A partir da versão '''Beta 260601''', o menu da Cia nos Portais passou a disponibilizar também o acesso aos agentes, tanto nos Portais MVC quanto nos Portais React.<br>
<br>
Ao abrir o menu da Cia, os agentes disponíveis são detectados automaticamente de acordo com a tela que está sendo acessada, ou seja, as opções apresentadas variam conforme a página aberta.<br>
<br>
[[Imagem:MenuAgentesCia.png|semmoldura|center|800px]]
<br>

===Como os agentes são disponibilizados===
A disponibilização de cada agente pode ocorrer de quatro formas:<br>
<br>
* '''Por contexto:''' o agente é apresentado quando a Cia identifica que a tela acessada corresponde ao assunto tratado por ele. Por exemplo, um agente sobre Ordem de Produção será disponibilizado ao acessar uma página cujo contexto seja identificado como Ordem de Produção.
<br>
* '''Por parâmetro:''' o agente é apresentado quando a Cia identifica, na tela, um parâmetro com o valor esperado por ele. Por exemplo, um agente de Pedidos será disponibilizado quando existir na tela um parâmetro que contenha o código do pedido.
<br>
* '''Por contexto e parâmetro:''' o agente é apresentado somente quando as duas condições forem atendidas ao mesmo tempo.
<br>
* '''Sempre disponível:''' o agente é apresentado em qualquer tela, independentemente do contexto ou dos parâmetros.
<br>

===Resultado do processamento===
Após o processamento, o retorno do agente pode ser apresentado de duas formas, conforme o que foi executado:<br>
<br>
* Em uma '''nova guia''' do navegador, quando o agente gera algum conteúdo ou relatório como resultado.
<br>
[[Imagem:AgentesRetornoGuia.png|semmoldura|center|800px]]
<br>
* Em uma '''janela modal''', dentro da própria página em que o usuário está, quando o retorno é uma mensagem.
<br>
[[Imagem:AgentesRetornoModal.png|semmoldura|center|800px]]
<br>
<div align="justify>
A partir da versão '''Beta 261005''', quando o resultado do agente é apresentado em uma nova guia, a página passa a disponibilizar também opções para utilização e compartilhamento da análise.
</div>
[[Imagem:resultadoAnalise.png|semmoldura|center|800px]]
<div align="justify">
No cabeçalho são apresentados o nome do agente executado e as opções:

* '''E-mail:''' compartilhar a análise por e-mail. Ao selecionar essa opção, é apresentada uma janela para informar os destinatários, o assunto e o texto da mensagem. A análise gerada é enviada como um arquivo em anexo.
* '''Baixar:''' realizar o download da análise para o computador.
* '''Imprimir:''' abrir a opção de impressão da análise exibida.
</div>
<div align="justify">
=====Compartilhamento por e-mail=====
Ao selecionar a opção E-mail, será apresentada uma janela para preenchimento das informações necessárias para o envio.
</div>
[[Imagem:modalEmail.png|semmoldura|center|800px]]
<div align="justify">
Após informar os dados desejados e confirmar o envio, a análise gerada pelo agente será encaminhada ao destinatário como um arquivo em anexo.

Para utilizar esse recurso, o ambiente deve possuir as configurações necessárias para envio de e-mails pelo CIGAM devidamente parametrizadas. Para mais informações, consulte.
</div>

==Editor de Agentes==
A partir da versão '''Beta 261005''', o menu passou a disponibilizar o acesso à ferramenta '''Editor de Agentes''', que permite criar seus próprios agentes.<br>
<br>
[[Imagem:EditorAgentesCia.png|semmoldura|center|800px]]
<br>
Ao clicar na opção, será aberta uma página web no formato de assistente (wizard), com cada etapa explicada de forma detalhada. Basta preencher as informações do agente conforme a sua necessidade e avançar pelos passos até a conclusão.<br>
<br>
[[Imagem:EditorAgentesWizard.png|semmoldura|center|800px]]
<br>
Ao final do processo, será gerado um arquivo com a extensão '''.cgagt''', que contém a definição do agente criado.<br>
<br>

===Disponibilizando o agente criado===
Para que o agente passe a ser exibido nos Portais, o arquivo '''.cgagt''' precisa ser colocado na aplicação da API, dentro da pasta raiz da aplicação.<br>
<br>
É necessário que existam as pastas '''Exclusivo''' e, dentro dela, '''Agentes'''. Caso não existam, elas devem ser criadas manualmente. O arquivo deve ser colocado dentro dessa estrutura, ficando da seguinte forma:<br>
<br>
/api/exclusivo/agentes/
<br>
Assim que o arquivo é adicionado nesse local, a Cia passa a reconhecer o agente automaticamente, sem necessidade de qualquer outra configuração. Os agentes customizados são exibidos no menu da Cia nos Portais, em uma seção separada dos agentes padrão.<br>
<br>
[[Imagem:MenuAgentesCustomizados.png|semmoldura|center|800px]]
<br>
==Conversar com documentos==
Em construção...<br>
{{VoltarInicio}}

=Desktop=
Na aplicação Desktop, além do acesso rápido à Cia Web, algumas ferramentas do sistema disponibilizam o recurso "Analisar com a Cia".<br>

==Acesso rápido à Cia Web (SaaS)==
O botão de acesso rápido (Cia - IA do CIGAM), disponível no menu lateral do Desktop, abre a Cia Web de forma integrada ao sistema, em uma janela do próprio CIGAM.<br>
<br>
Desde que as configurações necessárias tenham sido aplicadas, conforme [[GE - Como Fazer - Configuração da Cia IA do CIGAM#Acesso rápido à Cia Web (SaaS)|Acesso rápido à Cia Web (SaaS)]], '''todas as funcionalidades da Cia Web estarão disponíveis normalmente''', da mesma forma que no acesso pelo navegador. Para conhecê-las, consulte a seção [[#Cia Web (SaaS)|Cia Web (SaaS)]] desta documentação.<br>
<br>
[[Imagem:CiaAbertaDesktop.png|semmoldura|center|800px]]
<br>

==Recurso "Analisar com a Cia"==
O recurso '''"Analisar com a Cia"''' está disponível em ferramentas como CGEditor, CGReport, Pesquisa Dinâmica e Dispositivo de Saída. Em todas elas, o comportamento é o mesmo: a Cia analisa o conteúdo que está em uso na tela e gera um relatório com o resultado da análise, apresentado em uma nova página.<br>
<br>
Ao acionar a opção, o fluxo é o seguinte:<br>
<br>
'''1. Confirmação dos termos de uso'''<br>
Antes de qualquer envio, será exibida uma mensagem solicitando que o usuário concorde com o envio das informações para análise. Os dados enviados seguem as diretrizes de segurança, privacidade e não retenção descritas em [[#Recursos, configurações e segurança|Recursos, configurações e segurança]].<br>
<br>
[[Imagem:AnalisarCiaTermos.png|semmoldura|center|500px]]
<br>
'''2. Complemento do prompt (opcional)'''<br>
Em seguida, será apresentada uma caixa de texto para que o usuário complemente a solicitação, orientando a análise para algum ponto específico. O preenchimento é opcional e pode ser deixado em branco.<br>
<br>
Essa caixa de texto serve apenas para complementar o prompt base que a Cia monta automaticamente, e não altera o conteúdo que está sendo enviado. O recurso considera que o usuário já filtrou os dados na própria tela do CIGAM antes de acionar a análise. O prompt base é mantido oculto por ser extenso e técnico, evitando que o usuário precise conferi-lo a cada utilização.<br>
<br>
[[Imagem:AnalisarCiaPrompt.png|semmoldura|center|700px]]
<br>
'''3. Geração do relatório'''<br>
Após a confirmação, a Cia processa o conteúdo e apresenta o relatório em uma nova página flutuante, com a análise dos dados enviados.<br>
<br>
O próprio relatório informa a quantidade de dados que foi analisada, permitindo que o usuário veja o volume aproximado considerado e identifique se o conteúdo enviado corresponde ao que esperava.<br>
<br>
[[Imagem:AnalisarCiaRelatorio.png|semmoldura|center|700px]]
<br>

===Limite de conteúdo enviado===
Existe um limite para o volume de conteúdo enviado em cada análise, que varia conforme a versão do ambiente:<br>
<br>
* '''150 KB''' — desde a disponibilização do recurso, na versão '''250505.a'''.
* '''3 MB''' — a partir das patches '''250505.i''' e '''251103.a''', e da versão '''RC 260504'''.
<br>
Quando o conteúdo selecionado ultrapassa esse limite, a Cia exibe uma mensagem informando o tamanho excedido e a análise não é processada, ou seja, nenhum relatório será gerado.<br>
<br>
[[Imagem:AnalisarCiaLimite.png|semmoldura|center|600px]]
<br>
'''Esse limite não é parametrizável e não se trata de uma restrição imposta pela CIGAM.''' Ele decorre da própria capacidade dos modelos de IA integrados à Cia, que possuem um limite técnico de volume de dados que conseguem processar em uma única análise. Quando esse volume é ultrapassado, os modelos passam a analisar as informações por amostragem — ou seja, mesmo que fosse permitido enviar uma quantidade maior de dados, o modelo não analisaria todo o conteúdo, e o resultado seria menos preciso. O limite adotado pela Cia acompanha essa característica dos modelos e assegura que a análise seja feita sobre os dados completos.<br>
<br>
Além da qualidade da análise, há também a questão do tempo de processamento: quanto maior o volume enviado, maior o tempo de resposta do modelo, tornando a espera inviável para o uso no dia a dia.<br>
<br>
Por isso, o recurso foi feito para ser simples e direto: analisar, com um clique, os dados que o usuário já está visualizando pelos meios tradicionais do CIGAM, como grids filtrados e relatórios. Em ambientes com grande volume de dados, a prática recomendada é '''filtrar e consolidar as informações na própria tela antes de acionar a análise''', reduzindo o período ou o escopo consultado. Para análises de períodos maiores, recomenda-se utilizar dados já consolidados, como totalizadores e relatórios sintéticos, em vez de listagens analíticas completas.<br>
<br>
A CIGAM está trabalhando em outras ferramentas que, por processarem os dados de forma diferente, permitirão trabalhar com volumes maiores de informação.<br>

Para saber como acessar o recurso em cada ferramenta, consulte: [[GE - Como Fazer - Cia - Como acessar]]
{{VoltarInicio}}

=Documentos Relacionados=
[[GE - Como Fazer - Cia - Como acessar]]<br>
[[GE - Como Fazer - Configuração da Cia IA do CIGAM]]

GE - Como Fazer - Pesquisa Dinâmica

2026-08-28T14:08:11Z

Vinicius.moder: /* Como montar a pesquisa dinâmica para utilização na WEB */

{{VoltarPagina}}
<br>
[[categoria:Como Fazer Utilidades/Diversos]]
[[categoria:Como_Fazer_Utilidades/Diversos_6]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Pesquisa Dinâmica|Pesquisa Dinâmica]]

=Pesquisa Dinâmica Desktop=
A '''Pesquisa Dinâmica Desktop''' no CIGAM é uma funcionalidade projetada para '''facilitar a busca e filtragem de informações diretamente na tela do sistema''', sem a necessidade de abrir relatórios complexos ou exportar dados manualmente. Ela é especialmente útil para usuários que precisam '''localizar registros de forma rápida e eficiente''', otimizando o tempo e garantindo maior precisão nas informações consultadas.<br>
<br>
Disponível a partir da versão '''CIGAM 11''', a funcionalidade permite, a partir de '''um modelo pré-cadastrado em XML''', realizar consultas dinâmicas, aplicando filtros por campos macros e/ou por faixas, conforme a necessidade.<br>
<br>
De forma detalhada, a Pesquisa Dinâmica Desktop oferece:
:* '''Filtrar dados em tempo real:''' digite palavras-chave ou critérios específicos e veja os resultados instantaneamente, agilizando a localização de registros, mesmo em grandes volumes de dados.
:* '''Personalizar colunas e resultados:''' escolha quais campos quer visualizar, altere a ordem das colunas e destaque as informações mais relevantes.
:* '''Aplicar múltiplos critérios de pesquisa:''' combine filtros como datas, status, centros de custo, clientes, produtos ou outros parâmetros, permitindo consultas detalhadas e precisas.
:* '''Agilizar a tomada de decisão:''' ao acessar rapidamente os dados relevantes, o usuário consegue tomar decisões mais seguras e ágeis.
:* '''Exportação rápida e flexível:''' os resultados podem ser exportados para Excel, PDF ou outros formatos, facilitando análises externas e compartilhamento de informações.
:* '''Aumento da produtividade:''' reduz o tempo gasto na busca e filtragem, contribuindo para processos mais eficientes e controle mais preciso sobre os dados do sistema.

Na tela da Pesquisa Dinâmica, estão disponíveis quatro principais ações:
:* '''Visão rápida -''' Exibe informações resumidas do modelo configurado.
:* '''Visualizar -''' Abre a tela em modo de consulta para o item selecionado.
:* '''Modificar -''' Abre a tela em modo de edição para o item selecionado.
:* '''Criar -''' Abre a tela em modo de criação de um novo modelo.

Para mais detalhes sobre o funcionamento de cada botão, consulte a página [[GE_-_Como_Fazer_-_Pesquisa_Dinâmica#Comportamento_dos_botões_na_Pesquisa_Dinâmica|Comportamento dos botões na Pesquisa Dinâmica]].

==Como montar a Pesquisa Dinâmica no CIGAM==
Para utilizar a Pesquisa Dinâmica, a empresa precisa ter dois arquivos modelo:
:* Um arquivo '''XML''', que define os campos e filtros da pesquisa.
:* Um arquivo '''RTF''', que será usado na visão rápida para exibir os resultados de forma resumida.

Esses arquivos devem estar na pasta: <code>%CIGAM_INSTAL%Modelos\Pesquisas\</code><br>
<br>
📂 '''Exemplo de arquivos:'''
:* <code>CG02075_Empresas.xml</code>
:* <code>CG02075_Empresas.rtf</code>

⚠️ '''Dica:''' Veja como informar esses arquivos dentro do arquivo XML usando o [[GE - Como Fazer - Pesquisa Dinâmica#6._Elemento_%3Clupa%3E|Elemento lupa]].

== '''Estrutura do arquivo XML''' ==
O arquivo XML apresentado segue uma organização típica de configuração ou definição de tela no sistema, contendo tanto '''comentários explicativos''' quanto '''elementos funcionais''' que controlam o comportamento da pesquisa.

===1. Cabeçalho XML===
Define informações fundamentais sobre o documento XML, incluindo a versão do padrão utilizado, a codificação de caracteres e a independência do arquivo.

<span style="color:blue"><?xml</span> <span style="color:red">version</span>=<span style="color:brown">"1.0"</span> <span style="color:red">encoding</span>=<span style="color:brown">"UTF-8"</span> <span style="color:red">standalone</span>=<span style="color:brown">"no"</span></span> <span style="color:blue">?></span>

:* Define a versão do XML utilizada (1.0).
:* Informa que a codificação é '''UTF-8'''.
:* O atributo <code>standalone="no"</code> indica que o documento pode depender de definições externas (como DTD ou schemas).
{{VoltarInicio}}

===2. Comentário inicial - Parâmetros de sintaxe do banco de dados===
Documenta as diferenças de sintaxe entre MSSQL e Oracle, fornecendo códigos de referência que podem ser aplicados em consultas parametrizadas. Serve como guia para adaptação automática de instruções SQL pelo CIGAM, garantindo que consultas criadas para múltiplos bancos de dados sejam executadas corretamente, independentemente do sistema de gerenciamento utilizado. Além disso, funciona como documentação interna do XML, sem ser processada pelo sistema.

<span style="color:green"></span>

: Esse bloco está '''comentado e não é processado pelo sistema'''. Serve para documentar diferenças de sintaxe entre '''MSSQL''' e '''Oracle''', utilizando códigos <code>{0}</code>, <code>{1}</code>, etc. que podem ser aplicados em consultas parametrizadas. Indica quais palavras-chave ou funções usar em cada banco.

: Ao criar o arquivo XML da Pesquisa Dinâmica, alguns códigos especiais ajudam a '''adaptar a consulta para diferentes bancos de dados''' (por exemplo, SQL Server ou Oracle). Esses códigos funcionam como “atalhos”, que o CIGAM interpreta e substitui automaticamente conforme o banco utilizado.

<center>
{| class="wikitable mw-collapsible sortable" border="1" cellpadding="5" cellspacing="0" width: 900px;"
!Código!!MSSQL!!Oracle!!Descrição
|-
|'''{0}'''||with (nolock)||(em branco)||Evita bloqueio de registros durante a leitura
|-
|'''{1}'''||top 1||(em branco)||Retorna apenas o primeiro registro
|-
|'''{2}'''||%DBUSUARIO%.||(em branco)||Refere-se ao nome do usuário do banco
|-
|'''{3}'''||+||||||Concatenação de textos ou valores
|-
|'''{4}'''||substring||substr||Extrai parte de um texto
|-
|'''{5}'''||(em branco)||from dual||Usado em consultas sem tabela principal
|-
|'''{6}'''||(em branco)||and rownum = 1||Retorna apenas um registro
|-
|'''{7}'''||cast(||utl_raw.cast_to_varchar2(||Converte tipos de dados
|-
|'''{8}'''||as varchar(max))||)||Fecha a conversão
|-
|'''{9}'''||Comentado||(em branco)||Texto comentado (ignorado na execução)
|-
|'''{10}'''||(em branco)||Comentado||Texto comentado (ignorado na execução)
|-
|'''{11}'''||/*||(em branco)||Início de comentário em bloco
|-
|'''{12}'''||*/||(em branco)||Fim de comentário em bloco
|-
|'''{13}'''||(em branco)||/*||Início de comentário em bloco (formato Oracle)
|-
|'''{14}'''||(em branco)||*/||Fim de comentário em bloco (formato Oracle)
|}
</center>
:💡 '''Importante:''' Use os códigos exatamente como estão para garantir que a pesquisa funcione tanto no SQL Server quanto no Oracle sem precisar criar dois arquivos diferentes.
{{VoltarInicio}}

===3. Elemento <code><pesquisaPaginada></code>===
Define a estrutura principal da Pesquisa Dinâmica, organizando a exibição dos dados de forma paginada e centralizando todas as configurações da pesquisa, como consultas, filtros, grids e visualizações adicionais.

<span style="color:blue"><pesquisaPaginada></span>
...
<span style="color:blue"></pesquisaPaginada></span>

:* É o elemento raiz funcional do documento.
:* Indica que os dados exibidos serão carregados de forma '''paginada''' (em partes, não todos de uma vez).
:* Contém a definição de '''select''', '''grid''', '''lupa''', '''faixa''', '''filtros''' e '''mosaicos'''.

===4. Elemento <code><select></code>===
Define os parâmetros iniciais da consulta da Pesquisa Dinâmica, incluindo fonte de dados, comportamento da interface e limites de registros, permitindo controle total sobre como os dados são carregados, exibidos e navegados pelo usuário.

<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><select</span>
<span style="color:red">paginacao</span>=<span style="color:brown">"0"</span> ''<span style="color:green"></span>''
<span style="color:red">initFolder</span>=<span style="color:brown">"P"</span> ''<span style="color:green"></span>''
<span style="color:red">acaoVisualizar</span>=<span style="color:brown">"L"</span> ''<span style="color:green"></span>''
<span style="color:red">duploClick</span>=<span style="color:brown">"V"</span> ''<span style="color:green"></span>''
<span style="color:red">sugerirCargaTotal</span>=<span style="color:brown">"S"</span> ''<span style="color:green"></span>''
<span style="color:red">xml</span>=<span style="color:brown">"F:\PP.xml"</span> ''<span style="color:green"></span>''
<span style="color:red">xsd</span>=<span style="color:brown">"F:\PP.xsd"</span> ''<span style="color:green"></span>''
<span style="color:red">userTempFolder</span>=<span style="color:brown">"true"</span> ''<span style="color:green"></span>''
<span style="color:red">limiteRegistros</span>=<span style="color:brown">"100"</span> ''<span style="color:green"></span>''
<span style="color:blue">></span>
...
<span style="color:blue"></select></span>
<span style="color:blue"></pesquisaPaginada></span>

:O elemento <code><select></code> dentro de <code><pesquisaPaginada></code> define os '''parâmetros iniciais da consulta''' e pode conter a '''consulta SQL''', ou, alternativamente, uma '''fonte de dados XML/XSD'''.

:💡 '''Importante:'''
::* A consulta SQL deve estar '''completa''' dentro do <code><select></code>.
::* Sempre incluir <code>SELECT</code>, <code>FROM</code>, <code>WHERE</code> e quaisquer ''joins'' ou ''subconsultas'' necessários.
::* O sistema irá processar essa consulta e exibir os resultados na tela da '''Pesquisa Dinâmica'''.

:⚠️ '''Observação sobre uso de CONCAT na cláusula WHERE'''
::* A utilização de '''concatenação''' (<code>CONCAT</code> ou <code>||</code>) diretamente na cláusula <code>WHERE</code> pode impactar negativamente a '''performance''' da consulta. Isso ocorre porque:
:::* Pode impedir o uso de '''índices'''.
:::* Reduz a capacidade do otimizador do banco de dados de gerar um plano de execução eficiente.

:: '''Recomendação:'''
::: Evite concatenar colunas dentro do <code>WHERE</code>. Sempre que possível, reescreva a condição utilizando comparações diretas, permitindo que índices sejam utilizados.

::👨‍💻 '''Boas práticas'''
::* As consultas para a '''Pesquisa Dinâmica''' devem ser elaboradas por usuários com '''conhecimento em Banco de Dados (BD)'''.
::* Otimize sempre pensando em performance, principalmente em bases com grande volume de dados.
::* Teste as consultas no banco antes de implementá-las no XML.

==== <font color=green>Configurando para iniciar aberto em "Faixa" ou "Pesquisar"</font> ====
: ℹ️ Dentro do arquivo XML, é possível selecionar '''qual guia iniciará aberta''' na tela da Pesquisa Dinâmica.
: Para isso, deve-se utilizar o atributo <code>initFolder</code> na tag <code><select></code>. Os valores válidos são:
[[Image:ModeloPD_iniciarPesquisar.png|150px|thumb|Pesquisar]]
::* <code>"P"</code> → Pesquisar
::* <code>"F"</code> → Faixa

: Exemplo configurando para iniciar na guia Pesquisar:
<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><select</span> <span style="color:red">paginacao</span>=<span style="color:brown">"0"</span> <span style="background-color:yellow"><span style="color:red">initFolder</span>=<span style="color:brown">"P"</span></span> <span style="color:blue">></span>
...
<span style="color:blue"></select></span>
<span style="color:blue"></pesquisaPaginada></span>

[[File:ModeloPD_iniciarFaixa.png|150px|thumb|Faixa]]
:Exemplo configurando para iniciar na guia Faixa:
<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><select</span> <span style="color:red">paginacao</span>=<span style="color:brown">"0"</span> <span style="background-color:yellow"><span style="color:red">initFolder</span>=<span style="color:brown">"F"</span></span> <span style="color:blue">></span>
...
<span style="color:blue"></select></span>
<span style="color:blue"></pesquisaPaginada></span>

==== <font color=green>Como configurar para navegar dentro dos cadastros</font> ====
: ℹ️ É possível navegar entre os cadastros usando as teclas '''"Page Up"''' e '''"Page Down"''' no CIGAM11. O comportamento pode ser parametrizado através do atributo <code>acaoVisualizar</code> na tag <code><select></code>:
::* <code>"L"</code> → Locate / Localizar
::* <code>"F"</code> → Range / Faixa

::'''Exemplo:'''
<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><select</span> <span style="color:red">paginacao</span>=<span style="color:brown">"0"</span> <span style="color:red">initFolder</span>=<span style="color:brown">"P"</span> <span style="background-color:yellow"><span style="color:red">acaoVisualizar</span>=<span style="color:brown">"L"</span></span> <span style="color:blue">></span>
...
<span style="color:blue"></select></span>
<span style="color:blue"></pesquisaPaginada></span>

::'''Observação:'''
::Esse atributo está disponível apenas para o botão <code><Visualizar></code>. Caso não esteja informado, ao clicar no botão <code><Visualizar></code>, o sistema entrará automaticamente em '''range/faixa''' sobre o registro selecionado.

==== <font color=green>Como configurar o duplo clique na Pesquisa Dinâmica</font> ====
: ℹ️ O duplo clique em um registro listado, assim como a tecla '''Enter''', pode ser parametrizado para definir '''o modo de abertura do registro'''.
: O comportamento é definido através do atributo <code>duploClick</code> na tag <code><select></code>. Valores possíveis:
::* <code>"V"</code> → Visualizar
::* <code>"M"</code> → Modificar
::* <code>"C"</code> → Criar

::'''Exemplo:'''
<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><select</span> <span style="color:red">paginacao</span>=<span style="color:brown">"0"</span> <span style="color:red">initFolder</span>=<span style="color:brown">"P"</span> <span style="background-color:yellow"><span style="color:red">duploClick</span>=<span style="color:brown">"M"</span></span> <span style="color:blue">></span>
...
<span style="color:blue"></select></span>
<span style="color:blue"></pesquisaPaginada></span>

==== <font color=green>Como configurar a mensagem de "Deseja carregar todos os registros para ir para a última página?"</font> ====
: ℹ️ A partir da <ref group="Versão 231002.d">Liberado a partir da OS 373456/676.</ref>, a mensagem "Deseja carregar todos os registros para ir para a última página?" '''não será exibida automaticamente''' após a consulta com filtros.
<br>
<div style="text-align:center;">[[Image:PD_mensagemUltimaPag.jpg|450x250px]]</div>
<br>

:'''Habilitando a mensagem'''
::Para que a mensagem seja exibida, é necessário adicionar o parâmetro <code>sugerirCargaTotal="S"</code> na tag <code><select></code> do modelo XML:

<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><select</span> <span style="color:red">paginacao</span>=<span style="color:brown">"0"</span> <span style="color:red">initFolder</span>=<span style="color:brown">"P"</span> <span style="background-color:yellow"><span style="color:red">sugerirCargaTotal</span>=<span style="color:brown">"S"</span></span> <span style="color:blue">></span>
...
<span style="color:blue"></select></span>
<span style="color:blue"></pesquisaPaginada></span>

:'''Observação:'''
::* Se o modelo utilizado não contiver esse parâmetro ou ele estiver definido como <code>"N"</code>, a mensagem '''não será exibida'''.
::* Independente do uso do parâmetro, a mensagem será exibida sempre que os botões '''"Última página"''' ou '''"Olap"''' forem utilizados.

<div style="text-align:center;">[[Image:PD_botaoUltimaPag.jpg|500x300px]]</div>

==== <font color=green>Como utilizar uma fonte de dados em xml</font> ====
: ℹ️ Para casos específicos, os dados podem vir de arquivos XML/XSD em vez de uma consulta SQL.
: Para utilização, na tag <code><select></code> não deve ser definida nenhuma instrução de banco de dados como valor e informar os atributos <code>xml</code> e <code>xsd</code> como os nomes de arquivos respectivamente.

<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><select</span> <span style="color:red">paginacao</span>=<span style="color:brown">"0"</span> <span style="background-color:yellow"><span style="color:red">xml</span>=<span style="color:brown">"F:\PP.xml"</span></span> <span style="background-color:yellow"><span style="color:red">xsd</span>=<span style="color:brown">"F:\PP.xsd"</span></span> <span style="background-color:yellow"><span style="color:red">userTempFolder</span>=<span style="color:brown">"true"</span></span> <span style="color:blue">/></span>
...
<span style="color:blue"></select></span>
<span style="color:blue"></pesquisaPaginada></span>

:* <code>xml</code> → arquivo XML com os dados
:* <code>xsd</code> → arquivo XSD com a definição das colunas
:* <code>userTempFolder="true"</code> → indica que os arquivos estão na pasta temporária do usuário (%TEMP%)

: 💡 Diferente da visão rápida, aqui é '''necessário informar o caminho completo do arquivo''', pois ele pode estar em pasta diferente do modelo XML.

:🔹 '''Regras ao utilizar XML/XSD como fonte'''
:# Não usar '''prefixo de tabela''' nos campos de filtros.
:# Atributos de filtros como <code>where</code> e <code>order by</code> continuam suportados, mas sem prefixos.
:# Campos com espaços devem ser colocados entre colchetes. Ex. <code>[nome da empresa]</code>.
:# A paginação sempre será '''completa''', pois todos os registros do XML são carregados em memória.
:# Filtros por faixa que dependam de sub-selects ou fontes secundárias '''não são suportados'''.
:# Zoom em campos pode ser configurado via <code>zoom="[número da tabela];[número do campo]"</code>.
:# Consulta de zoom pode ser encontrada em <code>%CIGAM_INSTAL%Apoio/Geral/tabelas_cigam.xml</code>.

<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><filtros</span> <span style="color:red">order</span>=<span style="color:brown">"order by e.Cd_empresa"</span><span style="color:blue">></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"Empresa"</span> <span style="color:red">atrib</span>=<span style="color:brown">"A"</span> <span style="color:red">where</span>=<span style="color:brown">"e.Cd_empresa = '[value]'"</span> <span style="background-color:yellow"><span style="color:red">zoom</span>=<span style="color:brown">"2;1"</span></span> <span style="color:blue">/></span>
<span style="color:blue"></filtros></span>
<span style="color:blue"></pesquisaPaginada></span>

:🔹 '''Detalhes sobre <code>userTempFolder="true"</code>'''
::Quando informado com o valor <code>"true"</code>, o sistema considera que a localização dos arquivos XML e XSD será a '''pasta temporária do usuário no Windows'''.

::Para identificar essa pasta:
::# Pressione '''WIN + R''' para abrir a caixa '''Executar'''.
::# Digite <code>%TEMP%</code> e pressione '''Enter'''.
::# O '''Windows Explorer''' abrirá diretamente na pasta temporária.

::Os arquivos XML e XSD devem seguir o padrão de exportação de '''DataSet''' do '''.NET Framework''' e podem ser facilmente gerados usando os métodos:
:::* <code>WriteXml</code>
:::* <code>WriteXmlSchema</code>

:: 💡 '''Dica:'''
::: Para facilitar a criação dos modelos, gere os arquivos a partir de um '''DataTable já populado''', assim a estrutura e dados ficam prontos para testes.

==== <font color=green>Como habilitar o limitador de registro</font> ====
: ℹ️ <ref group="Versão 211104 RC" name="multiple">Liberado a partir da OS 373456/330.</ref> Ao utilizar <code>limiteRegistros</code>, o sistema retorna no máximo a quantidade informada, mesmo que a consulta SQL traga mais resultados. Isso é útil para melhorar o desempenho e evitar sobrecarga no carregamento inicial.

::'''Exemplo:'''
<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><select</span> <span style="color:red">paginacao</span>=<span style="color:brown">"0"</span> <span style="color:red">initFolder</span>=<span style="color:brown">"P"</span> <span style="background-color:yellow"><span style="color:red">limiteRegistros</span>=<span style="color:brown">"100"</span></span> <span style="color:blue">></span>
...
<span style="color:blue"></select></span>
<span style="color:blue"></pesquisaPaginada></span>

{{VoltarInicio}}

===5. Elemento <code><grid></code>===
Define a grade de exibição dos resultados na Pesquisa Dinâmica, controlando quais colunas serão apresentadas e como cada dado será formatado.

<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><grid></span>
...
<span style="color:blue"></grid></span>
<span style="color:blue"></pesquisaPaginada></span>

: O elemento <code><grid></code> dentro de <code><pesquisaPaginada></code> representa a '''grade de resultados''' da pesquisa.
: O conteúdo e a formatação podem ser definidos diretamente dentro dele.

:💡 '''Importante:''' Todas as colunas que são selecionadas na área de <code><select></code> do modelo de pesquisa dinâmica '''precisam obrigatoriamente constar na área do''' <code><grid></code> do modelo, garantindo consistência entre a consulta e a exibição.

: Exemplo de estrutura do <code><select></code>:
<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><select</span> <span style="color:red">paginacao</span>=<span style="color:brown">"0"</span> <span style="color:red">initFolder</span>=<span style="color:brown">"P"</span><span style="color:blue">></span>
SELECT
i.Id_integracao as <span style="background-color:yellow">"Id integração"</span>,
i.Dt_integracao as <span style="background-color:yellow">"Integração"</span>,
{2}CGFC_SECONDS_TO_TIME(i.Hr_integracao,4) as <span style="background-color:yellow">"Hr integração"</span>
FROM /*nl<GEINTEGRADORLOG>*/ i {0}
LEFT JOIN /*nl<GEUSUARIO>*/ u {0} on
i.usu_integracao = u.Cd_usuario
<span style="color:blue"></select></span>
<span style="color:blue"></pesquisaPaginada></span>

: Exemplo correspondente do <code><grid></code>:
<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><grid></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="background-color:yellow"><span style="color:brown">"Id integração"</span></span> <span style="color:red">headerFilter</span>=<span style="color:brown">"Y"</span> <span style="color:red">columnWidth</span>=<span style="color:brown">"100"</span><span style="color:blue"> /></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="background-color:yellow"><span style="color:brown">"Integração"</span></span> <span style="color:red">headerFilter</span>=<span style="color:brown">"Y"</span> <span style="color:red">columnWidth</span>=<span style="color:brown">"100"</span><span style="color:blue"> /></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="background-color:yellow"><span style="color:brown">"Hr integração"</span></span> <span style="color:red">headerFilter</span>=<span style="color:brown">"Y"</span> <span style="color:red">columnWidth</span>=<span style="color:brown">"100"</span><span style="color:blue"> /></span>
<span style="color:blue"></grid></span>
<span style="color:blue"></pesquisaPaginada></span>

: '''Validação de consistência:'''
:: Se houver divergência entre as colunas definidas no <code><select></code> e as definidas no <code><grid></code>, a seguinte mensagem será exibida ao usuário:
[[Image:MensagemPD.jpg|center|450px|semmoldura|Mensagem da Pesquisa Dinâmica]]

==== <font color=green>Como personalizar os filtros de colunas dentro da Pesquisa Dinâmica</font> ====
: ℹ️ O atributo <code>headerFilter</code> define a disponibilidade de filtros para os resultados exibidos em uma coluna específica:
::* <code>"Y"</code> = Permite que o usuário aplique filtros aos resultados exibidos nessa coluna.
::* <code>"N"</code> = Os filtros de coluna não são mostrados, resultando em uma exibição direta dos dados.

:'''Exemplo de configuração:'''
<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><grid></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"Nome"</span> <span style="background-color:yellow"><span style="color:red">headerFilter</span>=<span style="color:brown">"Y"</span></span> />
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"Fantasia"</span> <span style="background-color:yellow"><span style="color:red">headerFilter</span>=<span style="color:brown">"N"</span></span> />
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"Município"</span> <span style="background-color:yellow"><span style="color:red">headerFilter</span>=<span style="color:brown">"Y"</span></span> />
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"CEP</span> <span style="color:red">format</span>=<span style="color:brown">"00000-000"</span> />
<span style="color:blue"></grid></span>
<span style="color:blue"></pesquisaPaginada></span>

:💡 '''Observação:'''
::O filtro de coluna é aplicado apenas aos registros carregados na tela. Para filtrar '''todos os registros disponíveis''', é necessário clicar no ícone ''''Última página'''', garantindo que todos os dados sejam carregados antes de aplicar o filtro. Essa abordagem assegura que nenhuma informação relevante seja deixada de fora, proporcionando resultados mais completos e precisos para o usuário.

[[Image:FiltroColuna.png|center|750px|semmoldura|Filtro de Coluna]]
{{VoltarInicio}}

===6. Elemento <code><lupa></code>===
Define os modelos de visão rápida usados para exibir informações detalhadas ou resumidas de um registro na Pesquisa Dinâmica.

<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><lupa></span>
<span style="color:blue"><modelo</span> <span style="color:red">arquivo</span>=<span style="color:brown">"CG02075_Empresas.rtf"</span> <span style="color:blue">/></span>
<span style="color:blue"><modelo</span> <span style="color:red">arquivo</span>=<span style="color:brown">"CG02075_Empresas_PF.rtf"</span> <span style="color:red">tag</span>=<span style="color:brown">"Pessoa"</span> <span style="color:red">valor</span>=<span style="color:brown">"Física"</span> <span style="color:blue">/></span>
<span style="color:blue"></lupa></span>
<span style="color:blue"></pesquisaPaginada></span>

[[File:Lupa.png|thumb|Visão rápida]]
<br>
:O elemento <code><lupa></code> permite definir o caminho do '''arquivo de visão rápida''' que será utilizado para exibir informações resumidas ou detalhadas de um registro ao usuário.

:💡 '''Importante:''' É possível apontar mais de um modelo de arquivo de visão rápida, separando-os conforme a necessidade.
<br>

===7. Elementos <code><faixa></code> e <code><filtros></code>===
Permitem agrupar, ordenar e filtrar os registros exibidos na Pesquisa Dinâmica, oferecendo ao usuário maior controle sobre os resultados.

<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><faixa</span> <span style="color:red">nome</span>=<span style="color:brown">"Pessoa"</span> <span style="color:blue">></span>
...
<span style="color:blue"></faixa></span>

<span style="color:blue"><faixa</span> <span style="color:red">order</span>=<span style="color:brown">"order by 3"</span> <span style="color:blue">></span>
...
<span style="color:blue"></faixa></span>

<span style="color:blue"><filtros</span> <span style="color:red">order</span>=<span style="color:brown">"order by 3"</span> <span style="color:blue">></span>
...
<span style="color:blue"></filtros></span>
<span style="color:blue"></pesquisaPaginada></span>

[[File:ModeloPD_iniciarFaixa.png|150px|thumb|Faixa]]
:Dentro de <code><pesquisaPaginada></code>, os elementos <code><faixa></code> e <code><filtros></code> são usados para organizar e limitar os resultados da pesquisa dinâmica.
:🔹 <code><faixa></code>
::* '''Função:''' delimita ou agrupa registros conforme um critério.
::* '''Atributo <code>order</code>:''' define a coluna pela qual os registros serão ordenados.
:::* <code>order by 1</code> → ordena pela primeira coluna do SELECT.
:::* <code>order by 2</code> → ordena pela segunda coluna, e assim por diante.
<br><br>

:: 📌 '''Exemplo de faixa ordenada:'''
<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><faixa</span> <span style="color:red">nome</span>=<span style="color:brown">"Pessoa"</span><span style="color:blue">></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"Todos"</span> <span style="color:red">order</span>=<span style="background-color:yellow"><span style="color:brown">"order by 3"</span></span> <span style="color:blue">/></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"Física"</span> <span style="color:red">where</span>=<span style="color:brown">"e.Pessoa = 1"</span> <span style="color:red">order</span>=<span style="background-color:yellow"><span style="color:brown">"order by 3"</span></span> <span style="color:blue">/></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"Jurídica"</span> <span style="color:red">where</span>=<span style="color:brown">"e.Pessoa = 0"</span> <span style="color:red">order</span>=<span style="background-color:yellow"><span style="color:brown">"order by 3"</span></span> <span style="color:blue">/></span>
<span style="color:blue"></faixa></span>

<span style="color:blue"><faixa</span> <span style="background-color:yellow"><span style="color:red">order</span>=<span style="color:brown">"order by 3"</span></span> <span style="color:blue">></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"Divisão"</span>
<span style="color:red">select</span>=<span style="color:brown">"select Divisao, Descricao_divis from /*n1<GEDIVISAO>*/ {0} <span style="background-color:yellow">order by 2</span></span><span style="color:brown">"</span>
<span style="color:red">where</span>=<span style="color:brown">"e.Divisao = '[divisao]'"</span>
<span style="color:red">display</span>=<span style="color:brown">"Descricao_divis"</span><span style="color:blue">/></span>
<span style="color:blue"></faixa></span>
<span style="color:blue"></pesquisaPaginada></span>

[[Image:ModeloPD_iniciarPesquisar.png|150px|thumb|Pesquisar]]
:🔹 <code><filtros></code>
::* '''Função:''' define critérios para filtrar os resultados.
::* '''Atributo <code>order</code>:''' funciona como no <code><faixa></code> (ordenação pela posição da coluna).

:: 📌 '''Exemplo de filtro simples:'''
<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><filtros</span> <span style="background-color:yellow"><span style="color:red">order</span>=<span style="color:brown">"order by 3"</span></span> <span style="color:blue">></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"CNPJ/CPF"</span> <span style="color:red">atrib</span>=<span style="color:brown">"A"</span> <span style="color:red">where</span>=<span style="color:brown">"e.Cnpj_cpf like '[value]%'"</span> <span style="color:blue">/></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"Nome"</span> <span style="color:red">atrib</span>=<span style="color:brown">"A"</span> <span style="color:red">where</span>=<span style="color:brown">"e.Nome_completo like '%[value]%'"</span> <span style="color:blue">/></span>
<span style="color:blue"></filtros></span>
<span style="color:blue"></pesquisaPaginada></span>

==== <font color=green>Como ordenar uma listagem</font> ====
: ℹ️ <ref group="Versão 221107Beta">Liberado a partir da OS 778096/37</ref> Em alguns casos, especialmente quando se deseja '''ordenar alfabeticamente dados que possuem acentuação''', é necessário um tratamento especial para que o resultado não seja afetado por diferenças de acentos ou caracteres especiais.

: '''Ordenação com acentuação no Oracle'''
:: Para '''Oracle''', utilize o <code>NLSSORT</code> no <code>order by</code> dentro do atributo <code>select</code> da tag <code><item></code>:

<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><faixa</span> <span style="color:red">order</span>=<span style="color:brown">"order by 3"</span> <span style="color:blue">></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"Divisão"</span> <span style="color:red">select=</span><span style="color:brown">"select Divisao, Descricao_divis from /*nl<GEDIVISAO>*/ {0}
<span style="background-color:yellow">order by {11}NLSSORT(Descricao_divis, 'NLS_SORT=LATIN_AI'){12} {13}2{14}</span></span>
<span style="color:red">where</span>=<span style="color:brown">"e.Divisao = '[divisao]'"</span> <span style="color:red">display</span>=<span style="color:brown">"Descricao_divis"</span> <span style="color:brown">"</span> <span style="color:blue">/></span>
<span style="color:blue"></faixa></span>
<span style="color:blue"></pesquisaPaginada></span>

:: '''Explicação dos parâmetros:'''
:::* '''Oracle:''' executa <code>NLSSORT(Descricao_divis, 'NLS_SORT=LATIN_AI')</code> e ignora o <code>2</code> comentado.
:::* '''MSSQL:''' ignora o <code>NLSSORT</code> comentado e ordena pela '''segunda coluna''' <code>(2)</code> do select.

: '''Compatibilidade entre bancos de dados'''
:: Usando esse modelo, '''um único XML funciona tanto para Oracle quanto para MSSQL''':
:::* Oracle → ordena '''alfabeticamente ignorando acentos'''.
:::* MSSQL → ordena pela '''posição da coluna''', sem gerar erro de função inexistente.

==== <font color=green>Como utilizar dados nos filtros</font> ====
:* O valor do filtro deve ser '''usado exatamente como informado pelo usuário'''.
:* Para variações de sintaxe conforme o banco de dados, deverá ser considerado também que somente o valor do filtro será dinâmico. Por exemplo:
::* Se o filtro for do tipo '''alpha''', coloque o valor '''entre aspas''' na consulta SQL.
:* Para variações de sintaxe conforme o banco de dados, deverá ser considerado também que somente o valor do filtro será dinâmico. Por exemplo:
::* Se o filtro for do tipo '''data''', respeite a sintaxe de cada banco:
:::* '''SQL Server:''' <code>Convert(datetime,'[value]',103)</code>
:::* '''Oracle:''' <code>To_date('[value]', 'dd/MM/yyyy')</code>

==== <font color=green>Compatibilidade entre bancos de dados</font> ====
: ℹ️ O atributo <code>validate="DB"</code> permite que o mesmo XML funcione em diferentes bancos de dados, ajustando automaticamente a conversão de datas.

: 📌 '''Exemplo de filtro de data compatível:'''
<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><filtros</span> <span style="color:red">order</span>=<span style="color:brown">"order by"</span> <span style="color:blue">></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"Vencimento"</span> <span style="color:red">atrib</span>=<span style="color:brown">"A"</span> <span style="color:red">where</span>=<span style="color:brown">"lc.Dt_vencimento = '[value]'"</span> <span style="color:red">format</span>=<span style="color:brown">"00/00/0000"</span> <span style="background-color:yellow">validate="DB"</span> <span style="color:blue">/></span>
<span style="color:blue"></filtros></span>
<span style="color:blue"></pesquisaPaginada></span>

==== <font color=green>Como configurar um valor inicial para um filtro</font> ====
: ℹ️ O valor inicial pode ser configurado com o atributo <code>init</code>, de acordo com o tipo de filtro.

<center>
{| class="wikitable mw-collapsible sortable" border="0" cellpadding="5" cellspacing="0" style="width: 650px;"
! Tipo de filtro !! Exemplo de `init` !! Resultado inicial
|-
| Alpha (texto) || <code>"MARIA"</code> || Campo já vem preenchido com "MARIA"
|-
| Data atual || <code>"[dataAtual]"</code> || Campo já vem preenchido com a data do dia
|-
| Data relativa || <code>"[dataAtual] - 365"</code> || Data de 1 ano atrás
|}
</center>

: 📌 '''Exemplo com texto fixo:''' Ao abrir a pesquisa, o filtro já vem preenchido com "MARIA".
<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><filtros</span> <span style="color:red">order</span>=<span style="color:brown">"order by"</span> <span style="color:blue">></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"Nome"</span> <span style="color:red">atrib</span>=<span style="color:brown">"A"</span> <span style="color:red">where</span>=<span style="color:brown">"e.Nome_completo like '%[value]%'"</span> <span style="background-color:yellow">init="MARIA"</span> <span style="color:blue">/></span>
<span style="color:blue"></filtros></span>
<span style="color:blue"></pesquisaPaginada></span>

: 📌 '''Exemplo com data relativa:''' Considera registros a partir de '''um ano atrás''' e já abre com essa data preenchida no filtro.
<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><filtros</span> <span style="color:red">order</span>=<span style="color:brown">"order by"</span> <span style="color:blue">></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"Aniversario"</span> <span style="color:red">atrib</span>=<span style="color:brown">"D"</span> <span style="color:red">where</span>=<span style="color:brown">"e.Dt_aniversario >= '[value]'"</span> <span style="color:red">format</span>=<span style="color:brown">"00/00/0000"</span>
<span style="background-color:yellow">init="[dataAtual] - 365"</span> <span style="color:red">validate</span>=<span style="color:brown">"DB"</span> <span style="color:blue">/></span>
<span style="color:blue"></filtros></span>
<span style="color:blue"></pesquisaPaginada></span>

==== <font color=green>Como personalizar/definir um valor inicial para os filtros do tipo lista</font> ====
:* Por padrão, o valor inicial é '''"Todos"''', que é o valor default.
:* '''Não é possível alterar''' o valor inicial diretamente no XML.

[[Image:PD_filtros.jpg|semmoldura|center|Filtro Pesquisa Dinâmica]]

==== <font color=green>Qual a função do atributo <code>VALIDATE</code></font> ====
: ℹ️ Controla a validação dos valores informados no filtro.
: Quando, na pesquisa de NF da "Pesquisa Dinâmica de Lançamentos", o campo de NF tiver '''mais de 10 dígitos''', configure na tag <code><filtros></code> o atributo <code>validate="A"</code>.
: Para configurar o '''modelo financeiro''', localize o arquivo <code>%CIGAM_INSTAL%Modelos\Pesquisas\Financeiro\"Lancamento.xml"</code>.

: '''Valores possíveis do atributo <code>validate</code>:'''
::* <code>DB</code> → Valida como '''data''' (date).
::* <code>N</code> → Valida como '''número''' (apenas NF com até 10 dígitos).
::* <code>A</code> → Valida como '''alfanumérico''' (NF com 10 ou 12 dígitos).

:📌 '''Exemplo - NF com 12 dígitos:'''

<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><filtros</span> <span style="color:red">order</span>=<span style="color:brown">"ORDER BY 2 DESC"</span> <span style="color:blue">></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"NF"</span> <span style="color:red">atrib</span>=<span style="color:brown">"N"</span> <span style="color:red">where</span>=<span style="color:brown">"lc.Nf = '[value]'"</span> <span style="color:red">format</span>=<span style="color:brown">"999999999999"</span> <span style="background-color:yellow"><span style="color:red">validate</span>=<span style="color:brown">"A"</span></span> <span style="color:blue">/></span>
<span style="color:blue"></filtros></span>
<span style="color:blue"></pesquisaPaginada></span>

==== <font color=green>Qual a função do atributo <code>ATRIB</code></font> ====
: ℹ️ Define o '''tipo de dado''' aceito no campo. Quando utilizado como filtro de texto, retorna ou atribui o tipo de dado:
::📌 Exemplo atrib="A" (dado alfa).
::: Possibilita informar um conjunto de caracteres com caracteres alfabéticos (A-Z) e numerais (0-9).

<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><filtros</span> <span style="color:red">order</span>=<span style="color:brown">"order by 3"</span> <span style="color:blue">></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"Nome"</span> <span style="background-color:yellow"><span style="color:red">atrib</span>=<span style="color:brown">"A"</span></span> <span style="color:red">where</span>=<span style="color:brown">"e.Nome_completo like '%[value]%'"</span> <span style="color:blue">/></span>
<span style="color:blue"></filtros></span>
<span style="color:blue"></pesquisaPaginada></span>

::📌 Exemplo atrib="D" (dado date).
::: Possibilita informar uma data específica.

<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><filtros</span> <span style="color:red">order</span>=<span style="color:brown">"order by 3"</span> <span style="color:blue">></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"Aniversario"</span> <span style="background-color:yellow"><span style="color:red">atrib</span>=<span style="color:brown">"D"</span></span> <span style="color:red">where</span>=<span style="color:brown">"e.Dt_aniversario >= '[value]'"</span> <span style="color:red">format</span>=<span style="color:brown">"00/00/0000"</span>
<span style="color:red">init</span>=<span style="color:brown">"[dataAtual]"</span> <span style="color:red">validate</span>=<span style="color:brown">"DB"</span> <span style="color:blue">/></span>
<span style="color:blue"></filtros></span>
<span style="color:blue"></pesquisaPaginada></span>

::📌 Exemplo atrib="L" (dado Booleano/Checkbox).
::: Possibilita marcar verdadeiro ou falso seu valor.

<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><filtros</span> <span style="color:red">order</span>=<span style="color:brown">"order by 3"</span> <span style="color:blue">></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"Aglutinar Saldo"</span> <span style="background-color:yellow"><span style="color:red">atrib</span>=<span style="color:brown">"L"</span></span> <span style="color:red">paramName</span>=<span style="color:brown">"AglutinaSaldo"</span> <span style="color:blue">/></span>
<span style="color:blue"></filtros></span>
<span style="color:blue"></pesquisaPaginada></span>

::📌 Exemplo atrib="N" (dado numérico).
::: Possibilita informar um conjunto de numerais (0-9) decimais, podendo incluir negativos <ref group="Versão 231002">Liberado a partir da OS 822627/4.</ref>

<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><filtros</span> <span style="color:red">order</span>=<span style="color:brown">"order by 2 desc"</span> <span style="color:blue">></span>
<span style="color:blue"><item</span> <span style="color:red">nome</span>=<span style="color:brown">"Valor"</span> <span style="background-color:yellow"><span style="color:red">atrib</span>=<span style="color:brown">"N"</span></span> <span style="color:red">where</span>=<span style="color:brown">"lc.Valor = '[value]'"</span> <span style="color:blue">/></span>
<span style="color:blue"></filtros></span>
<span style="color:blue"></pesquisaPaginada></span>

<gallery mode="slideshow">
Arquivo:Atrib_A.png|500px|semmoldura|center|''Atrib="A"''
Arquivo:Atrib_D.png|500px|semmoldura|center|''Atrib="D"''
Arquivo:Atrib_L.jpg|700px|semmoldura|center|''Atrib="L"''
Arquivo:Atrib_N.png|400px|semmoldura|center|''Atrib="N"''
</gallery>

{{VoltarInicio}}

===8. Elemento <code><mosaicos></code>===
Exibe os registros da Pesquisa Dinâmica em formato de mosaicos ou cards, oferecendo uma visualização intuitiva e organizada para destacar informações de forma prática.

<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><mosaicos</span> <span style="color:red">width</span>=<span style="color:brown">"500"</span> <span style="color:red">height</span>=<span style="color:brown">"160"</span> <span style="color:red">color</span>=<span style="color:brown">"48;125;162"</span> <span style="color:red">maxRender</span>=<span style="color:brown">"300"</span> <span style="color:red">clickAction</span>=<span style="color:brown">"M"</span> <span style="color:red">allPages</span>=<span style="color:brown">"false"</span> <span style="color:blue">></span>
...
<span style="color:blue"></mosaicos></span>
<span style="color:blue"></pesquisaPaginada></span>

: O elemento <code><mosaicos></code> configura a exibição dos registros no formato '''mosaico''' (cards/blocos) na '''Pesquisa Dinâmica'''.
: Quando essa tag existe no XML, o parser exibirá na barra superior um botão para alternar entre '''visualização em grid''' e '''visualização em mosaico'''.

: Cada registro da consulta é renderizado como '''um mosaico'''.
: Os '''atributos da tag principal''' definem o layout geral, enquanto as '''tags filhas''' especificam o conteúdo interno do mosaico.

: 📌 '''Exemplo de uso:'''
<span style="color:blue"><pesquisaPaginada></span>
<span style="color:blue"><mosaicos</span> <span style="color:red">width</span>=<span style="color:brown">"500"</span> <span style="color:red">height</span>=<span style="color:brown">"160"</span> <span style="color:red">color</span>=<span style="color:brown">"48;125;162"</span> <span style="color:red">maxRender</span>=<span style="color:brown">"300"</span> <span style="color:red">clickAction</span>=<span style="color:brown">"M"</span> <span style="color:red">allPages</span>=<span style="color:brown">"false"</span> <span style="color:blue">></span>
<span style="color:blue"><label</span> <span style="color:red">display</span>=<span style="color:brown">"Nome completo:"</span> <span style="color:red">x</span>=<span style="color:brown">"100"</span> <span style="color:red">y</span>=<span style="color:brown">"10"</span> <span style="color:red">size</span>=<span style="color:brown">"12"</span> <span style="color:red">color</span>=<span style="color:brown">"255;255;255"</span> <span style="color:blue">/></span>
<span style="color:blue"><label</span> <span style="color:red">display</span>=<span style="color:brown">"@Nome"</span> <span style="color:red">x</span>=<span style="color:brown">"100"</span> <span style="color:red">y</span>=<span style="color:brown">"30"</span> <span style="color:red">size</span>=<span style="color:brown">"14"</span> <span style="color:red">color</span>=<span style="color:brown">"255;255;255"</span> <span style="color:blue">/></span>
<span style="color:blue"><label</span> <span style="color:red">display</span>=<span style="color:brown">"@Fantasia"</span> <span style="color:red">x</span>=<span style="color:brown">"100"</span> <span style="color:red">y</span>=<span style="color:brown">"56"</span> <span style="color:red">size</span>=<span style="color:brown">"14"</span> <span style="color:red">color</span>=<span style="color:brown">"255;255;255"</span> <span style="color:blue">/></span>
<span style="color:blue"><label</span> <span style="color:red">display</span>=<span style="color:brown">"Telefone:"</span> <span style="color:red">x</span>=<span style="color:brown">"100"</span> <span style="color:red">y</span>=<span style="color:brown">"90"</span> <span style="color:red">size</span>=<span style="color:brown">"12"</span> <span style="color:red">color</span>=<span style="color:brown">"255;255;255"</span> <span style="color:blue">/></span>
<span style="color:blue"><label</span> <span style="color:red">display</span>=<span style="color:brown">"@Fone"</span> <span style="color:red">x</span>=<span style="color:brown">"100"</span> <span style="color:red">y</span>=<span style="color:brown">"100"</span> <span style="color:red">size</span>=<span style="color:brown">"25"</span> <span style="color:red">color</span>=<span style="color:brown">"250;250;250"</span> <span style="color:blue">/></span>
<span style="color:blue"><picture</span> <span style="color:red">file</span>=<span style="color:brown">"Foto"</span> <span style="color:red">x</span>=<span style="color:brown">"5"</span> <span style="color:red">y</span>=<span style="color:brown">"5"</span> <span style="color:red">width</span>=<span style="color:brown">"90"</span> <span style="color:red">height</span>=<span style="color:brown">"90"</span> <span style="color:red">circular</span>=<span style="color:brown">"true"</span> <span style="color:blue">/></span>
<span style="color:blue"></mosaicos></span>
<span style="color:blue"></pesquisaPaginada></span>

: '''Atributos da tag <code><mosaicos></code>:'''
<center>
{| class="wikitable mw-collapsible sortable" border="0" cellpadding="5" cellspacing="0" style="width: 750px;"
!Atributo!!Descrição
|-
| '''width''' || Largura do mosaico (em px).
|-
| '''height''' || Altura do mosaico (em px).
|-
| '''color''' || Cor de fundo do mosaico no formato '''RGB''' separado por <code>;</code>. Ex.: <code>"204;204;255"</code>.
|-
| '''maxRender''' || Quantidade máxima de mosaicos renderizados na tela.
|-
| '''clickAction''' || Ação ao clicar no mosaico: <code>"M"</code> para modificar ou <code>"V"</code> para visualizar.
|-
| '''allPages''' || <code>"true"</code> para carregar todos os registros antes de exibir mosaicos (equivalente a clicar no botão '''Última página'''). <code>"false"</code> carrega apenas a página atual.
|}
</center>

: '''Tags filhas de <code><mosaicos></code>'''
::'''1.''' <code><label></code>
::: Exibe texto dentro do mosaico.
<center>
{| class="wikitable mw-collapsible sortable" border="0" cellpadding="5" cellspacing="0" style="width: 750px;"
!Atributo!!Descrição
|-
| '''display''' || Texto exibido. Se começar com <code>@</code>, pega o valor da coluna da consulta.
|-
| '''x, y''' || Posição do texto no mosaico.
|-
| '''size''' || Tamanho da fonte.
|-
| '''color''' || Cor do texto no formato RGB <code>("R;G;B")</code>.
|}
</center>

::'''2.''' <code><picture></code>
::: Exibe imagens no mosaico.
<center>
{| class="wikitable mw-collapsible sortable" border="0" cellpadding="5" cellspacing="0" style="width: 750px;"
!Atributo!!Descrição
|-
| '''file''' || Nome da coluna da consulta que contém o caminho da imagem.
|-
| '''x, y''' || Posição da imagem no mosaico.
|-
| '''width, height''' || Tamanho da imagem (em px).
|-
| '''circular''' || <code>"true"</code> para moldura circular, </code>"false"</code> para moldura retangular.
|}
</center>

:💡 '''Dicas'''
::* Para encontrar valores RGB rapidamente, use o '''Paint do Windows''' ou qualquer editor de imagens.
::* Utilize <code>maxRender</code> para evitar lentidão ao carregar grandes volumes de dados.
::* O texto de busca (cuetext) indica se é necessário '''pressionar Enter''' para aplicar o filtro.

: '''Funcionamento do mosaico'''
::'''1. Carregamento'''
:::* Se a quantidade de registros for maior que <code>maxRender</code>, apenas esse número será exibido e uma mensagem será mostrada no topo. Ex. Exibindo os primeiros 300 registros
:::* Se <code>allPages="true"</code>, todos os registros serão carregados antes de montar os mosaicos.

::'''2. Refinamento da pesquisa'''
:::* Se o número de mosaicos ≤ <code>maxRender</code>, a pesquisa é aplicada '''a cada caractere digitado''' no campo de busca.
:::* Se o número de mosaicos > <code>maxRender</code>, é necessário '''pressionar Enter''' para aplicar o filtro.

::'''3. Busca'''
:::* O filtro de busca atua apenas sobre os textos exibidos nos '''labels''' dos mosaicos.

::'''4. Seleção e ações'''
:::* Clique com o botão direito para selecionar um mosaico.
:::* Os botões '''Selecionar''', '''Visualizar''' e '''Modificar''' são ativados para o mosaico marcado.
:::* A seleção é '''individual''' (ao selecionar um novo mosaico, o anterior é desmarcado).
{{VoltarInicio}}

== Como a Pesquisa Dinâmica é iniciada ==
: Após a parametrização, os filtros são carregados conforme definido no XML vinculado. Ao selecionar um novo filtro, o filtro anteriormente aberto é automaticamente fechado, garantindo que apenas um filtro permaneça ativo por vez.

== Como criar uma seleção de filtros dinâmicos ==
: ℹ️ <ref group="Versão 221107Beta">Liberado a partir da OS 373456/357</ref>
: A Pesquisa Dinâmica disponibiliza a funcionalidade '''Filtros Dinâmicos''', acionada pelo comando '''Ctrl + R''' dentro do grid. Esta funcionalidade permite a inclusão de filtros temporários no painel lateral esquerdo, proporcionando maior flexibilidade na seleção de informações sem alterar o modelo base definido no XML.
::* '''Inclusão de campos:''' somente um campo pode ser adicionado por vez.
::* '''Remoção de campos:''' a exclusão dos filtros adicionados deve ser realizada por meio do botão '''Remover todos'''.
::* '''Restauração do estado inicial:''' ao encerrar e reabrir a Pesquisa Dinâmica, os filtros retornam ao estado original, conforme definido no XML.

:'''Observações relativas a campos numéricos'''
: ℹ️ <ref group="Versão 221107.c">Liberado a partir da OS 801551/2</ref> <ref group="Versão 230502">Liberado a partir da OS 801551/2</ref>
: A partir destas versões, os filtros dinâmicos do tipo '''numérico''' permitem a inserção de valores decimais, sendo aceita a utilização da '''vírgula''' como separador decimal.
<br>
[[Arquivo:PDFiltrosDinamicos.jpg|500x400px|semmoldura|center|Filtros Dinâmicos]]
<br>

: 💡 Consulte também: ''[[Filtros temporários na Pesquisa Dinâmica - Filtros Dinâmicos|Como adicionar filtros temporários na Pesquisa Dinâmica]]''

== Comportamento dos botões na Pesquisa Dinâmica ==
<ref group="Versão 231002">Liberado a partir da OS 789385/1.</ref> As funcionalidades dos botões '''Visualizar''', '''Modificar''' e '''Criar''' na Pesquisa Dinâmica são descritas a seguir:

:'''Botão Visualizar'''
:* Abre o registro selecionado em '''modo "Pesquisar"'''.
:* Não permite a transição para os modos '''"Modificar"''' ou '''"Criar"'''.
:* Ao ser acionado, entra em '''range/faixa''' sobre o registro selecionado, respeitando o valor definido no parâmetro <code>acaoVisualizar</code> do modelo da Pesquisa Dinâmica:
::* <code>L</code> → Locate / Localizar
::* <code>F</code> → Range / Faixa

:'''Botão Modificar'''
:* Abre o registro selecionado em '''modo "Modificar"'''.
:* Permite transições para os modos '''"Criar"''' e '''"Pesquisar"'''.
:* Ao retornar à tela da Pesquisa Dinâmica após a modificação, o sistema mantém o foco no registro previamente selecionado antes de acionar o botão '''Modificar'''.
:* Entra em '''range/faixa''' sobre o registro selecionado.
:* '''Importante:''' Ao criar um novo registro a partir do modo "Modificar", este estará fora do '''range/faixa''' e não será visualizado imediatamente. O registro será exibido apenas ao retornar ao grid da Pesquisa Dinâmica. Caso esteja no modo "Criar", é possível retornar ao modo "Pesquisar", mantendo o foco no registro previamente selecionado.

:'''Botão Criar'''
:* Abre o registro selecionado em '''modo "Criar"'''.
:* Permite transições para os modos '''"Modificar"''' e '''"Pesquisar"'''.
:* Após a criação de um registro, o cursor será posicionado no início do grid da Pesquisa Dinâmica.
:* O novo registro será exibido no grid conforme a ordenação definida pelo '''Order by''' do modelo, com a linha de seleção localizada no topo do grid.
{{VoltarInicio}}

=Pesquisa Dinâmica Web=
A Pesquisa Dinâmica Web tem como objetivo levar às aplicações Web as funcionalidades presentes na Pesquisa Dinâmica Cigam Desktop.<br>
Os filtros utilizados para realizar a pesquisa são definidos no arquivo XML, seguindo a lógica de tratamento de busca e criação da lista dos filtros usada no Cigam Desktop, porém acrescentando o elemento <web>.

==Como cadastrar a pesquisa dinâmica web==
O cadastro do modelo será feito mantendo o padrão já existente para os modelos de Pesquisas, do Olap e dos Filtros, através do perfil do usuário.<br>
Veja mais informação no tópico “[[GE_-_Como_Fazer_-_Pesquisa_Din%C3%A2mica#Como_fazer_o_cadastro/altera%C3%A7%C3%A3o_dos_Modelos_Pesquisa_Din%C3%A2mica_(Desktop_e_Web)_e_Modelos_de_Filtros|4. Como fazer o cadastro/alteração dos Modelos Pesquisa Dinâmica (Desktop e Web) e Modelos de Filtros]]”.

==Como montar a pesquisa dinâmica para utilização na WEB==
Para a criação do arquivo XML da PD Web, os mesmos elementos usados para a PD desktop serão aplicados, junto ao acréscimo do elemento <web>. Mais informações podem ser obtidas em “[[GE_-_Como_Fazer_-_Pesquisa_Din%C3%A2mica#Pesquisa_Din%C3%A2mica_Desktop|1. Pesquisa Dinâmica Desktop]]”.
<br>
[[Image:modeloPDWeb.png|semmoldura|center|850px|Modelo Pesquisa]]
<br>
O elemento <web>, terá os seguintes atributos:
:*O atributo <font color=red>"paginacao"</font>, possibilita o controle de paginação da consulta, permitindo a exibição da quantidade selecionada de registros por página. Se esta propriedade não for informada no modelo XML, o valor padrão aplicado é de "10".
<web <font color=red>paginacao="5"</font> construtorPesquisa="S">
<br>
:*O atributo <font color=red>"construtorPesquisa"</font> permite habilitar ou desabilitar a funcionalidade “Construtor de Pesquisa” da PD Web. Por padrão, ele estará habilitado, com valor "S"; no entanto, para desativá-lo, é necessário definir esse parâmetro como "N".
<web paginacao="5" <font color=red>construtorPesquisa="S"</font>>
:A seguir se apresenta uma imagem do "Construtor de Pesquisa":
<br>
[[Image:construtorPesquisa.png|semmoldura|center|850px|Modelo Pesquisa]]
<br>
Dentro do elemento <web> é criada uma seção <botoes>, onde cada botão é definido através de um “<item>” com os seguintes atributos:
:*O atributo <font color=red>"nome"</font> recebe um valor que será usado como o nome do botão a ser exibido na tela.
:*O atributo <font color=red>"login"</font> define se o token de autenticação será enviado automaticamente na solicitação da URL, possibilitando a realização do login sem interação manual no portal ou na URL acessada. Para ativar o login automático, deve-se atribuir o valor "S" ao atributo. Caso contrário, utilize o valor "N". Se o atributo não for informado, o valor padrão será "N", indicando que o login automático não será realizado.
<item <font color=red>nome="Criar"</font> visivel="S" <font color=red>login="S"</font> url="~/ge/pessoa/cadastro" campos="Empresa,Fantasia" />
<br>
:*O atributo <font color=red>"visivel"</font> define se o botão será exibido ou não na tela. Para tornar o botão visível, deve-se atribuir o valor "S"; caso contrário, o valor deve ser "N".
<item nome="Criar" <font color=red>visivel="S"</font> url="~/ge/pessoa/cadastro" campos="Empresa,Fantasia" />
<br>
:*O atributo <font color=red>“url”</font> recebe o endereço da URL que deverá ser acionada quando o botão for pressionado. A Pesquisa Dinâmica terá comportamentos diferentes conforme a URL informada, veja os exemplos abaixo:
<item nome="Criar" visivel="S" <font color=red>url="~/ge/pessoa/cadastro"</font> campos="Empresa,Fantasia" />
:*Caso seja necessário informar um portal diferente para o acesso, é possível utilizar uma chave dinâmica em vez de uma URL fixa. Isso elimina a necessidade de criar um modelo específico para cada base, permitindo maior flexibilidade. Por exemplo:
:Se estiver na Pesquisa Dinâmica no Portal Indústria e desejar redirecionar para o Portal CRM ao clicar em um botão, basta utilizar a chave dinâmica correspondente ao portal. Essas chaves serão montadas automaticamente com base nas configurações de ambiente: 3159 (UrlSiteBase) e 3160 (UrlSiteComplemento):
<item nome="Criar" visivel="S" login="S" <font color=red>url="[PORTAL_CRM]/ge/pessoa/cadastro/c/" </font> />
:Ao pressionar o botão, a chave dinâmica [PORTAL_CRM] será automaticamente substituída pelo endereço configurado no ambiente. Assim, o sistema fará o redirecionamento para a URL completa.<br>
:* Veja as chaves disponíveis para os portais:
:** [PORTAL_APROVACOES]
:** [PORTAL_CIGAM]
:** [PORTAL_CLIENTE]
:** [PORTAL_CRM]
:** [PORTAL_ERP]
:** [PORTAL_FORNECEDOR]
:** [PORTAL_REPRESENTANTE]
:** [PORTAL_SERVICOS]
:** [PORTAL_VAREJO]
:** [PORTAL_CLIENTESERVICOS]
:** [PORTAL_COMPRAS]
:** [PORTAL_FINANCEIRO]
:** [PORTAL_INDUSTRIA]
:** [PORTAL_RH]
:** [BI]
:** [API]
:** [PESQUISA_DINAMICA]

::*Quando a URL iniciar com o caractere “~”, isso sinaliza que seu uso é interno à aplicação ou portal em funcionamento. Então ocorrerá um redirecionamento automático, no qual o caractere será substituído pelo endereço da aplicação.
:::Observe o exemplo a seguir: <font color=red><item nome="Criar" visivel="S" url="~/ge/pessoa/cadastro" /></font>. Quando pressionado, o botão fará a substituição automática do caractere “~” por “cigam-web8:14620/portalvarejo/”, correspondente ao endereço atual de exemplo do portal em execução. E posteriormente, ocorrerá o redirecionamento com o endereço completo. Veja o resultado na imagem abaixo:
<br>
[[Image:UrlInterna.png|semmoldura|center|850px|Url Interna]]
<br>
::*Se a URL iniciar com “http://” ou “https://”, essa indicação implica que o destino da URL é externo à aplicação ou portal atual, ou seja, fora do contexto em execução. Isso resultará na abertura do endereço especificado na “url” em uma nova guia do navegador. Considere o exemplo a seguir: <font color=red><item nome="Cigam" visivel="S" url="www.cigam.com.br" /></font>. Então, assim que o botão correspondente for acionado, uma nova guia será aberta automaticamente, contendo o conteúdo da “url” informada. Veja esse exemplo na imagem abaixo:
<br>
[[Image:UrlExterna.png|semmoldura|center|850px|Url Externa]]
<br>
::*Quando for necessário fornecer um valor específico como parte da rota de um endereço, como um código de empresa para executar uma operação de alteração no cadastro, pode-se empregar o formato “/[Campo]” para indicar qual campo será enviado nessa rota. Para que isso funcione adequadamente, é igualmente necessário informar o campo corresponde no atributo “campos”. Para compreender melhor esse conceito, vejamos o exemplo: <font color=red><item nome="Modificar" visivel="S" url="~/ge/pessoa/cadastro/m/[Empresa]" campos="Empresa" /></font>.
:::Neste contexto, o usuário selecionou a empresa “Cigam Software de Gestão”:
<br>
[[Image:alteracaoCadEmp1.png|semmoldura|center|850px|Cadastro Empresa]]
<br>
:::E ao acionar o botão “Modificar”, o sistema realizará a substituição do marcador “[Empresa]” presente no atributo “url” pelo valor contido na coluna “Empresa” do atributo “campos”, que, neste exemplo, é “000001”. Consequentemente, ocorrerá o redirecionamento com o endereço informado realizando essa substituição:
<br>
[[Image:alteracaoCadEmp2.png|semmoldura|center|850px|Cadastro Empresa]]
<br>
::*Quando não houver uma URL especificada para o atributo “url”, o botão será desativado, resultando em sua inoperância. Uma mensagem de erro será exibida para indicar essa condição, como ilustrado na imagem a seguir:
<br>
[[Image:UrlNaoInformada.png|semmoldura|center|850px|Url Não Informada]]
<br>
:*O atributo <font color=red>"campos"</font> é responsável por enviar os campos e seus respectivos valores através dos parâmetros de URL, especificado pelo atributo “url”.
<item nome="Criar" visivel="S" url="~/ge/pessoa/cadastro" <font color=red>campos="Empresa,Fantasia"</font> />
::Neste exemplo, o usuário optou por selecionar o registro cuja empresa é “Cigam Software de Gestão”, e sua coluna “Empresa” tem o valor “000001” e, a coluna “Fantasia” com o valor “CIGAM”:
<br>
[[Image:exemploCamposPDWeb.png|semmoldura|center|850px|Modelo Pesquisa]]
<br>
::Quando o botão “Criar” for clicado, a URL “~/ge/pessoa/cadastro” será invocada, passando as informações de “Empresa” e “Fantasia” como parâmetros:
<br>
[[Image:exemploParametrosPDWeb.png|semmoldura|center|850px|Modelo Pesquisa]]
<br>
::'''Observação:''' '' Se for preciso enviar todos os campos como parâmetros na URL, basta inserir um asterisco (“*”) no atributo “campos”. Veja o exemplo a seguir: <font color=red><item nome="Cigam" visivel="S" url="www.cigam.com.br" campos="*"/></font>''
<br>
[[Image:parametrosCompletos.png|semmoldura|center|850px|Modelo Pesquisa]]
<br>
:*O atributo <font color=red>"parametros"</font> efetuará o envio de uma requisição (POST) para a URL indicada, transmitindo o conteúdo do atributo “campos” como parâmetros de URL. Isso, como já foi demonstrado. No entanto, essa ação ocorrerá agora por meio de um método “POST”, com os valores derivados do atributo “parametros”, com as credenciais do “Usuario” que se encontra autenticado na aplicação. Para realizar isso, é necessário fornecer o formato “parâmetro” + “:” + “valor”. Caso haja mais de um parâmetro, utilize a vírgula (“,”) como separador. Confira o exemplo abaixo:
<item nome="BI" visivel="S" url="cigam-web8:17530/BI/api/Integrador/ObterUrlIntegracao" campos="Empresa" <font color=red>parametros="IdDashboard:d41dcb3f-bc4f-4b16-9dfe-7cf10f1a8888"</font> />
::Neste exemplo, ao pressionar o botão “BI”, uma requisição será enviada para o sistema de BI. Essa solicitação incluirá a empresa “Cigam Software de Gestão” como um parâmetro na URL. Além disso, será enviado como variáveis (data), as informações do código do usuário atualmente logado no sistema, bem como os parâmetros especificados no atributo “parametros”:
<br>
[[Image:exemploBI1.png|semmoldura|center|850px|BI]]
<br>
::Como resultado, o BI responderá com uma nova URL contendo o painel desejado, que, por sua vez, será aberto em uma nova guia do navegador:
<br>
[[Image:exemploBI2.png|semmoldura|center|850px|BI]]
<br>

:*O atributo <font color=red>“zoom”</font>, quando informado, adiciona uma lupa ao campo. Na PD Web, essa lupa será responsável por abrir uma modal com os registros retornados pelo método da API configurado. A forma de montar essa estrutura deve ser a seguinte: “/api/<area>/<controller>/<metodo>”. Por exemplo, a chamada da API para buscar as unidades de negócio cadastradas deverá ser realizada por meio da seguinte estrutura: “/api/genericos/ge/UnidadeNegocio/Buscar”.<br>
::Este atributo oferece três opções de filtros OData: 'top', 'select' e 'filter'. Cada um destes traz seus próprios comportamentos e padrões:<br>
::*O “top” define a quantidade máxima de registros carregados inicialmente. Quando não for informado, será utilizado o limite padrão de 1000 registros. Quanto maior o valor configurado, maior poderá ser o tempo necessário para carregar a modal.<br>
::*O “select” pode ser usado para indicar quais colunas serão exibidas na modal. Quando não for especificada nenhuma coluna, a coluna "Código" será mostrada como padrão na modal.<br>
::*O “filter” quando informado, irá habilitar o botão de pesquisa que irá atualizar os registros de acordo com o que foi pesquisado/filtrado, criando uma requisição e carregando os valores atualizados. Desta forma, a pesquisa não mais se limitará aos 1000 registros padrão (ou valor escolhido) do modelo.<br>
::Se o “filter” não é informado, a pesquisa por novos registros é desativada.<br>
<br>
A seguir está um exemplo de URL que inclui todos os parâmetros de filtro disponíveis:

<item nome="Unidade de Negócio Inicial" atrib="A" paramName="UnidadeNegocioInicial"   <font color=red>zoom="/api/genericos/ge/UnidadeNegocio/Buscar?$top=1000&$select=Codigo,Nome,Fantasia&$filter=contains(Nome,[value])"</font>   columnName="Código,Nome,Fantasia" />
<br>
Ao montar corretamente o atributo "zoom", uma modal será exibida de acordo com o endereço URL especificado:
<br>
[[Image:Modelo_Pesquisa_Web_03.jpg|semmoldura|center|850px|Modelo Pesquisa]]
<br>
:*O atributo <font color=red>"columnName"</font> deverá ser utilizado em conjunto com o "select" para definir os títulos das colunas apresentadas na modal. Os títulos devem ser separados por vírgulas e seguir a mesma quantidade e ordem das propriedades informadas no "select".
<item nome="Unidade de Negócio Inicial" atrib="A" paramName="UnidadeNegocioInicial" zoom="/api/genericos/ge/UnidadeNegocio/Buscar?$top=1000&$select=Codigo,Nome,Fantasia&$filter=contains(Nome,[value])" <font color=red>columnName="Código,Nome,Fantasia"</font> />
<br>
::Ao selecionar um registro, será atribuído ao campo o valor da propriedade Codigo. Caso essa propriedade não exista no retorno da API, será utilizado o valor da primeira propriedade informada no "select".<br>

Ao montar o modelo corretamente e realizar o cadastro do perfil do usuário, a PD Web será exibida automaticamente.<br>
<br>
[[Image:PDWeb.png|semmoldura|center|850px|Modelo Pesquisa]]
<br>
'''Importante:''' ''Lembrando que para a Pesquisa Dinâmica Web será permitido somente a exibição de até 1000 registros. Esse controle se faz necessário pois existe uma limitação da capacidade de armazenamento na sessão web.''
{{VoltarInicio}}

==Botões fixos na pesquisa dinâmica web==
Os botões fixos sempre estarão habilitados, independente da configuração do modelo XML. Eles são os seguintes: “ᐳ", para carregar os próximos registros; "⨠", para carregar todos os registros; "Exportar" para exportar os dados; e “︾” para mostrar os filtros habilitados no Modelo da Pesquisa.
<br>
[[Image:Botoes_fixos.png|semmoldura|center|850px|Modelo Pesquisa]]
<br>
:*O botão "Exportar" realiza a exportação de todos os registros que estão carregados na tela. Uma variedade de formatos de arquivos diferentes está disponível para a exportação, incluindo CSV, Planilha, PDF e JSON. Basta selecionar o formato desejado para concluir a operação.
<br>
[[Image:btnExportar.png|semmoldura|center|850px|Modelo Pesquisa]]
<br>
::Selecionando o formato desejado, um arquivo é gerado na pasta de Downloads do navegador, tendo o mesmo nome do arquivo XML (modelo de pesquisa) para a geração do arquivo de exportação. No exemplo a seguir foi selecionado “CSV”:
<br>
[[Image:downloadBtnExportar.png|semmoldura|center|850px|Modelo Pesquisa]]
<br>
:*O botão “︾”, quando clicado, exibirá os filtros dinâmicos disponíveis para restringir os registros da tabela, de acordo com os valores inseridos nos campos. Esses campos de filtragem são apresentados com base na configuração prévia estabelecida no Modelo de Pesquisa (XML), através da tag <filtros>. Confira o exemplo abaixo:
<br>
[[Image:FiltrosWeb.png|semmoldura|center|850px|Filtros]]
<br>
::Uma vez ativado o botão, os filtros serão apresentados e os botões “Confirmar” (para aplicar a restrição da pesquisa) e “Limpar” (para redefinir os campos) serão habilitados:
<br>
[[Image:FiltrosHabilitados.png|semmoldura|center|850px|Filtros Habilitados]]
<br>
::No exemplo a seguir, o campo “Nome” foi filtrado com o valor “Cigam Software de Gestão” e, após pressionar o botão “Confirmar”, somente as empresas cujo nome corresponde ao filtro serão exibidas.
<br>
[[Image:FiltroAtivo.png|semmoldura|center|850px|Filtro Ativo]]
<br>
{{VoltarInicio}}

=Modelos de Filtros=
Modelos de filtros de relatórios é uma funcionalidade da Pesquisa Dinâmica (PD) na qual permite criar um modelo no formato XML com as definições para montagem da tela de preenchimento de filtros e execução do relatório.<br>
Essa opção está disponível para relatórios que geram arquivos de saída, preferencialmente no formato PDF, geralmente obtidos através de relatórios personalizados do Magic (Merge). Também é possível que outros formatos de arquivos sejam entregues por essa solução, bastando apenas que seja gerado na CDN.<br>
É muito importante, definir um nome sugestivo para o modelo de modo que se possa identificar o que tal relatório processa. Esse nome será usado em todas as camadas que serão implementadas.
{{VoltarInicio}}

==Criando o Modelo de Filtro==
A criação e cadastro do modelo será feito mantendo o padrão já existente para os modelos de Pesquisas, do Olap e da PD Desktop, através do perfil do usuário.<br>
Veja mais informação no tópico “[[GE_-_Como_Fazer_-_Pesquisa_Din%C3%A2mica#Como_fazer_o_cadastro/altera%C3%A7%C3%A3o_dos_Modelos_Pesquisa_Din%C3%A2mica_(Desktop_e_Web)_e_Modelos_de_Filtros|4. Como fazer o cadastro/alteração dos Modelos Pesquisa Dinâmica (Desktop e Web) e Modelos de Filtros]]”.<br>
<br>
[[Image:Modelo_Pesquisa_Web_01.jpg|semmoldura|center|850px|Modelo Pesquisa]]
<br>
Como padrão, são utilizados apenas os principais filtros na Web, porém são fornecidos em cada um dos respectivos modelos de filtros o restante dos filtros disponíveis em forma de comentário para que o usuário possa incluir conforme suas necessidades.<br>
<br>
[[Image:Modelo_Pesquisa_Web_02.jpg|semmoldura|center|850px|Modelo Pesquisa]]
<br>
O elemento <filtros> existente para a PD Desktop, também será utilizado na funcionalidade de modelos de filtros. Além de alguns adicionais:<br>
:*O atributo <font color=red>"empty"</font> verifica se a modal de confirmação será exibida quando todos os campos estiverem em branco. Por padrão, este valor sempre virá como "N", permitindo que a modal seja exibida. Caso não seja informado, este continuará como o padrão "N", e para desativar a modal, deve-se ajustar o parâmetro como "Y".<br>
<filtros order="1" <font color=red>empty="N"</font> model="Y">
<br>
[[Image:PD_empty.png|semmoldura|center|850px|Modelo Pesquisa]]
<br>
:*O atributo <font color=red>“model”</font> verifica se o relatório é do tipo personalizado/merge ou não. Seus valores podem ser “N” para desabilitar o cadastro de modelos (usado para relatórios do tipo Gráfico), ou “Y” para ativar os modelos de impressão (engrenagem).<br>
<filtros order="1" empty="N" <font color=red>model="Y"</font>>
<br>
[[Image:PD_model.png|semmoldura|center|850px|Modelo Pesquisa]]
<br>
O elemento <filtros> possui filtros individuais, cada um representado por um elemento <item>, contendo os atributos de tipo e parâmetro que incluirão todos os elementos já existentes da PD Desktop, com a diferença dos seguintes elementos:<br>
:*O atributo <font color=red>“atrib”</font> recebeu uma atualização que adiciona um novo formato de dado, o tipo “L”, permitindo que funcione como um Booleano/Checkbox. Assim, esse recurso possibilita marcar verdadeiro ou falso seu valor.<br>
<item nome="Aglutinar Saldo" <font color=red>atrib="L"</font> paramName="AglutinaSaldo" />
<br>
:*O atributo <font color=red>"init"</font> é utilizado para definir um valor inicial que será carregado automaticamente ao abrir um relatório. O valor deve ser informado de acordo com o tipo de filtro. No exemplo abaixo, o filtro é do tipo alfanumérico e o valor inicial definido é "01". Qualquer valor alfanumérico pode ser utilizado:
<item nome="Unidade de Negócio Inicial" atrib="A" paramName="UnidadeNegocioInicial" <font color=red>init="01"</font> />
:Nos filtros do tipo data, é possível utilizar comandos dinâmicos para preencher automaticamente os valores, facilitando a configuração dos parâmetros. Os comandos disponíveis são:
::*'''[DataAtual]''' – insere automaticamente a data atual.
::*'''[InicioMesAtual]''' – define a data do primeiro dia do mês atual.
::*'''[FinalMesAtual]''' – define a data do último dia do mês atual.
:Também é possível realizar operações de soma ou subtração de dias com esses comandos. Por exemplo:
::*'''[DataAtual] - 7''' – retorna a data de sete dias atrás.
::*'''[FinalMesAtual] + 3''' – retorna a data três dias após o final do mês atual.
<item nome="Período Inicial" atrib="D" paramName="DataEmissaoInicial" <font color=red>init="[DataAtual] - 90"</font> />
:Além disso, é possível carregar valores diretamente de configurações do sistema. Para isso, utilize o seguinte formato:
::*'''[Config(NúmeroConfiguração)]''' – substitui o comando pelo valor associado à configuração informada.
<item nome="Unidade de Negócio Inicial" atrib="A" paramName="UnidadeNegocioInicial" <font color=red>init="[Config(21)]"</font> />
<br>
:*O atributo <font color=red>"paramName"</font> deve ser exatamente igual ao nome do parâmetro especificado no método da API que controla a execução do relatório. Todos os filtros já possuem nomenclaturas apropriadas para seus respectivos <item>.
<item nome="Aglutinar Saldo" atrib="L" <font color=red>paramName="AglutinaSaldo"</font> />
<br>
:*O atributo <font color=red>“zoom”</font> terá um comportamento diferente da PD Desktop, onde será responsável por abrir uma modal (lupa), contendo os valores carregados de acordo com o método estabelecido pela API que foi atribuída ao campo. A forma de montar essa estrutura deve ser a seguinte: “/api/<area>/<controller>/<metodo>”. Por exemplo, a chamada da API para buscar as unidades de negócio cadastradas deverá ser realizada por meio da seguinte estrutura: “/api/genericos/ge/UnidadeNegocio/Buscar”.<br>
::Este atributo oferece três opções de filtros OData: 'top', 'select' e 'filter'. Cada um destes traz seus próprios comportamentos e padrões:<br>
::*O “top” pode ser usado para qualquer valor desejado, sem limites. Porém, quanto mais registros houver, maior será o tempo de espera para que a modal abra. Se esse campo for deixado em branco, o valor padrão de 1000 será usado.<br>
::*O “select” pode ser usado para indicar quais colunas serão exibidas na modal. Quando não for especificada nenhuma coluna, a coluna "Código" será mostrada como padrão na modal.<br>
::*O “filter” quando informado, irá habilitar o botão de pesquisa que irá atualizar os registros de acordo com o que foi pesquisado/filtrado, criando uma requisição e carregando os valores atualizados. Desta forma, a pesquisa não mais se limitará aos 1000 registros padrão (ou valor escolhido) do modelo.<br>
::Se o “filter” não é informado, a pesquisa por novos registros é desativada.<br>
<br>
A seguir está um exemplo de URL que inclui todos os parâmetros de filtro disponíveis:

<item nome="Unidade de Negócio Inicial" atrib="A" paramName="UnidadeNegocioInicial"   <font color=red>zoom="/api/genericos/ge/UnidadeNegocio/Buscar?$top=1000&$select=Codigo,Nome,Fantasia&$filter=contains(Nome,[value])"</font>   columnName="Código,Nome,Fantasia" />
<br>
Ao montar corretamente o atributo "zoom", uma modal será exibida de acordo com o endereço URL especificado:
<br>
[[Image:Modelo_Pesquisa_Web_03.jpg|semmoldura|center|850px|Modelo Pesquisa]]
<br>
:*O atributo <font color=red>"columnName"</font> deverá ser usado caso o atributo "zoom" esteja especificado, contendo o ‘select’ do OData. É obrigatório especificar o nome desejado para cada coluna respectivamente, separado por vírgulas e sem espaços em branco.
<item nome="Unidade de Negócio Inicial" atrib="A" paramName="UnidadeNegocioInicial" zoom="/api/genericos/ge/UnidadeNegocio/Buscar?$top=1000&$select=Codigo,Nome,Fantasia&$filter=contains(Nome,[value])" <font color=red>columnName="Código,Nome,Fantasia"</font> />
<br>
:*O atributo <font color=red>“range”</font> deve ser usado quando se deseja criar um ‘input’ do tipo ComboBox. Os itens devem ser separados por vírgulas sem espaço em branco, como por exemplo:
<item nome="Situação Item Pedido" atrib="A" paramName="SituacaoItemPedido" <font color=red>range="Todos,Pendente,Aberto,Entregue,Liquidado,Cancelado"</font> />
<br>
:O valor que será enviado à API é a primeira letra de cada item. Portanto, se o "Todos" for selecionado, será enviado “T” para API.
:Quando necessário enviar valores diferentes do que os exibidos, deve ser informado primeiramente o valor que deverá ser enviado. Depois disso, utilize o símbolo de hífen "-", como separador entre este valor e o que deverá ser exibido. Veja exemplo abaixo:<br>
<item nome="Situação Item Pedido" atrib="A" paramName="SituacaoItemPedido" <font color=red>range=" -Todos,NF-Nota Fiscal"</font> />
<br>
:Significando que, caso seja selecionado "Todos", será enviado um caractere em branco para a API, e caso seja selecionado "Nota Fiscal", será enviado "NF".

O elemento <web> existente para a PD Web, também será utilizado na funcionalidade de modelos de filtros. Para isso, deverá ser informado dentro do elemento <api> um elemento <controller>, no qual o atributo “endPoint” conterá o endereço da API que irá processar o relatório. Para uso com a API do CIGAM deverá ser usado só o caminho do relatório dentro da API, sem o endereço do servidor.
<web>
<api>
<controller endPoint="api/comercial/fa/pedido/ImprimirPedidosControle" />
</api>
</web>
{{VoltarInicio}}

==Emissão de relatórios nos portais CIGAM==
Abaixo temos um vídeo explicando todo processo dos relatórios nos portais, incluindo os modelos de filtros, funcionalidades e parametrizações:
<center><youtube>W1VSRmJyhCg</youtube></center>

=Como fazer o cadastro/alteração dos Modelos Pesquisa Dinâmica (Desktop e Web) e Modelos de Filtros=
Os modelos criados inicialmente (originais) estão disponíveis na pasta %CIGAM_INSTAL%Modelos\Pesquisas\, para a Pesquisa Dinâmica e %CIGAM_INSTAL%Modelos\Filtros\, para os Modelos de Filtros.<br>
Esses modelos podem ser facilmente adaptados e modificados conforme a necessidade de cada usuário. Se necessário, os usuários podem realizar essas alterações no 'Perfil de Usuário'. Veja item [[GE_-_Como_Fazer_-_Pesquisa_Din%C3%A2mica#Como_realizar_a_cria%C3%A7%C3%A3o/altera%C3%A7%C3%A3o_dos_modelos|4.2 “Como realizar a criação/alteração dos modelos”]].

==Quais as parametrizações necessárias para os modelos==
É necessário que para poder usufruir do recurso o acesso seja pelo CIGAM11, caso contrário a visualização da funcionalidade não será a mesma.<br>
Para que os acessos aos programas do Cigam funcionem corretamente é indicado que seja criado os modelos para o usuário em branco, sendo assim todos os usuários poderão visualizar o mesmo modelo, podendo ir implementando futuramente para usuários específicos se assim se fizer necessário.<br>
No entanto, se não houver nenhum cadastro realizado, e o usuário tente acessar o recurso, seja Relatório ou Pesquisa Dinâmica, um cadastro automático dos modelos com usuário em branco será realizado. Veja item [[GE_-_Como_Fazer_-_Pesquisa_Din%C3%A2mica#Como_funciona_a_cria%C3%A7%C3%A3o_autom%C3%A1tica_dos_modelos|4.3 “Como funciona a criação automática dos modelos”]].
{{VoltarInicio}}

==Como realizar a criação/alteração dos modelos==
Todos os modelos deverão ser criados na pasta %CIGAM_INSTAL%Modelos\, dentre eles, os filtros deverão ser armazenados em \Filtros\<Módulo>\<NomePublico_DescritivoDeIdentificação.xml> e as pesquisas em \Pesquisas\<Módulo>\<NomePublico_DescritivoDeIdentificação.xml>.<br>
Para criar/alterar um modelo para um determinado usuário é necessário acessar o programa de ‘Perfil de usuário’, no topo superior direito do CIGAM.<br>
Ao clicar em Editar perfil é possível acessar a tela das configurações, podendo assim então vincular/modificar os modelos para o usuário. Caso o usuário tenha direito de ‘GERENTE DE SISTEMA’, esse poderá modificar os modelos dos demais usuários.<br>
<br>
[[Image:Modelo_Pesquisa_Web_05.jpg|semmoldura|center|550px|Modelo Pesquisa]]
<br>
Ao clicar em Modelos - ‘Pesquisas’, ‘Filtros’ ou ‘Olap’, podemos modificar/vincular os modelos para usuários específicos ou para o usuário em branco, podemos também filtrar no campo ‘Programa’ todos os programas, ou um específico conforme a implementação da pesquisa dinâmica, o campo ‘Usuário’ só terá a exibição da opção Todos quando o usuário logado tiver o direito de ‘GERENTE DE SISTEMA’.<br>
<br>
Ao informar o modelo quando estiver criando, os demais campos serão preenchidos automaticamente, para o usuário logado. Caso o usuário tenha direito de Gerente de Sistema, esse poderá vincular uma pesquisa para cada usuário ou então fazer o vínculo para o usuário em branco, neste caso o modelo estará disponível para todos os usuários que não tiverem um modelo próprio marcado como padrão.<br>
<br>
Neste exemplo, foi criado um Modelo de Filtro, para o usuário logado.<br>
[[Image:Modelo_Pesquisa_Web_04.jpg|semmoldura|center|850px|Modelo Pesquisa]]
<br>
'''Orientações:''' ''É indicado que ao vincular um modelo a um determinado usuário permaneça marcado o campo Padrão, para que o usuário ao acessar o conteúdo abra automaticamente sem que este necessite escolher ou indicar uma pesquisa.''
{{VoltarInicio}}

==Como funciona a criação automática dos modelos==
A criação automática é possível quando no %CIGAM_INSTAL%, possuímos a pasta Modelos\Pesquisas\<Módulo>\"NomePublico_Descricao" e/ou Modelos\Filtros\<Módulo>\"NomePublico_Descricao". Com isso, ao abrir um programa que possua a chamada da pesquisa dinâmica ou relatório, é realizado o cadastro automaticamente.<br>
Outra situação que ocorre na busca automática é quando não há presença da pasta dos modelos no %CIGAM_INSTAL%. Neste caso, a busca automática só pode ser realizada se o ambiente estiver configurado para conexão com o Disco Virtual.<br>
Para acontecer essa busca de Modelos via Disco Virtual, é necessário que as seguintes configurações sejam informadas:<br>
*‘[[GE - AM - 2174 - Endereço web de atualizações CIGAM]]’;
**Essa configuração deve ter o endereço a ser extraído e dentro dela deve constar:
***1 - Pasta modelos/relatórios
***2 - Um arquivo lista_relatórios.txt
***3 - Modelo de Relatório com nome público e descrição descompactado.
*‘[[GE - AM - 2175 - Usuário para acesso de atualizações CIGAM]]’;
*‘[[GE - AM - 2176 - Senha para acesso de atualizações CIGAM]]’.

Ao baixar do Disco Virtual, criam-se imediatamente uma pasta e um modelo, com comportamento semelhante à busca padrão.<br>
[[Image:Modelo_Pesquisa_BuscaDiscoVirtual.png|semmoldura|center|850px|Disco Virtual]]
{{VoltarInicio}}

=Manuais Referenciados=
*[[Pesquisa Dinâmica - Comando CONCAT na cláusula WHERE|Comando CONCAT na cláusula WHERE]]
*[[Filtros temporários na Pesquisa Dinâmica - Filtros Dinâmicos|Como adicionar filtros temporários na Pesquisa Dinâmica]]
*[[GE - Como Fazer - Pesquisa Dinâmica - Personalizando um modelo]]

= Versões =
== Versão 211104 RC==
<references group="Versão 211104 RC"/>
== Versão 221107 Beta==
<references group="Versão 221107Beta"/>
== Versão 221107 Patch 'c'==
<references group="Versão 221107.c"/>
== Versão 230502==
<references group="Versão 230502"/>
== Versão 231002==
<references group="Versão 231002"/>
== Versão 231002.d==
<references group="Versão 231002.d"/>

CGWebRequestClient

2026-08-19T17:22:08Z

Vinicius.moder: /* Exportar Curl */

<div align="justify">
O '''CIGAM Web Request Client''' é uma ferramenta destinada à criação, ao envio e à validação de requisições. Com ele, é possível configurar métodos HTTP, URLs, parâmetros de query, headers, bodies, tempo de requisição e variáveis reutilizáveis, além de visualizar o código de status, o conteúdo e os headers das respostas.

Abaixo, detalhamos cada uma de suas funcionalidades para guiar a utilização correta da aplicação.
</div>

== Tela inicial ==
<div align="justify">
Ao iniciar, o programa exibirá uma janela completa dividida em 3 sessões principais, além do menu superior. O painel mais à esquerda exibe a coleção ativa e permite a criação de novas requisições. O painel superior à direita exibe detalhes da requisição atualmente selecionada, enquanto o painel inferior à direita exibe informações sobre a resposta da requisição atual, se houver.

A largura ou a altura desses painéis pode ser modificada pelo usuário ao parar o mouse na linha que as divide, clicar e arrastar. Isso pode facilitar a visualização em casos onde há muita informação relevante na tela.
</div>

[[Image: CGWebRequest_01.png|750px|centro]]

== Coleção ==
<div align="justify">
Nesse painel, ficam exibidas, de forma simplificada, todas as requisições criadas pelo usuário, em forma de tabela. Em uma das colunas, é exibido o verbo selecionado para cada requisição (que pode ser alterado a qualquer momento) e na outra é exibido o nome da requisição, que pode ser personalizado pelo usuário.
</div>

=== Verbo ===
<div align="justify">
Para escolher ou alterar o verbo de uma requisição basta clicar na seta que fica no lado direito da caixa de seleção na coluna '''verb''' no painel da coleção. Uma lista com os verbos disponíveis será exibida, então basta selecionar o desejado. Note-se que cada um deles possui uma cor específica, facilitando a visualização e compreensão. Os verbos disponíveis são:

*'''GET:''' Azul
*'''POST:''' Verde
*'''PUT:''' Amarelo
*'''DELETE:''' Vermelho
*'''PATCH:''' Roxo
*'''HEAD:''' Rosa
*'''OPTIONS:''' Marrom
*'''PROPFIND:''' Bege
</div>

[[Image: CGWebRequest_02.png|400px|centro]]

=== Nome ===
<div align="justify">
A coluna '''request''' da tabela permite a personalização do nome da requisição. Para adicionar um nome ou editá-lo, basta dar dois cliques na linha em questão, o que habilitará o cursor para digitação.
</div>

[[Image: CGWebRequest_03.png|400px|centro]]

=== Adicionar ===
<div align="justify">
Para adicionar uma nova requisição basta selecionar a última linha da tabela de requisições e personalizá-la com o verbo e o nome desejados. Sempre que o usuário modifica essa última linha, o programa automaticamente cria a próxima linha em branco.
</div>

=== Menu de Contexto ===
<div align="justify">
Clicar com o botão direito em alguma requisição irá exibir um menu de contexto com 3 opções:

[[Image: CGWebRequest_04.png|400px|centro]]

*'''Duplicate:''' Essa opção duplica a requisição selecionada, criando uma igual na última linha da tabela.
*'''Delete:''' Essa opção exclui a requisição selecionada.
*'''Exportar Curl:''' Essa opção exibe uma janela com a requisição selecionada formatada no padrão cURL. Para mais detalhes veja [[CGWebRequestClient#Exportar Curl|Exportar Curl]].
</div>

== Requisição ==
<div align="justify">
O painel de requisição é onde os detalhes podem ser configurados. O verbo selecionado (pode ser feito no painel de coleção, à esquerda) é exibido junto com sua respectiva cor de referência. Logo ao lado fica a caixa de texto da URL e, mais abaixo, um painel com abas que permitem as mais diversas configurações.

[[Image: CGWebRequest_16.png|750px|centro]]

=== URL ===
</div>
<div align="justify">
A caixa de texto da URL pode ser preenchida com o endereço desejado. Tendo feito isso, o valor preenchido previamente ficará salvo automaticamente. Dessa forma, o usuário pode navegar entre uma requisição e outra sem perder uma URL previamente digitada Ou seja, sempre que uma determinada requisição for selecionada no painel de coleção, a URL dela será exibida no painel de requisição.

</div>
<div align="justify">
Ao lado da barra de URL localiza-se o botão '''Enviar''', que, como o nome sugere, faz o envio da requisição. Ao clicar nele, o programa irá trabalhar para executar os comandos com base na configuração previamente estabelecida. Para que se obtenha sucesso, é necessário configurar todos os campos previamente.
</div>

[[Image: CGWebRequest_05(2).png|750px|centro]]

=== Env ===
<div align="justify">
Nessa aba do painel de configuração de requisição é possível configurar uma série de variáveis que podem facilitar a interação com diferentes requisições. É possível visualizar e editar variáveis conforme for desejado. Para tanto, basta utilizar um clique duplo na célula em questão, o que habilita o editor, permitindo a alteração por parte do usuário.
</div>
<div align="justify">
Para criar uma variável, tal qual na tabela de coleção, basta clicar na última linha e digitar o nome e o valor desejado. Sempre que uma nova variável é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>
<div align="justify">
Toda variável possui um nome e um valor, que estão representadas nas colunas '''Variable''' e '''Value'''. O nome de uma variável pode ser incluído em uma URL para facilitar sua alteração quando várias requisições possuem uma mesma URL. Para incluir a variável dessa forma, basta utilizar o nome dela entre chaves '''{{}}''' (chaves duplas):
</div>

<div align="justify">
*'''Nome:''' API
*'''Valor:''' <nowiki>/https://minhaapi.com/exemplo</nowiki>
*'''URL:''' <nowiki>{{API}}</nowiki>/login
</div>

[[Image: CGWebRequest_06(3).png|centro]]

=== Query ===
<div align="justify">
As queries de uma requisição ficam representadas na aba '''Query''' da tabela de configuração de requisição. Quando uma URL possui queries, o programa automaticamente faz a quebra dela, mantendo o texto até o '''?''' na parte superior e o dividindo o restante em linhas de uma tabela, onde é possível visualizá-las em detalhes.
</div>
<div align="justify">
Também é possível inserir queries manualmente, preenchendo o parâmetro e o valor ao utilizar um clique duplo na célula desejada. Da mesma forma que nas outras tabelas, sempre que uma nova linha é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>

==== Parâmetros e valores ====
São representados pelas colunas da tabela de queries. Quando estão presentes na URL colada na barra de texto acima, o programa os identifica automaticamente. É possível editá-los após isso.

Além do mais, na última coluna dessa tabela sempre haverá um checkbox que inicia marcado por padrão. Quando marcada, o programa incluirá a query na requisição, é possível desmarcá-la para que a query em questão seja ignorada. É uma forma prática de alterar a requisição sem ter de refazê-la ou criar uma nova.
</div>

[[Image: CGWebRequest_07(2).png|centro]]

=== Headers ===
<div align="justify">
Nesta aba é possível inserir e editar os cabeçalhos de uma requisição. Com funcionamento semelhante à aba '''Query''', os headers possuem um nome e um valor, representados pelas colunas '''Header''' e '''Value'''. Eles podem ser editados utilizando-se um clique duplo na célula desejada e novos podem ser criados selecionando a última linha da tabela. Sempre que a última linha é preenchida, uma nova linha em branco é criada automaticamente no final da tabela.

Há um checkbox na última coluna dessa tabela, que permite selecionar se um header deve, ou não, ser enviado junto com a requisição. O checkbox vem marcado por padrão. É comum que requisições diferentes possuam headers iguais, portanto essa opção é muito útil.
</div>

[[Image: CGWebRequest_08(2).png|centro]]

=== Body ===
<div align="justify">
Esta aba permite personalizar o corpo da requisição. Ela é subdividida entre outras 3 abas, que servem para selecionar o tipo, o formato no qual o body será enviado. É necessário selecionar o tipo compatível com a requisição desejada. Os tipos disponíveis são: JSON, XML e RAW.

Além disso, há uma caixa de texto onde o código do body pode ser digitado livremente. O conteúdo ali contido será enviado com a requisição. Abaixo, um exemplo de um body do tipo JSON:

[[Image: CGWebRequest_09(2).png|centro]]

*'''Limpar:''' Botão que limpa todo o conteúdo do body quando clicado.
*'''Abrir:''' Botão que permite ler o conteúdo de uma arquivo externo e adicioná-lo ao body. É necessário que o arquivo seja do tipo JSON. Quando lido, o conteúdo será exibido na caixa de texto destinada ao body, abaixo dos botões.
</div>

== Resposta ==
<div align="justify">
O painel inferior do lado direito é destinado a tudo aquilo que for retornado pela requisição.

*'''Código de status:''' No canto superior esquerdo desse painel ficará registrado o código de status da resposta. É o primeiro indicativo de sucesso ou fracasso de uma requisição, e sempre será exibido assim que ela for completada. Para requisições HTTP, existem códigos padronizados que indicam o que ocorreu durante uma requisição. São eles:

::*'''100-199:''' Repostas informativas;
::*'''200-299:''' Repostas bem-sucedidas;
::*'''300-399:''' Mensagens de redirecionamento;
::*'''400-499:''' Respostas de erro do cliente;
::*'''500-599:''' Respostas de erro do servidor.

*'''Tempo:''' O tempo de requisição é exibido logo ao lado do código de status, e registra em segundos a duração desde o envio da requisição até o recebimento da resposta.

*'''Botão Salvar:''' Fica no canto superior direito desse painel, e permite salvar o conteúdo da resposta em uma arquivo JSON.

[[Image: CGWebRequest_10(2).png|750px|centro]]
</div>

=== Response ===
<div align="justify">
Aba que exibe um campo de texto com o corpo da resposta. Como pode variar muito, o campo destinado a ela e é extenso e possui barras de rolagem para facilitar a navegação. A imagem acima mostra um exemplo de resposta no formato JSON.
</div>

=== Headers ===
<div align="justify">
Nessa aba é possível visualizar os cabeçalhos da resposta. Eles ficam exibidos em uma tabela com duas colunas: '''Header''' e '''Value''', que representam o nome e o valor de cada header. É possível visualizar um exemplo na imagem abaixo:

[[Image: CGWebRequest_11.png|500px|centro]]
</div>

== Menu superior ==

=== Collection ===
<div align="justify">
Esta opção permite controlar coleções, grupos de requisições criadas pelo usuário. Por padrão, as requisições exibidas no painel de coleção (no lado esquerdo da tela) fazem parte de uma coleção que é salva automaticamente sempre que o programa é fechado. O arquivo '''Collection.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

Além da lista de requisições, o arquivo também guarda a configuração de timeout definida pelo usuário (para mais detalhes ver [[CGWebRequestClient#Timeout|Timeout]]).

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de coleção para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. A coleção carregada será exibida no painel de coleção.

*'''Salvar:''' Essa opção permite salvar a coleção atual em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de coleção ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.

[[Image: CGWebRequest_12.png|750px|centro]]
</div>

=== Environment ===
<div align="justify">
Esta do menu superior permite controlar os ambientes, grupos de variáveis criadas pelo usuário. Por padrão, as variáveis exibidas na aba '''Env''' do painel de configuração de requisição (no lado superior direito da tela) fazem parte de um arquivo que é salvo automaticamente sempre que o programa é fechado. O arquivo '''Env.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de environment para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. As variáveis carregadas serão exibidas na aba '''Env''' do painel de configuração de requisição.

*'''Salvar:''' Essa opção permite salvar as variáveis atuais em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de environment ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.
</div>

=== Opções ===

==== Exportar Curl ====
<div align="justify">
Essa opção abre uma janela que exibe a requisição selecionada formatada no padrão cURL. É possível aumentar e diminuir a janela, o que pode facilitar a visualização no caso de requisições com conteúdo mais extenso.

Vale ressaltar que a requisição exibida sempre será aquela que estiver selecionada no momento.

[[Image: CGWebRequest_13.png|centro]]

*'''Copiar:''' Copia a cURL para a área de transferência. Uma mensagem aparece na parte debaixo da janela, confirmando a ação.
*'''Salvar:''' Abre uma janela que permite salvar a cURL em um arquivo de texto.
*'''Cancelar:''' Fecha a janela.
</div>

==== Timeout ====
<div align="justify">
Essa opção abre uma janela onde é possível configurar o timeout geral para todas as requisições, que é medido em segundos. O valor pode ser inserido diretamente no campo '''Tempo em segundos''' ou pode ser incrementado de um em um através das setas disponíveis no componente.

Vale ressaltar que, quando o programa é fechado, o timeout configurado é salvo junto com a coleção atual. Quando ela for carregada novamente, seja na inicialização do programa ou via arquivo, o timeout também se manterá.

[[Image: CGWebRequest_14.png|450px|centro]]

*'''OK:''' Salva as configurações feitas e fecha a janela.
*'''Cancelar:''' Fecha a janela sem salvar as alterações feitas.
</div>

=== Ajuda ===
<div align="justify">
Essa opção do menu possui algumas informações que podem ser úteis e informativas para o usuário.
</div>

==== Sobre ====
<div align="justify">
Abre uma janela com informações sobre o programa.

[[Image: CGWebRequest_15.png|450px|centro]]
</div>

<div align="justify">

==== Página da Wiki ====
Essa opção abre o link externo que leva até esta página.
</div>

Arquivo:CGWebRequest 13.png

2026-08-19T17:20:31Z

Vinicius.moder:

CGWebRequestClient

2026-07-20T16:30:03Z

Vinicius.moder: /* Resposta */

<div align="justify">
O '''CIGAM Web Request Client''' é uma ferramenta destinada à criação, ao envio e à validação de requisições. Com ele, é possível configurar métodos HTTP, URLs, parâmetros de query, headers, bodies, tempo de requisição e variáveis reutilizáveis, além de visualizar o código de status, o conteúdo e os headers das respostas.

Abaixo, detalhamos cada uma de suas funcionalidades para guiar a utilização correta da aplicação.
</div>

== Tela inicial ==
<div align="justify">
Ao iniciar, o programa exibirá uma janela completa dividida em 3 sessões principais, além do menu superior. O painel mais à esquerda exibe a coleção ativa e permite a criação de novas requisições. O painel superior à direita exibe detalhes da requisição atualmente selecionada, enquanto o painel inferior à direita exibe informações sobre a resposta da requisição atual, se houver.

A largura ou a altura desses painéis pode ser modificada pelo usuário ao parar o mouse na linha que as divide, clicar e arrastar. Isso pode facilitar a visualização em casos onde há muita informação relevante na tela.
</div>

[[Image: CGWebRequest_01.png|750px|centro]]

== Coleção ==
<div align="justify">
Nesse painel, ficam exibidas, de forma simplificada, todas as requisições criadas pelo usuário, em forma de tabela. Em uma das colunas, é exibido o verbo selecionado para cada requisição (que pode ser alterado a qualquer momento) e na outra é exibido o nome da requisição, que pode ser personalizado pelo usuário.
</div>

=== Verbo ===
<div align="justify">
Para escolher ou alterar o verbo de uma requisição basta clicar na seta que fica no lado direito da caixa de seleção na coluna '''verb''' no painel da coleção. Uma lista com os verbos disponíveis será exibida, então basta selecionar o desejado. Note-se que cada um deles possui uma cor específica, facilitando a visualização e compreensão. Os verbos disponíveis são:

*'''GET:''' Azul
*'''POST:''' Verde
*'''PUT:''' Amarelo
*'''DELETE:''' Vermelho
*'''PATCH:''' Roxo
*'''HEAD:''' Rosa
*'''OPTIONS:''' Marrom
*'''PROPFIND:''' Bege
</div>

[[Image: CGWebRequest_02.png|400px|centro]]

=== Nome ===
<div align="justify">
A coluna '''request''' da tabela permite a personalização do nome da requisição. Para adicionar um nome ou editá-lo, basta dar dois cliques na linha em questão, o que habilitará o cursor para digitação.
</div>

[[Image: CGWebRequest_03.png|400px|centro]]

=== Adicionar ===
<div align="justify">
Para adicionar uma nova requisição basta selecionar a última linha da tabela de requisições e personalizá-la com o verbo e o nome desejados. Sempre que o usuário modifica essa última linha, o programa automaticamente cria a próxima linha em branco.
</div>

=== Menu de Contexto ===
<div align="justify">
Clicar com o botão direito em alguma requisição irá exibir um menu de contexto com 3 opções:

[[Image: CGWebRequest_04.png|400px|centro]]

*'''Duplicate:''' Essa opção duplica a requisição selecionada, criando uma igual na última linha da tabela.
*'''Delete:''' Essa opção exclui a requisição selecionada.
*'''Exportar Curl:''' Essa opção exibe uma janela com a requisição selecionada formatada no padrão cURL. Para mais detalhes veja [[CGWebRequestClient#Exportar Curl|Exportar Curl]].
</div>

== Requisição ==
<div align="justify">
O painel de requisição é onde os detalhes podem ser configurados. O verbo selecionado (pode ser feito no painel de coleção, à esquerda) é exibido junto com sua respectiva cor de referência. Logo ao lado fica a caixa de texto da URL e, mais abaixo, um painel com abas que permitem as mais diversas configurações.

[[Image: CGWebRequest_16.png|750px|centro]]

=== URL ===
</div>
<div align="justify">
A caixa de texto da URL pode ser preenchida com o endereço desejado. Tendo feito isso, o valor preenchido previamente ficará salvo automaticamente. Dessa forma, o usuário pode navegar entre uma requisição e outra sem perder uma URL previamente digitada Ou seja, sempre que uma determinada requisição for selecionada no painel de coleção, a URL dela será exibida no painel de requisição.

</div>
<div align="justify">
Ao lado da barra de URL localiza-se o botão '''Enviar''', que, como o nome sugere, faz o envio da requisição. Ao clicar nele, o programa irá trabalhar para executar os comandos com base na configuração previamente estabelecida. Para que se obtenha sucesso, é necessário configurar todos os campos previamente.
</div>

[[Image: CGWebRequest_05(2).png|750px|centro]]

=== Env ===
<div align="justify">
Nessa aba do painel de configuração de requisição é possível configurar uma série de variáveis que podem facilitar a interação com diferentes requisições. É possível visualizar e editar variáveis conforme for desejado. Para tanto, basta utilizar um clique duplo na célula em questão, o que habilita o editor, permitindo a alteração por parte do usuário.
</div>
<div align="justify">
Para criar uma variável, tal qual na tabela de coleção, basta clicar na última linha e digitar o nome e o valor desejado. Sempre que uma nova variável é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>
<div align="justify">
Toda variável possui um nome e um valor, que estão representadas nas colunas '''Variable''' e '''Value'''. O nome de uma variável pode ser incluído em uma URL para facilitar sua alteração quando várias requisições possuem uma mesma URL. Para incluir a variável dessa forma, basta utilizar o nome dela entre chaves '''{{}}''' (chaves duplas):
</div>

<div align="justify">
*'''Nome:''' API
*'''Valor:''' <nowiki>/https://minhaapi.com/exemplo</nowiki>
*'''URL:''' <nowiki>{{API}}</nowiki>/login
</div>

[[Image: CGWebRequest_06(3).png|centro]]

=== Query ===
<div align="justify">
As queries de uma requisição ficam representadas na aba '''Query''' da tabela de configuração de requisição. Quando uma URL possui queries, o programa automaticamente faz a quebra dela, mantendo o texto até o '''?''' na parte superior e o dividindo o restante em linhas de uma tabela, onde é possível visualizá-las em detalhes.
</div>
<div align="justify">
Também é possível inserir queries manualmente, preenchendo o parâmetro e o valor ao utilizar um clique duplo na célula desejada. Da mesma forma que nas outras tabelas, sempre que uma nova linha é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>

==== Parâmetros e valores ====
São representados pelas colunas da tabela de queries. Quando estão presentes na URL colada na barra de texto acima, o programa os identifica automaticamente. É possível editá-los após isso.

Além do mais, na última coluna dessa tabela sempre haverá um checkbox que inicia marcado por padrão. Quando marcada, o programa incluirá a query na requisição, é possível desmarcá-la para que a query em questão seja ignorada. É uma forma prática de alterar a requisição sem ter de refazê-la ou criar uma nova.
</div>

[[Image: CGWebRequest_07(2).png|centro]]

=== Headers ===
<div align="justify">
Nesta aba é possível inserir e editar os cabeçalhos de uma requisição. Com funcionamento semelhante à aba '''Query''', os headers possuem um nome e um valor, representados pelas colunas '''Header''' e '''Value'''. Eles podem ser editados utilizando-se um clique duplo na célula desejada e novos podem ser criados selecionando a última linha da tabela. Sempre que a última linha é preenchida, uma nova linha em branco é criada automaticamente no final da tabela.

Há um checkbox na última coluna dessa tabela, que permite selecionar se um header deve, ou não, ser enviado junto com a requisição. O checkbox vem marcado por padrão. É comum que requisições diferentes possuam headers iguais, portanto essa opção é muito útil.
</div>

[[Image: CGWebRequest_08(2).png|centro]]

=== Body ===
<div align="justify">
Esta aba permite personalizar o corpo da requisição. Ela é subdividida entre outras 3 abas, que servem para selecionar o tipo, o formato no qual o body será enviado. É necessário selecionar o tipo compatível com a requisição desejada. Os tipos disponíveis são: JSON, XML e RAW.

Além disso, há uma caixa de texto onde o código do body pode ser digitado livremente. O conteúdo ali contido será enviado com a requisição. Abaixo, um exemplo de um body do tipo JSON:

[[Image: CGWebRequest_09(2).png|centro]]

*'''Limpar:''' Botão que limpa todo o conteúdo do body quando clicado.
*'''Abrir:''' Botão que permite ler o conteúdo de uma arquivo externo e adicioná-lo ao body. É necessário que o arquivo seja do tipo JSON. Quando lido, o conteúdo será exibido na caixa de texto destinada ao body, abaixo dos botões.
</div>

== Resposta ==
<div align="justify">
O painel inferior do lado direito é destinado a tudo aquilo que for retornado pela requisição.

*'''Código de status:''' No canto superior esquerdo desse painel ficará registrado o código de status da resposta. É o primeiro indicativo de sucesso ou fracasso de uma requisição, e sempre será exibido assim que ela for completada. Para requisições HTTP, existem códigos padronizados que indicam o que ocorreu durante uma requisição. São eles:

::*'''100-199:''' Repostas informativas;
::*'''200-299:''' Repostas bem-sucedidas;
::*'''300-399:''' Mensagens de redirecionamento;
::*'''400-499:''' Respostas de erro do cliente;
::*'''500-599:''' Respostas de erro do servidor.

*'''Tempo:''' O tempo de requisição é exibido logo ao lado do código de status, e registra em segundos a duração desde o envio da requisição até o recebimento da resposta.

*'''Botão Salvar:''' Fica no canto superior direito desse painel, e permite salvar o conteúdo da resposta em uma arquivo JSON.

[[Image: CGWebRequest_10(2).png|750px|centro]]
</div>

=== Response ===
<div align="justify">
Aba que exibe um campo de texto com o corpo da resposta. Como pode variar muito, o campo destinado a ela e é extenso e possui barras de rolagem para facilitar a navegação. A imagem acima mostra um exemplo de resposta no formato JSON.
</div>

=== Headers ===
<div align="justify">
Nessa aba é possível visualizar os cabeçalhos da resposta. Eles ficam exibidos em uma tabela com duas colunas: '''Header''' e '''Value''', que representam o nome e o valor de cada header. É possível visualizar um exemplo na imagem abaixo:

[[Image: CGWebRequest_11.png|500px|centro]]
</div>

== Menu superior ==

=== Collection ===
<div align="justify">
Esta opção permite controlar coleções, grupos de requisições criadas pelo usuário. Por padrão, as requisições exibidas no painel de coleção (no lado esquerdo da tela) fazem parte de uma coleção que é salva automaticamente sempre que o programa é fechado. O arquivo '''Collection.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

Além da lista de requisições, o arquivo também guarda a configuração de timeout definida pelo usuário (para mais detalhes ver [[CGWebRequestClient#Timeout|Timeout]]).

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de coleção para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. A coleção carregada será exibida no painel de coleção.

*'''Salvar:''' Essa opção permite salvar a coleção atual em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de coleção ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.

[[Image: CGWebRequest_12.png|750px|centro]]
</div>

=== Environment ===
<div align="justify">
Esta do menu superior permite controlar os ambientes, grupos de variáveis criadas pelo usuário. Por padrão, as variáveis exibidas na aba '''Env''' do painel de configuração de requisição (no lado superior direito da tela) fazem parte de um arquivo que é salvo automaticamente sempre que o programa é fechado. O arquivo '''Env.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de environment para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. As variáveis carregadas serão exibidas na aba '''Env''' do painel de configuração de requisição.

*'''Salvar:''' Essa opção permite salvar as variáveis atuais em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de environment ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.
</div>

=== Opções ===

==== Exportar Curl ====
<div align="justify">
Essa opção abre uma janela que exibe a requisição selecionada formatada no padrão cURL. É possível aumentar e diminuir a janela, o que pode facilitar a visualização no caso de requisições com conteúdo mais extenso.

Vale ressaltar que a requisição exibida sempre será aquela que estiver selecionada no momento.

[[Image: CGWebRequest_13.png|centro]]

*'''Copiar:''' Copia a cURL para a área de transferência. Uma mensagem aparece na parte debaixo da janela, confirmando a ação.
*'''Salvar:''' Abre uma janela que permite salvar a cURL em um arquivo de texto.
</div>

==== Timeout ====
<div align="justify">
Essa opção abre uma janela onde é possível configurar o timeout geral para todas as requisições, que é medido em segundos. O valor pode ser inserido diretamente no campo '''Tempo em segundos''' ou pode ser incrementado de um em um através das setas disponíveis no componente.

Vale ressaltar que, quando o programa é fechado, o timeout configurado é salvo junto com a coleção atual. Quando ela for carregada novamente, seja na inicialização do programa ou via arquivo, o timeout também se manterá.

[[Image: CGWebRequest_14.png|450px|centro]]

*'''OK:''' Salva as configurações feitas e fecha a janela.
*'''Cancelar:''' Fecha a janela sem salvar as alterações feitas.
</div>

=== Ajuda ===
<div align="justify">
Essa opção do menu possui algumas informações que podem ser úteis e informativas para o usuário.
</div>

==== Sobre ====
<div align="justify">
Abre uma janela com informações sobre o programa.

[[Image: CGWebRequest_15.png|450px|centro]]
</div>

<div align="justify">

==== Página da Wiki ====
Essa opção abre o link externo que leva até esta página.
</div>

CGWebRequestClient

2026-07-20T16:28:37Z

Vinicius.moder: /* Resposta */

<div align="justify">
O '''CIGAM Web Request Client''' é uma ferramenta destinada à criação, ao envio e à validação de requisições. Com ele, é possível configurar métodos HTTP, URLs, parâmetros de query, headers, bodies, tempo de requisição e variáveis reutilizáveis, além de visualizar o código de status, o conteúdo e os headers das respostas.

Abaixo, detalhamos cada uma de suas funcionalidades para guiar a utilização correta da aplicação.
</div>

== Tela inicial ==
<div align="justify">
Ao iniciar, o programa exibirá uma janela completa dividida em 3 sessões principais, além do menu superior. O painel mais à esquerda exibe a coleção ativa e permite a criação de novas requisições. O painel superior à direita exibe detalhes da requisição atualmente selecionada, enquanto o painel inferior à direita exibe informações sobre a resposta da requisição atual, se houver.

A largura ou a altura desses painéis pode ser modificada pelo usuário ao parar o mouse na linha que as divide, clicar e arrastar. Isso pode facilitar a visualização em casos onde há muita informação relevante na tela.
</div>

[[Image: CGWebRequest_01.png|750px|centro]]

== Coleção ==
<div align="justify">
Nesse painel, ficam exibidas, de forma simplificada, todas as requisições criadas pelo usuário, em forma de tabela. Em uma das colunas, é exibido o verbo selecionado para cada requisição (que pode ser alterado a qualquer momento) e na outra é exibido o nome da requisição, que pode ser personalizado pelo usuário.
</div>

=== Verbo ===
<div align="justify">
Para escolher ou alterar o verbo de uma requisição basta clicar na seta que fica no lado direito da caixa de seleção na coluna '''verb''' no painel da coleção. Uma lista com os verbos disponíveis será exibida, então basta selecionar o desejado. Note-se que cada um deles possui uma cor específica, facilitando a visualização e compreensão. Os verbos disponíveis são:

*'''GET:''' Azul
*'''POST:''' Verde
*'''PUT:''' Amarelo
*'''DELETE:''' Vermelho
*'''PATCH:''' Roxo
*'''HEAD:''' Rosa
*'''OPTIONS:''' Marrom
*'''PROPFIND:''' Bege
</div>

[[Image: CGWebRequest_02.png|400px|centro]]

=== Nome ===
<div align="justify">
A coluna '''request''' da tabela permite a personalização do nome da requisição. Para adicionar um nome ou editá-lo, basta dar dois cliques na linha em questão, o que habilitará o cursor para digitação.
</div>

[[Image: CGWebRequest_03.png|400px|centro]]

=== Adicionar ===
<div align="justify">
Para adicionar uma nova requisição basta selecionar a última linha da tabela de requisições e personalizá-la com o verbo e o nome desejados. Sempre que o usuário modifica essa última linha, o programa automaticamente cria a próxima linha em branco.
</div>

=== Menu de Contexto ===
<div align="justify">
Clicar com o botão direito em alguma requisição irá exibir um menu de contexto com 3 opções:

[[Image: CGWebRequest_04.png|400px|centro]]

*'''Duplicate:''' Essa opção duplica a requisição selecionada, criando uma igual na última linha da tabela.
*'''Delete:''' Essa opção exclui a requisição selecionada.
*'''Exportar Curl:''' Essa opção exibe uma janela com a requisição selecionada formatada no padrão cURL. Para mais detalhes veja [[CGWebRequestClient#Exportar Curl|Exportar Curl]].
</div>

== Requisição ==
<div align="justify">
O painel de requisição é onde os detalhes podem ser configurados. O verbo selecionado (pode ser feito no painel de coleção, à esquerda) é exibido junto com sua respectiva cor de referência. Logo ao lado fica a caixa de texto da URL e, mais abaixo, um painel com abas que permitem as mais diversas configurações.

[[Image: CGWebRequest_16.png|750px|centro]]

=== URL ===
</div>
<div align="justify">
A caixa de texto da URL pode ser preenchida com o endereço desejado. Tendo feito isso, o valor preenchido previamente ficará salvo automaticamente. Dessa forma, o usuário pode navegar entre uma requisição e outra sem perder uma URL previamente digitada Ou seja, sempre que uma determinada requisição for selecionada no painel de coleção, a URL dela será exibida no painel de requisição.

</div>
<div align="justify">
Ao lado da barra de URL localiza-se o botão '''Enviar''', que, como o nome sugere, faz o envio da requisição. Ao clicar nele, o programa irá trabalhar para executar os comandos com base na configuração previamente estabelecida. Para que se obtenha sucesso, é necessário configurar todos os campos previamente.
</div>

[[Image: CGWebRequest_05(2).png|750px|centro]]

=== Env ===
<div align="justify">
Nessa aba do painel de configuração de requisição é possível configurar uma série de variáveis que podem facilitar a interação com diferentes requisições. É possível visualizar e editar variáveis conforme for desejado. Para tanto, basta utilizar um clique duplo na célula em questão, o que habilita o editor, permitindo a alteração por parte do usuário.
</div>
<div align="justify">
Para criar uma variável, tal qual na tabela de coleção, basta clicar na última linha e digitar o nome e o valor desejado. Sempre que uma nova variável é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>
<div align="justify">
Toda variável possui um nome e um valor, que estão representadas nas colunas '''Variable''' e '''Value'''. O nome de uma variável pode ser incluído em uma URL para facilitar sua alteração quando várias requisições possuem uma mesma URL. Para incluir a variável dessa forma, basta utilizar o nome dela entre chaves '''{{}}''' (chaves duplas):
</div>

<div align="justify">
*'''Nome:''' API
*'''Valor:''' <nowiki>/https://minhaapi.com/exemplo</nowiki>
*'''URL:''' <nowiki>{{API}}</nowiki>/login
</div>

[[Image: CGWebRequest_06(3).png|centro]]

=== Query ===
<div align="justify">
As queries de uma requisição ficam representadas na aba '''Query''' da tabela de configuração de requisição. Quando uma URL possui queries, o programa automaticamente faz a quebra dela, mantendo o texto até o '''?''' na parte superior e o dividindo o restante em linhas de uma tabela, onde é possível visualizá-las em detalhes.
</div>
<div align="justify">
Também é possível inserir queries manualmente, preenchendo o parâmetro e o valor ao utilizar um clique duplo na célula desejada. Da mesma forma que nas outras tabelas, sempre que uma nova linha é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>

==== Parâmetros e valores ====
São representados pelas colunas da tabela de queries. Quando estão presentes na URL colada na barra de texto acima, o programa os identifica automaticamente. É possível editá-los após isso.

Além do mais, na última coluna dessa tabela sempre haverá um checkbox que inicia marcado por padrão. Quando marcada, o programa incluirá a query na requisição, é possível desmarcá-la para que a query em questão seja ignorada. É uma forma prática de alterar a requisição sem ter de refazê-la ou criar uma nova.
</div>

[[Image: CGWebRequest_07(2).png|centro]]

=== Headers ===
<div align="justify">
Nesta aba é possível inserir e editar os cabeçalhos de uma requisição. Com funcionamento semelhante à aba '''Query''', os headers possuem um nome e um valor, representados pelas colunas '''Header''' e '''Value'''. Eles podem ser editados utilizando-se um clique duplo na célula desejada e novos podem ser criados selecionando a última linha da tabela. Sempre que a última linha é preenchida, uma nova linha em branco é criada automaticamente no final da tabela.

Há um checkbox na última coluna dessa tabela, que permite selecionar se um header deve, ou não, ser enviado junto com a requisição. O checkbox vem marcado por padrão. É comum que requisições diferentes possuam headers iguais, portanto essa opção é muito útil.
</div>

[[Image: CGWebRequest_08(2).png|centro]]

=== Body ===
<div align="justify">
Esta aba permite personalizar o corpo da requisição. Ela é subdividida entre outras 3 abas, que servem para selecionar o tipo, o formato no qual o body será enviado. É necessário selecionar o tipo compatível com a requisição desejada. Os tipos disponíveis são: JSON, XML e RAW.

Além disso, há uma caixa de texto onde o código do body pode ser digitado livremente. O conteúdo ali contido será enviado com a requisição. Abaixo, um exemplo de um body do tipo JSON:

[[Image: CGWebRequest_09(2).png|centro]]

*'''Limpar:''' Botão que limpa todo o conteúdo do body quando clicado.
*'''Abrir:''' Botão que permite ler o conteúdo de uma arquivo externo e adicioná-lo ao body. É necessário que o arquivo seja do tipo JSON. Quando lido, o conteúdo será exibido na caixa de texto destinada ao body, abaixo dos botões.
</div>

== Resposta ==
<div align="justify">
O painel inferior do lado direito é destinado a tudo aquilo que for retornado pela requisição.

*'''Código:''' No canto superior esquerdo desse painel ficará registrado o código de status da resposta. É o primeiro indicativo de sucesso ou fracasso de uma requisição, e sempre será exibido assim que ela for completada. Para requisições HTTP, existem códigos padronizados que indicam o que ocorreu durante uma requisição. São eles:

::*'''100-199:''' Repostas informativas;
::*'''200-299:''' Repostas bem-sucedidas;
::*'''300-399:''' Mensagens de redirecionamento;
::*'''400-499:''' Respostas de erro do cliente;
::*'''500-599:''' Respostas de erro do servidor.

*'''Tempo:''' O tempo de requisição é exibido logo ao lado do código de status, e registra em segundos a duração desde o envio da requisição até o recebimento da resposta.

*'''Botão Salvar:''' Fica no canto superior direito desse painel, e permite salvar o conteúdo da resposta em uma arquivo JSON.

[[Image: CGWebRequest_10(2).png|750px|centro]]
</div>

=== Response ===
<div align="justify">
Aba que exibe um campo de texto com o corpo da resposta. Como pode variar muito, o campo destinado a ela e é extenso e possui barras de rolagem para facilitar a navegação. A imagem acima mostra um exemplo de resposta no formato JSON.
</div>

=== Headers ===
<div align="justify">
Nessa aba é possível visualizar os cabeçalhos da resposta. Eles ficam exibidos em uma tabela com duas colunas: '''Header''' e '''Value''', que representam o nome e o valor de cada header. É possível visualizar um exemplo na imagem abaixo:

[[Image: CGWebRequest_11.png|500px|centro]]
</div>

== Menu superior ==

=== Collection ===
<div align="justify">
Esta opção permite controlar coleções, grupos de requisições criadas pelo usuário. Por padrão, as requisições exibidas no painel de coleção (no lado esquerdo da tela) fazem parte de uma coleção que é salva automaticamente sempre que o programa é fechado. O arquivo '''Collection.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

Além da lista de requisições, o arquivo também guarda a configuração de timeout definida pelo usuário (para mais detalhes ver [[CGWebRequestClient#Timeout|Timeout]]).

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de coleção para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. A coleção carregada será exibida no painel de coleção.

*'''Salvar:''' Essa opção permite salvar a coleção atual em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de coleção ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.

[[Image: CGWebRequest_12.png|750px|centro]]
</div>

=== Environment ===
<div align="justify">
Esta do menu superior permite controlar os ambientes, grupos de variáveis criadas pelo usuário. Por padrão, as variáveis exibidas na aba '''Env''' do painel de configuração de requisição (no lado superior direito da tela) fazem parte de um arquivo que é salvo automaticamente sempre que o programa é fechado. O arquivo '''Env.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de environment para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. As variáveis carregadas serão exibidas na aba '''Env''' do painel de configuração de requisição.

*'''Salvar:''' Essa opção permite salvar as variáveis atuais em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de environment ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.
</div>

=== Opções ===

==== Exportar Curl ====
<div align="justify">
Essa opção abre uma janela que exibe a requisição selecionada formatada no padrão cURL. É possível aumentar e diminuir a janela, o que pode facilitar a visualização no caso de requisições com conteúdo mais extenso.

Vale ressaltar que a requisição exibida sempre será aquela que estiver selecionada no momento.

[[Image: CGWebRequest_13.png|centro]]

*'''Copiar:''' Copia a cURL para a área de transferência. Uma mensagem aparece na parte debaixo da janela, confirmando a ação.
*'''Salvar:''' Abre uma janela que permite salvar a cURL em um arquivo de texto.
</div>

==== Timeout ====
<div align="justify">
Essa opção abre uma janela onde é possível configurar o timeout geral para todas as requisições, que é medido em segundos. O valor pode ser inserido diretamente no campo '''Tempo em segundos''' ou pode ser incrementado de um em um através das setas disponíveis no componente.

Vale ressaltar que, quando o programa é fechado, o timeout configurado é salvo junto com a coleção atual. Quando ela for carregada novamente, seja na inicialização do programa ou via arquivo, o timeout também se manterá.

[[Image: CGWebRequest_14.png|450px|centro]]

*'''OK:''' Salva as configurações feitas e fecha a janela.
*'''Cancelar:''' Fecha a janela sem salvar as alterações feitas.
</div>

=== Ajuda ===
<div align="justify">
Essa opção do menu possui algumas informações que podem ser úteis e informativas para o usuário.
</div>

==== Sobre ====
<div align="justify">
Abre uma janela com informações sobre o programa.

[[Image: CGWebRequest_15.png|450px|centro]]
</div>

<div align="justify">

==== Página da Wiki ====
Essa opção abre o link externo que leva até esta página.
</div>

CGWebRequestClient

2026-07-20T16:28:22Z

Vinicius.moder: /* Resposta */

<div align="justify">
O '''CIGAM Web Request Client''' é uma ferramenta destinada à criação, ao envio e à validação de requisições. Com ele, é possível configurar métodos HTTP, URLs, parâmetros de query, headers, bodies, tempo de requisição e variáveis reutilizáveis, além de visualizar o código de status, o conteúdo e os headers das respostas.

Abaixo, detalhamos cada uma de suas funcionalidades para guiar a utilização correta da aplicação.
</div>

== Tela inicial ==
<div align="justify">
Ao iniciar, o programa exibirá uma janela completa dividida em 3 sessões principais, além do menu superior. O painel mais à esquerda exibe a coleção ativa e permite a criação de novas requisições. O painel superior à direita exibe detalhes da requisição atualmente selecionada, enquanto o painel inferior à direita exibe informações sobre a resposta da requisição atual, se houver.

A largura ou a altura desses painéis pode ser modificada pelo usuário ao parar o mouse na linha que as divide, clicar e arrastar. Isso pode facilitar a visualização em casos onde há muita informação relevante na tela.
</div>

[[Image: CGWebRequest_01.png|750px|centro]]

== Coleção ==
<div align="justify">
Nesse painel, ficam exibidas, de forma simplificada, todas as requisições criadas pelo usuário, em forma de tabela. Em uma das colunas, é exibido o verbo selecionado para cada requisição (que pode ser alterado a qualquer momento) e na outra é exibido o nome da requisição, que pode ser personalizado pelo usuário.
</div>

=== Verbo ===
<div align="justify">
Para escolher ou alterar o verbo de uma requisição basta clicar na seta que fica no lado direito da caixa de seleção na coluna '''verb''' no painel da coleção. Uma lista com os verbos disponíveis será exibida, então basta selecionar o desejado. Note-se que cada um deles possui uma cor específica, facilitando a visualização e compreensão. Os verbos disponíveis são:

*'''GET:''' Azul
*'''POST:''' Verde
*'''PUT:''' Amarelo
*'''DELETE:''' Vermelho
*'''PATCH:''' Roxo
*'''HEAD:''' Rosa
*'''OPTIONS:''' Marrom
*'''PROPFIND:''' Bege
</div>

[[Image: CGWebRequest_02.png|400px|centro]]

=== Nome ===
<div align="justify">
A coluna '''request''' da tabela permite a personalização do nome da requisição. Para adicionar um nome ou editá-lo, basta dar dois cliques na linha em questão, o que habilitará o cursor para digitação.
</div>

[[Image: CGWebRequest_03.png|400px|centro]]

=== Adicionar ===
<div align="justify">
Para adicionar uma nova requisição basta selecionar a última linha da tabela de requisições e personalizá-la com o verbo e o nome desejados. Sempre que o usuário modifica essa última linha, o programa automaticamente cria a próxima linha em branco.
</div>

=== Menu de Contexto ===
<div align="justify">
Clicar com o botão direito em alguma requisição irá exibir um menu de contexto com 3 opções:

[[Image: CGWebRequest_04.png|400px|centro]]

*'''Duplicate:''' Essa opção duplica a requisição selecionada, criando uma igual na última linha da tabela.
*'''Delete:''' Essa opção exclui a requisição selecionada.
*'''Exportar Curl:''' Essa opção exibe uma janela com a requisição selecionada formatada no padrão cURL. Para mais detalhes veja [[CGWebRequestClient#Exportar Curl|Exportar Curl]].
</div>

== Requisição ==
<div align="justify">
O painel de requisição é onde os detalhes podem ser configurados. O verbo selecionado (pode ser feito no painel de coleção, à esquerda) é exibido junto com sua respectiva cor de referência. Logo ao lado fica a caixa de texto da URL e, mais abaixo, um painel com abas que permitem as mais diversas configurações.

[[Image: CGWebRequest_16.png|750px|centro]]

=== URL ===
</div>
<div align="justify">
A caixa de texto da URL pode ser preenchida com o endereço desejado. Tendo feito isso, o valor preenchido previamente ficará salvo automaticamente. Dessa forma, o usuário pode navegar entre uma requisição e outra sem perder uma URL previamente digitada Ou seja, sempre que uma determinada requisição for selecionada no painel de coleção, a URL dela será exibida no painel de requisição.

</div>
<div align="justify">
Ao lado da barra de URL localiza-se o botão '''Enviar''', que, como o nome sugere, faz o envio da requisição. Ao clicar nele, o programa irá trabalhar para executar os comandos com base na configuração previamente estabelecida. Para que se obtenha sucesso, é necessário configurar todos os campos previamente.
</div>

[[Image: CGWebRequest_05(2).png|750px|centro]]

=== Env ===
<div align="justify">
Nessa aba do painel de configuração de requisição é possível configurar uma série de variáveis que podem facilitar a interação com diferentes requisições. É possível visualizar e editar variáveis conforme for desejado. Para tanto, basta utilizar um clique duplo na célula em questão, o que habilita o editor, permitindo a alteração por parte do usuário.
</div>
<div align="justify">
Para criar uma variável, tal qual na tabela de coleção, basta clicar na última linha e digitar o nome e o valor desejado. Sempre que uma nova variável é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>
<div align="justify">
Toda variável possui um nome e um valor, que estão representadas nas colunas '''Variable''' e '''Value'''. O nome de uma variável pode ser incluído em uma URL para facilitar sua alteração quando várias requisições possuem uma mesma URL. Para incluir a variável dessa forma, basta utilizar o nome dela entre chaves '''{{}}''' (chaves duplas):
</div>

<div align="justify">
*'''Nome:''' API
*'''Valor:''' <nowiki>/https://minhaapi.com/exemplo</nowiki>
*'''URL:''' <nowiki>{{API}}</nowiki>/login
</div>

[[Image: CGWebRequest_06(3).png|centro]]

=== Query ===
<div align="justify">
As queries de uma requisição ficam representadas na aba '''Query''' da tabela de configuração de requisição. Quando uma URL possui queries, o programa automaticamente faz a quebra dela, mantendo o texto até o '''?''' na parte superior e o dividindo o restante em linhas de uma tabela, onde é possível visualizá-las em detalhes.
</div>
<div align="justify">
Também é possível inserir queries manualmente, preenchendo o parâmetro e o valor ao utilizar um clique duplo na célula desejada. Da mesma forma que nas outras tabelas, sempre que uma nova linha é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>

==== Parâmetros e valores ====
São representados pelas colunas da tabela de queries. Quando estão presentes na URL colada na barra de texto acima, o programa os identifica automaticamente. É possível editá-los após isso.

Além do mais, na última coluna dessa tabela sempre haverá um checkbox que inicia marcado por padrão. Quando marcada, o programa incluirá a query na requisição, é possível desmarcá-la para que a query em questão seja ignorada. É uma forma prática de alterar a requisição sem ter de refazê-la ou criar uma nova.
</div>

[[Image: CGWebRequest_07(2).png|centro]]

=== Headers ===
<div align="justify">
Nesta aba é possível inserir e editar os cabeçalhos de uma requisição. Com funcionamento semelhante à aba '''Query''', os headers possuem um nome e um valor, representados pelas colunas '''Header''' e '''Value'''. Eles podem ser editados utilizando-se um clique duplo na célula desejada e novos podem ser criados selecionando a última linha da tabela. Sempre que a última linha é preenchida, uma nova linha em branco é criada automaticamente no final da tabela.

Há um checkbox na última coluna dessa tabela, que permite selecionar se um header deve, ou não, ser enviado junto com a requisição. O checkbox vem marcado por padrão. É comum que requisições diferentes possuam headers iguais, portanto essa opção é muito útil.
</div>

[[Image: CGWebRequest_08(2).png|centro]]

=== Body ===
<div align="justify">
Esta aba permite personalizar o corpo da requisição. Ela é subdividida entre outras 3 abas, que servem para selecionar o tipo, o formato no qual o body será enviado. É necessário selecionar o tipo compatível com a requisição desejada. Os tipos disponíveis são: JSON, XML e RAW.

Além disso, há uma caixa de texto onde o código do body pode ser digitado livremente. O conteúdo ali contido será enviado com a requisição. Abaixo, um exemplo de um body do tipo JSON:

[[Image: CGWebRequest_09(2).png|centro]]

*'''Limpar:''' Botão que limpa todo o conteúdo do body quando clicado.
*'''Abrir:''' Botão que permite ler o conteúdo de uma arquivo externo e adicioná-lo ao body. É necessário que o arquivo seja do tipo JSON. Quando lido, o conteúdo será exibido na caixa de texto destinada ao body, abaixo dos botões.
</div>

== Resposta ==
<div align="justify">
O painel inferior do lado direito é destinado a tudo aquilo que for retornado pela requisição.

*'''Código:''' No canto superior esquerdo desse painel ficará registrado o código de status da resposta. É o primeiro indicativo de sucesso ou fracasso de uma requisição, e sempre será exibido assim que ela for completada. Para requisições HTTP, existem códigos padronizados que indicam o que ocorreu durante uma requisição. São eles:

::*'''100-199:''' Repostas informativas;
::*'''200-299:''' Repostas bem-sucedidas;
::*'''300-399:''' Mensagens de redirecionamento;
::*'''400-499:''' Respostas de erro do cliente;
::*'''500-599:''' Respostas de erro do servidor.

*'''Tempo:''' O tempo de requisição é exibido logo ao lado do código de status, e registra em segundos a duração desde o envio da requisição até o recebimento da resposta.

*'''Botão Salvar:''' Fica no canto superior direito desse painel, e permite salvar o conteúdo da resposta em uma arquivo JSON.

[[Image: CGWebRequest_10(2).png|750px|centro]]
</div>

=== Response ===
<div align="justify">
Aba que exibe um campo de texto com o corpo da resposta. Como pode variar muito, o campo destinado a ela e é extenso e possui barras de rolagem para facilitar a navegação. A imagem acima mostra um exemplo de resposta no formato JSON.
</div>

=== Headers ===
<div align="justify">
Nessa aba é possível visualizar os cabeçalhos da resposta. Eles ficam exibidos em uma tabela com duas colunas: '''Header''' e '''Value''', que representam o nome e o valor de cada header. É possível visualizar um exemplo na imagem abaixo:

[[Image: CGWebRequest_11.png|500px|centro]]
</div>

== Menu superior ==

=== Collection ===
<div align="justify">
Esta opção permite controlar coleções, grupos de requisições criadas pelo usuário. Por padrão, as requisições exibidas no painel de coleção (no lado esquerdo da tela) fazem parte de uma coleção que é salva automaticamente sempre que o programa é fechado. O arquivo '''Collection.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

Além da lista de requisições, o arquivo também guarda a configuração de timeout definida pelo usuário (para mais detalhes ver [[CGWebRequestClient#Timeout|Timeout]]).

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de coleção para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. A coleção carregada será exibida no painel de coleção.

*'''Salvar:''' Essa opção permite salvar a coleção atual em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de coleção ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.

[[Image: CGWebRequest_12.png|750px|centro]]
</div>

=== Environment ===
<div align="justify">
Esta do menu superior permite controlar os ambientes, grupos de variáveis criadas pelo usuário. Por padrão, as variáveis exibidas na aba '''Env''' do painel de configuração de requisição (no lado superior direito da tela) fazem parte de um arquivo que é salvo automaticamente sempre que o programa é fechado. O arquivo '''Env.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de environment para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. As variáveis carregadas serão exibidas na aba '''Env''' do painel de configuração de requisição.

*'''Salvar:''' Essa opção permite salvar as variáveis atuais em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de environment ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.
</div>

=== Opções ===

==== Exportar Curl ====
<div align="justify">
Essa opção abre uma janela que exibe a requisição selecionada formatada no padrão cURL. É possível aumentar e diminuir a janela, o que pode facilitar a visualização no caso de requisições com conteúdo mais extenso.

Vale ressaltar que a requisição exibida sempre será aquela que estiver selecionada no momento.

[[Image: CGWebRequest_13.png|centro]]

*'''Copiar:''' Copia a cURL para a área de transferência. Uma mensagem aparece na parte debaixo da janela, confirmando a ação.
*'''Salvar:''' Abre uma janela que permite salvar a cURL em um arquivo de texto.
</div>

==== Timeout ====
<div align="justify">
Essa opção abre uma janela onde é possível configurar o timeout geral para todas as requisições, que é medido em segundos. O valor pode ser inserido diretamente no campo '''Tempo em segundos''' ou pode ser incrementado de um em um através das setas disponíveis no componente.

Vale ressaltar que, quando o programa é fechado, o timeout configurado é salvo junto com a coleção atual. Quando ela for carregada novamente, seja na inicialização do programa ou via arquivo, o timeout também se manterá.

[[Image: CGWebRequest_14.png|450px|centro]]

*'''OK:''' Salva as configurações feitas e fecha a janela.
*'''Cancelar:''' Fecha a janela sem salvar as alterações feitas.
</div>

=== Ajuda ===
<div align="justify">
Essa opção do menu possui algumas informações que podem ser úteis e informativas para o usuário.
</div>

==== Sobre ====
<div align="justify">
Abre uma janela com informações sobre o programa.

[[Image: CGWebRequest_15.png|450px|centro]]
</div>

<div align="justify">

==== Página da Wiki ====
Essa opção abre o link externo que leva até esta página.
</div>

Arquivo:CGWebRequest 06(3).png

2026-07-20T16:19:58Z

Vinicius.moder:

CGWebRequestClient

2026-07-20T16:19:35Z

Vinicius.moder: /* Env */

<div align="justify">
O '''CIGAM Web Request Client''' é uma ferramenta destinada à criação, ao envio e à validação de requisições. Com ele, é possível configurar métodos HTTP, URLs, parâmetros de query, headers, bodies, tempo de requisição e variáveis reutilizáveis, além de visualizar o código de status, o conteúdo e os headers das respostas.

Abaixo, detalhamos cada uma de suas funcionalidades para guiar a utilização correta da aplicação.
</div>

== Tela inicial ==
<div align="justify">
Ao iniciar, o programa exibirá uma janela completa dividida em 3 sessões principais, além do menu superior. O painel mais à esquerda exibe a coleção ativa e permite a criação de novas requisições. O painel superior à direita exibe detalhes da requisição atualmente selecionada, enquanto o painel inferior à direita exibe informações sobre a resposta da requisição atual, se houver.

A largura ou a altura desses painéis pode ser modificada pelo usuário ao parar o mouse na linha que as divide, clicar e arrastar. Isso pode facilitar a visualização em casos onde há muita informação relevante na tela.
</div>

[[Image: CGWebRequest_01.png|750px|centro]]

== Coleção ==
<div align="justify">
Nesse painel, ficam exibidas, de forma simplificada, todas as requisições criadas pelo usuário, em forma de tabela. Em uma das colunas, é exibido o verbo selecionado para cada requisição (que pode ser alterado a qualquer momento) e na outra é exibido o nome da requisição, que pode ser personalizado pelo usuário.
</div>

=== Verbo ===
<div align="justify">
Para escolher ou alterar o verbo de uma requisição basta clicar na seta que fica no lado direito da caixa de seleção na coluna '''verb''' no painel da coleção. Uma lista com os verbos disponíveis será exibida, então basta selecionar o desejado. Note-se que cada um deles possui uma cor específica, facilitando a visualização e compreensão. Os verbos disponíveis são:

*'''GET:''' Azul
*'''POST:''' Verde
*'''PUT:''' Amarelo
*'''DELETE:''' Vermelho
*'''PATCH:''' Roxo
*'''HEAD:''' Rosa
*'''OPTIONS:''' Marrom
*'''PROPFIND:''' Bege
</div>

[[Image: CGWebRequest_02.png|400px|centro]]

=== Nome ===
<div align="justify">
A coluna '''request''' da tabela permite a personalização do nome da requisição. Para adicionar um nome ou editá-lo, basta dar dois cliques na linha em questão, o que habilitará o cursor para digitação.
</div>

[[Image: CGWebRequest_03.png|400px|centro]]

=== Adicionar ===
<div align="justify">
Para adicionar uma nova requisição basta selecionar a última linha da tabela de requisições e personalizá-la com o verbo e o nome desejados. Sempre que o usuário modifica essa última linha, o programa automaticamente cria a próxima linha em branco.
</div>

=== Menu de Contexto ===
<div align="justify">
Clicar com o botão direito em alguma requisição irá exibir um menu de contexto com 3 opções:

[[Image: CGWebRequest_04.png|400px|centro]]

*'''Duplicate:''' Essa opção duplica a requisição selecionada, criando uma igual na última linha da tabela.
*'''Delete:''' Essa opção exclui a requisição selecionada.
*'''Exportar Curl:''' Essa opção exibe uma janela com a requisição selecionada formatada no padrão cURL. Para mais detalhes veja [[CGWebRequestClient#Exportar Curl|Exportar Curl]].
</div>

== Requisição ==
<div align="justify">
O painel de requisição é onde os detalhes podem ser configurados. O verbo selecionado (pode ser feito no painel de coleção, à esquerda) é exibido junto com sua respectiva cor de referência. Logo ao lado fica a caixa de texto da URL e, mais abaixo, um painel com abas que permitem as mais diversas configurações.

[[Image: CGWebRequest_16.png|750px|centro]]

=== URL ===
</div>
<div align="justify">
A caixa de texto da URL pode ser preenchida com o endereço desejado. Tendo feito isso, o valor preenchido previamente ficará salvo automaticamente. Dessa forma, o usuário pode navegar entre uma requisição e outra sem perder uma URL previamente digitada Ou seja, sempre que uma determinada requisição for selecionada no painel de coleção, a URL dela será exibida no painel de requisição.

</div>
<div align="justify">
Ao lado da barra de URL localiza-se o botão '''Enviar''', que, como o nome sugere, faz o envio da requisição. Ao clicar nele, o programa irá trabalhar para executar os comandos com base na configuração previamente estabelecida. Para que se obtenha sucesso, é necessário configurar todos os campos previamente.
</div>

[[Image: CGWebRequest_05(2).png|750px|centro]]

=== Env ===
<div align="justify">
Nessa aba do painel de configuração de requisição é possível configurar uma série de variáveis que podem facilitar a interação com diferentes requisições. É possível visualizar e editar variáveis conforme for desejado. Para tanto, basta utilizar um clique duplo na célula em questão, o que habilita o editor, permitindo a alteração por parte do usuário.
</div>
<div align="justify">
Para criar uma variável, tal qual na tabela de coleção, basta clicar na última linha e digitar o nome e o valor desejado. Sempre que uma nova variável é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>
<div align="justify">
Toda variável possui um nome e um valor, que estão representadas nas colunas '''Variable''' e '''Value'''. O nome de uma variável pode ser incluído em uma URL para facilitar sua alteração quando várias requisições possuem uma mesma URL. Para incluir a variável dessa forma, basta utilizar o nome dela entre chaves '''{{}}''' (chaves duplas):
</div>

<div align="justify">
*'''Nome:''' API
*'''Valor:''' <nowiki>/https://minhaapi.com/exemplo</nowiki>
*'''URL:''' <nowiki>{{API}}</nowiki>/login
</div>

[[Image: CGWebRequest_06(3).png|centro]]

=== Query ===
<div align="justify">
As queries de uma requisição ficam representadas na aba '''Query''' da tabela de configuração de requisição. Quando uma URL possui queries, o programa automaticamente faz a quebra dela, mantendo o texto até o '''?''' na parte superior e o dividindo o restante em linhas de uma tabela, onde é possível visualizá-las em detalhes.
</div>
<div align="justify">
Também é possível inserir queries manualmente, preenchendo o parâmetro e o valor ao utilizar um clique duplo na célula desejada. Da mesma forma que nas outras tabelas, sempre que uma nova linha é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>

==== Parâmetros e valores ====
São representados pelas colunas da tabela de queries. Quando estão presentes na URL colada na barra de texto acima, o programa os identifica automaticamente. É possível editá-los após isso.

Além do mais, na última coluna dessa tabela sempre haverá um checkbox que inicia marcado por padrão. Quando marcada, o programa incluirá a query na requisição, é possível desmarcá-la para que a query em questão seja ignorada. É uma forma prática de alterar a requisição sem ter de refazê-la ou criar uma nova.
</div>

[[Image: CGWebRequest_07(2).png|centro]]

=== Headers ===
<div align="justify">
Nesta aba é possível inserir e editar os cabeçalhos de uma requisição. Com funcionamento semelhante à aba '''Query''', os headers possuem um nome e um valor, representados pelas colunas '''Header''' e '''Value'''. Eles podem ser editados utilizando-se um clique duplo na célula desejada e novos podem ser criados selecionando a última linha da tabela. Sempre que a última linha é preenchida, uma nova linha em branco é criada automaticamente no final da tabela.

Há um checkbox na última coluna dessa tabela, que permite selecionar se um header deve, ou não, ser enviado junto com a requisição. O checkbox vem marcado por padrão. É comum que requisições diferentes possuam headers iguais, portanto essa opção é muito útil.
</div>

[[Image: CGWebRequest_08(2).png|centro]]

=== Body ===
<div align="justify">
Esta aba permite personalizar o corpo da requisição. Ela é subdividida entre outras 3 abas, que servem para selecionar o tipo, o formato no qual o body será enviado. É necessário selecionar o tipo compatível com a requisição desejada. Os tipos disponíveis são: JSON, XML e RAW.

Além disso, há uma caixa de texto onde o código do body pode ser digitado livremente. O conteúdo ali contido será enviado com a requisição. Abaixo, um exemplo de um body do tipo JSON:

[[Image: CGWebRequest_09(2).png|centro]]

*'''Limpar:''' Botão que limpa todo o conteúdo do body quando clicado.
*'''Abrir:''' Botão que permite ler o conteúdo de uma arquivo externo e adicioná-lo ao body. É necessário que o arquivo seja do tipo JSON. Quando lido, o conteúdo será exibido na caixa de texto destinada ao body, abaixo dos botões.
</div>

== Resposta ==
<div align="justify">
O painel inferior do lado direito é destinado a tudo aquilo que for retornado pela requisição.

*'''Código:''' No canto superior esquerdo desse painel ficará registrado o código de status da resposta. É o primeiro indicativo de sucesso ou fracasso de uma requisição, e sempre será exibido assim que ela for completada (se for completada).

*'''Tempo:''' O tempo de requisição é exibido logo ao lado do código de status, e registra em segundos a duração desde o envio da requisição até o recebimento da resposta.

*'''Botão Salvar:''' Fica no canto superior direito desse painel, e permite salvar o conteúdo da resposta em uma arquivo JSON.

[[Image: CGWebRequest_10(2).png|750px|centro]]
</div>

=== Response ===
<div align="justify">
Aba que exibe um campo de texto com o corpo da resposta. Como pode variar muito, o campo destinado a ela e é extenso e possui barras de rolagem para facilitar a navegação. A imagem acima mostra um exemplo de resposta no formato JSON.
</div>

=== Headers ===
<div align="justify">
Nessa aba é possível visualizar os cabeçalhos da resposta. Eles ficam exibidos em uma tabela com duas colunas: '''Header''' e '''Value''', que representam o nome e o valor de cada header. É possível visualizar um exemplo na imagem abaixo:

[[Image: CGWebRequest_11.png|500px|centro]]
</div>

== Menu superior ==

=== Collection ===
<div align="justify">
Esta opção permite controlar coleções, grupos de requisições criadas pelo usuário. Por padrão, as requisições exibidas no painel de coleção (no lado esquerdo da tela) fazem parte de uma coleção que é salva automaticamente sempre que o programa é fechado. O arquivo '''Collection.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

Além da lista de requisições, o arquivo também guarda a configuração de timeout definida pelo usuário (para mais detalhes ver [[CGWebRequestClient#Timeout|Timeout]]).

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de coleção para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. A coleção carregada será exibida no painel de coleção.

*'''Salvar:''' Essa opção permite salvar a coleção atual em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de coleção ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.

[[Image: CGWebRequest_12.png|750px|centro]]
</div>

=== Environment ===
<div align="justify">
Esta do menu superior permite controlar os ambientes, grupos de variáveis criadas pelo usuário. Por padrão, as variáveis exibidas na aba '''Env''' do painel de configuração de requisição (no lado superior direito da tela) fazem parte de um arquivo que é salvo automaticamente sempre que o programa é fechado. O arquivo '''Env.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de environment para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. As variáveis carregadas serão exibidas na aba '''Env''' do painel de configuração de requisição.

*'''Salvar:''' Essa opção permite salvar as variáveis atuais em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de environment ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.
</div>

=== Opções ===

==== Exportar Curl ====
<div align="justify">
Essa opção abre uma janela que exibe a requisição selecionada formatada no padrão cURL. É possível aumentar e diminuir a janela, o que pode facilitar a visualização no caso de requisições com conteúdo mais extenso.

Vale ressaltar que a requisição exibida sempre será aquela que estiver selecionada no momento.

[[Image: CGWebRequest_13.png|centro]]

*'''Copiar:''' Copia a cURL para a área de transferência. Uma mensagem aparece na parte debaixo da janela, confirmando a ação.
*'''Salvar:''' Abre uma janela que permite salvar a cURL em um arquivo de texto.
</div>

==== Timeout ====
<div align="justify">
Essa opção abre uma janela onde é possível configurar o timeout geral para todas as requisições, que é medido em segundos. O valor pode ser inserido diretamente no campo '''Tempo em segundos''' ou pode ser incrementado de um em um através das setas disponíveis no componente.

Vale ressaltar que, quando o programa é fechado, o timeout configurado é salvo junto com a coleção atual. Quando ela for carregada novamente, seja na inicialização do programa ou via arquivo, o timeout também se manterá.

[[Image: CGWebRequest_14.png|450px|centro]]

*'''OK:''' Salva as configurações feitas e fecha a janela.
*'''Cancelar:''' Fecha a janela sem salvar as alterações feitas.
</div>

=== Ajuda ===
<div align="justify">
Essa opção do menu possui algumas informações que podem ser úteis e informativas para o usuário.
</div>

==== Sobre ====
<div align="justify">
Abre uma janela com informações sobre o programa.

[[Image: CGWebRequest_15.png|450px|centro]]
</div>

<div align="justify">

==== Página da Wiki ====
Essa opção abre o link externo que leva até esta página.
</div>

CGWebRequestClient

2026-07-20T14:18:40Z

Vinicius.moder: /* Environment */

<div align="justify">
O '''CIGAM Web Request Client''' é uma ferramenta destinada à criação, ao envio e à validação de requisições. Com ele, é possível configurar métodos HTTP, URLs, parâmetros de query, headers, bodies, tempo de requisição e variáveis reutilizáveis, além de visualizar o código de status, o conteúdo e os headers das respostas.

Abaixo, detalhamos cada uma de suas funcionalidades para guiar a utilização correta da aplicação.
</div>

== Tela inicial ==
<div align="justify">
Ao iniciar, o programa exibirá uma janela completa dividida em 3 sessões principais, além do menu superior. O painel mais à esquerda exibe a coleção ativa e permite a criação de novas requisições. O painel superior à direita exibe detalhes da requisição atualmente selecionada, enquanto o painel inferior à direita exibe informações sobre a resposta da requisição atual, se houver.

A largura ou a altura desses painéis pode ser modificada pelo usuário ao parar o mouse na linha que as divide, clicar e arrastar. Isso pode facilitar a visualização em casos onde há muita informação relevante na tela.
</div>

[[Image: CGWebRequest_01.png|750px|centro]]

== Coleção ==
<div align="justify">
Nesse painel, ficam exibidas, de forma simplificada, todas as requisições criadas pelo usuário, em forma de tabela. Em uma das colunas, é exibido o verbo selecionado para cada requisição (que pode ser alterado a qualquer momento) e na outra é exibido o nome da requisição, que pode ser personalizado pelo usuário.
</div>

=== Verbo ===
<div align="justify">
Para escolher ou alterar o verbo de uma requisição basta clicar na seta que fica no lado direito da caixa de seleção na coluna '''verb''' no painel da coleção. Uma lista com os verbos disponíveis será exibida, então basta selecionar o desejado. Note-se que cada um deles possui uma cor específica, facilitando a visualização e compreensão. Os verbos disponíveis são:

*'''GET:''' Azul
*'''POST:''' Verde
*'''PUT:''' Amarelo
*'''DELETE:''' Vermelho
*'''PATCH:''' Roxo
*'''HEAD:''' Rosa
*'''OPTIONS:''' Marrom
*'''PROPFIND:''' Bege
</div>

[[Image: CGWebRequest_02.png|400px|centro]]

=== Nome ===
<div align="justify">
A coluna '''request''' da tabela permite a personalização do nome da requisição. Para adicionar um nome ou editá-lo, basta dar dois cliques na linha em questão, o que habilitará o cursor para digitação.
</div>

[[Image: CGWebRequest_03.png|400px|centro]]

=== Adicionar ===
<div align="justify">
Para adicionar uma nova requisição basta selecionar a última linha da tabela de requisições e personalizá-la com o verbo e o nome desejados. Sempre que o usuário modifica essa última linha, o programa automaticamente cria a próxima linha em branco.
</div>

=== Menu de Contexto ===
<div align="justify">
Clicar com o botão direito em alguma requisição irá exibir um menu de contexto com 3 opções:

[[Image: CGWebRequest_04.png|400px|centro]]

*'''Duplicate:''' Essa opção duplica a requisição selecionada, criando uma igual na última linha da tabela.
*'''Delete:''' Essa opção exclui a requisição selecionada.
*'''Exportar Curl:''' Essa opção exibe uma janela com a requisição selecionada formatada no padrão cURL. Para mais detalhes veja [[CGWebRequestClient#Exportar Curl|Exportar Curl]].
</div>

== Requisição ==
<div align="justify">
O painel de requisição é onde os detalhes podem ser configurados. O verbo selecionado (pode ser feito no painel de coleção, à esquerda) é exibido junto com sua respectiva cor de referência. Logo ao lado fica a caixa de texto da URL e, mais abaixo, um painel com abas que permitem as mais diversas configurações.

[[Image: CGWebRequest_16.png|750px|centro]]

=== URL ===
</div>
<div align="justify">
A caixa de texto da URL pode ser preenchida com o endereço desejado. Tendo feito isso, o valor preenchido previamente ficará salvo automaticamente. Dessa forma, o usuário pode navegar entre uma requisição e outra sem perder uma URL previamente digitada Ou seja, sempre que uma determinada requisição for selecionada no painel de coleção, a URL dela será exibida no painel de requisição.

</div>
<div align="justify">
Ao lado da barra de URL localiza-se o botão '''Enviar''', que, como o nome sugere, faz o envio da requisição. Ao clicar nele, o programa irá trabalhar para executar os comandos com base na configuração previamente estabelecida. Para que se obtenha sucesso, é necessário configurar todos os campos previamente.
</div>

[[Image: CGWebRequest_05(2).png|750px|centro]]

=== Env ===
<div align="justify">
Nessa aba do painel de configuração de requisição é possível configurar uma série de variáveis que podem facilitar a interação com diferentes requisições. É possível visualizar e editar variáveis conforme for desejado. Para tanto, basta utilizar um clique duplo na célula em questão, o que habilita o editor, permitindo a alteração por parte do usuário.
</div>
<div align="justify">
Para criar uma variável, tal qual na tabela de coleção, basta clicar na última linha e digitar o nome e o valor desejado. Sempre que uma nova variável é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>
<div align="justify">
Toda variável possui um nome e um valor, que estão representadas nas colunas '''Variable''' e '''Value'''. O nome de uma variável pode ser incluído em uma URL para facilitar sua alteração quando várias requisições possuem uma mesma URL. Para incluir a variável dessa forma, basta utilizar o nome dela entre chaves '''{{}}''' (chaves duplas):
</div>

<div align="justify">
*'''Nome:''' API
*'''Valor:''' <nowiki>/https://minhaapi.com/exemplo</nowiki>
*'''URL:''' <nowiki>{{API}}</nowiki>/login
</div>

[[Image: CGWebRequest_06(2).png|centro]]

=== Query ===
<div align="justify">
As queries de uma requisição ficam representadas na aba '''Query''' da tabela de configuração de requisição. Quando uma URL possui queries, o programa automaticamente faz a quebra dela, mantendo o texto até o '''?''' na parte superior e o dividindo o restante em linhas de uma tabela, onde é possível visualizá-las em detalhes.
</div>
<div align="justify">
Também é possível inserir queries manualmente, preenchendo o parâmetro e o valor ao utilizar um clique duplo na célula desejada. Da mesma forma que nas outras tabelas, sempre que uma nova linha é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>

==== Parâmetros e valores ====
São representados pelas colunas da tabela de queries. Quando estão presentes na URL colada na barra de texto acima, o programa os identifica automaticamente. É possível editá-los após isso.

Além do mais, na última coluna dessa tabela sempre haverá um checkbox que inicia marcado por padrão. Quando marcada, o programa incluirá a query na requisição, é possível desmarcá-la para que a query em questão seja ignorada. É uma forma prática de alterar a requisição sem ter de refazê-la ou criar uma nova.
</div>

[[Image: CGWebRequest_07(2).png|centro]]

=== Headers ===
<div align="justify">
Nesta aba é possível inserir e editar os cabeçalhos de uma requisição. Com funcionamento semelhante à aba '''Query''', os headers possuem um nome e um valor, representados pelas colunas '''Header''' e '''Value'''. Eles podem ser editados utilizando-se um clique duplo na célula desejada e novos podem ser criados selecionando a última linha da tabela. Sempre que a última linha é preenchida, uma nova linha em branco é criada automaticamente no final da tabela.

Há um checkbox na última coluna dessa tabela, que permite selecionar se um header deve, ou não, ser enviado junto com a requisição. O checkbox vem marcado por padrão. É comum que requisições diferentes possuam headers iguais, portanto essa opção é muito útil.
</div>

[[Image: CGWebRequest_08(2).png|centro]]

=== Body ===
<div align="justify">
Esta aba permite personalizar o corpo da requisição. Ela é subdividida entre outras 3 abas, que servem para selecionar o tipo, o formato no qual o body será enviado. É necessário selecionar o tipo compatível com a requisição desejada. Os tipos disponíveis são: JSON, XML e RAW.

Além disso, há uma caixa de texto onde o código do body pode ser digitado livremente. O conteúdo ali contido será enviado com a requisição. Abaixo, um exemplo de um body do tipo JSON:

[[Image: CGWebRequest_09(2).png|centro]]

*'''Limpar:''' Botão que limpa todo o conteúdo do body quando clicado.
*'''Abrir:''' Botão que permite ler o conteúdo de uma arquivo externo e adicioná-lo ao body. É necessário que o arquivo seja do tipo JSON. Quando lido, o conteúdo será exibido na caixa de texto destinada ao body, abaixo dos botões.
</div>

== Resposta ==
<div align="justify">
O painel inferior do lado direito é destinado a tudo aquilo que for retornado pela requisição.

*'''Código:''' No canto superior esquerdo desse painel ficará registrado o código de status da resposta. É o primeiro indicativo de sucesso ou fracasso de uma requisição, e sempre será exibido assim que ela for completada (se for completada).

*'''Tempo:''' O tempo de requisição é exibido logo ao lado do código de status, e registra em segundos a duração desde o envio da requisição até o recebimento da resposta.

*'''Botão Salvar:''' Fica no canto superior direito desse painel, e permite salvar o conteúdo da resposta em uma arquivo JSON.

[[Image: CGWebRequest_10(2).png|750px|centro]]
</div>

=== Response ===
<div align="justify">
Aba que exibe um campo de texto com o corpo da resposta. Como pode variar muito, o campo destinado a ela e é extenso e possui barras de rolagem para facilitar a navegação. A imagem acima mostra um exemplo de resposta no formato JSON.
</div>

=== Headers ===
<div align="justify">
Nessa aba é possível visualizar os cabeçalhos da resposta. Eles ficam exibidos em uma tabela com duas colunas: '''Header''' e '''Value''', que representam o nome e o valor de cada header. É possível visualizar um exemplo na imagem abaixo:

[[Image: CGWebRequest_11.png|500px|centro]]
</div>

== Menu superior ==

=== Collection ===
<div align="justify">
Esta opção permite controlar coleções, grupos de requisições criadas pelo usuário. Por padrão, as requisições exibidas no painel de coleção (no lado esquerdo da tela) fazem parte de uma coleção que é salva automaticamente sempre que o programa é fechado. O arquivo '''Collection.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

Além da lista de requisições, o arquivo também guarda a configuração de timeout definida pelo usuário (para mais detalhes ver [[CGWebRequestClient#Timeout|Timeout]]).

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de coleção para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. A coleção carregada será exibida no painel de coleção.

*'''Salvar:''' Essa opção permite salvar a coleção atual em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de coleção ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.

[[Image: CGWebRequest_12.png|750px|centro]]
</div>

=== Environment ===
<div align="justify">
Esta do menu superior permite controlar os ambientes, grupos de variáveis criadas pelo usuário. Por padrão, as variáveis exibidas na aba '''Env''' do painel de configuração de requisição (no lado superior direito da tela) fazem parte de um arquivo que é salvo automaticamente sempre que o programa é fechado. O arquivo '''Env.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de environment para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. As variáveis carregadas serão exibidas na aba '''Env''' do painel de configuração de requisição.

*'''Salvar:''' Essa opção permite salvar as variáveis atuais em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de environment ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.
</div>

=== Opções ===

==== Exportar Curl ====
<div align="justify">
Essa opção abre uma janela que exibe a requisição selecionada formatada no padrão cURL. É possível aumentar e diminuir a janela, o que pode facilitar a visualização no caso de requisições com conteúdo mais extenso.

Vale ressaltar que a requisição exibida sempre será aquela que estiver selecionada no momento.

[[Image: CGWebRequest_13.png|centro]]

*'''Copiar:''' Copia a cURL para a área de transferência. Uma mensagem aparece na parte debaixo da janela, confirmando a ação.
*'''Salvar:''' Abre uma janela que permite salvar a cURL em um arquivo de texto.
</div>

==== Timeout ====
<div align="justify">
Essa opção abre uma janela onde é possível configurar o timeout geral para todas as requisições, que é medido em segundos. O valor pode ser inserido diretamente no campo '''Tempo em segundos''' ou pode ser incrementado de um em um através das setas disponíveis no componente.

Vale ressaltar que, quando o programa é fechado, o timeout configurado é salvo junto com a coleção atual. Quando ela for carregada novamente, seja na inicialização do programa ou via arquivo, o timeout também se manterá.

[[Image: CGWebRequest_14.png|450px|centro]]

*'''OK:''' Salva as configurações feitas e fecha a janela.
*'''Cancelar:''' Fecha a janela sem salvar as alterações feitas.
</div>

=== Ajuda ===
<div align="justify">
Essa opção do menu possui algumas informações que podem ser úteis e informativas para o usuário.
</div>

==== Sobre ====
<div align="justify">
Abre uma janela com informações sobre o programa.

[[Image: CGWebRequest_15.png|450px|centro]]
</div>

<div align="justify">

==== Página da Wiki ====
Essa opção abre o link externo que leva até esta página.
</div>

CGWebRequestClient

2026-07-20T14:08:11Z

Vinicius.moder: /* Sobre */

<div align="justify">
O '''CIGAM Web Request Client''' é uma ferramenta destinada à criação, ao envio e à validação de requisições. Com ele, é possível configurar métodos HTTP, URLs, parâmetros de query, headers, bodies, tempo de requisição e variáveis reutilizáveis, além de visualizar o código de status, o conteúdo e os headers das respostas.

Abaixo, detalhamos cada uma de suas funcionalidades para guiar a utilização correta da aplicação.
</div>

== Tela inicial ==
<div align="justify">
Ao iniciar, o programa exibirá uma janela completa dividida em 3 sessões principais, além do menu superior. O painel mais à esquerda exibe a coleção ativa e permite a criação de novas requisições. O painel superior à direita exibe detalhes da requisição atualmente selecionada, enquanto o painel inferior à direita exibe informações sobre a resposta da requisição atual, se houver.

A largura ou a altura desses painéis pode ser modificada pelo usuário ao parar o mouse na linha que as divide, clicar e arrastar. Isso pode facilitar a visualização em casos onde há muita informação relevante na tela.
</div>

[[Image: CGWebRequest_01.png|750px|centro]]

== Coleção ==
<div align="justify">
Nesse painel, ficam exibidas, de forma simplificada, todas as requisições criadas pelo usuário, em forma de tabela. Em uma das colunas, é exibido o verbo selecionado para cada requisição (que pode ser alterado a qualquer momento) e na outra é exibido o nome da requisição, que pode ser personalizado pelo usuário.
</div>

=== Verbo ===
<div align="justify">
Para escolher ou alterar o verbo de uma requisição basta clicar na seta que fica no lado direito da caixa de seleção na coluna '''verb''' no painel da coleção. Uma lista com os verbos disponíveis será exibida, então basta selecionar o desejado. Note-se que cada um deles possui uma cor específica, facilitando a visualização e compreensão. Os verbos disponíveis são:

*'''GET:''' Azul
*'''POST:''' Verde
*'''PUT:''' Amarelo
*'''DELETE:''' Vermelho
*'''PATCH:''' Roxo
*'''HEAD:''' Rosa
*'''OPTIONS:''' Marrom
*'''PROPFIND:''' Bege
</div>

[[Image: CGWebRequest_02.png|400px|centro]]

=== Nome ===
<div align="justify">
A coluna '''request''' da tabela permite a personalização do nome da requisição. Para adicionar um nome ou editá-lo, basta dar dois cliques na linha em questão, o que habilitará o cursor para digitação.
</div>

[[Image: CGWebRequest_03.png|400px|centro]]

=== Adicionar ===
<div align="justify">
Para adicionar uma nova requisição basta selecionar a última linha da tabela de requisições e personalizá-la com o verbo e o nome desejados. Sempre que o usuário modifica essa última linha, o programa automaticamente cria a próxima linha em branco.
</div>

=== Menu de Contexto ===
<div align="justify">
Clicar com o botão direito em alguma requisição irá exibir um menu de contexto com 3 opções:

[[Image: CGWebRequest_04.png|400px|centro]]

*'''Duplicate:''' Essa opção duplica a requisição selecionada, criando uma igual na última linha da tabela.
*'''Delete:''' Essa opção exclui a requisição selecionada.
*'''Exportar Curl:''' Essa opção exibe uma janela com a requisição selecionada formatada no padrão cURL. Para mais detalhes veja [[CGWebRequestClient#Exportar Curl|Exportar Curl]].
</div>

== Requisição ==
<div align="justify">
O painel de requisição é onde os detalhes podem ser configurados. O verbo selecionado (pode ser feito no painel de coleção, à esquerda) é exibido junto com sua respectiva cor de referência. Logo ao lado fica a caixa de texto da URL e, mais abaixo, um painel com abas que permitem as mais diversas configurações.

[[Image: CGWebRequest_16.png|750px|centro]]

=== URL ===
</div>
<div align="justify">
A caixa de texto da URL pode ser preenchida com o endereço desejado. Tendo feito isso, o valor preenchido previamente ficará salvo automaticamente. Dessa forma, o usuário pode navegar entre uma requisição e outra sem perder uma URL previamente digitada Ou seja, sempre que uma determinada requisição for selecionada no painel de coleção, a URL dela será exibida no painel de requisição.

</div>
<div align="justify">
Ao lado da barra de URL localiza-se o botão '''Enviar''', que, como o nome sugere, faz o envio da requisição. Ao clicar nele, o programa irá trabalhar para executar os comandos com base na configuração previamente estabelecida. Para que se obtenha sucesso, é necessário configurar todos os campos previamente.
</div>

[[Image: CGWebRequest_05(2).png|750px|centro]]

=== Env ===
<div align="justify">
Nessa aba do painel de configuração de requisição é possível configurar uma série de variáveis que podem facilitar a interação com diferentes requisições. É possível visualizar e editar variáveis conforme for desejado. Para tanto, basta utilizar um clique duplo na célula em questão, o que habilita o editor, permitindo a alteração por parte do usuário.
</div>
<div align="justify">
Para criar uma variável, tal qual na tabela de coleção, basta clicar na última linha e digitar o nome e o valor desejado. Sempre que uma nova variável é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>
<div align="justify">
Toda variável possui um nome e um valor, que estão representadas nas colunas '''Variable''' e '''Value'''. O nome de uma variável pode ser incluído em uma URL para facilitar sua alteração quando várias requisições possuem uma mesma URL. Para incluir a variável dessa forma, basta utilizar o nome dela entre chaves '''{{}}''' (chaves duplas):
</div>

<div align="justify">
*'''Nome:''' API
*'''Valor:''' <nowiki>/https://minhaapi.com/exemplo</nowiki>
*'''URL:''' <nowiki>{{API}}</nowiki>/login
</div>

[[Image: CGWebRequest_06(2).png|centro]]

=== Query ===
<div align="justify">
As queries de uma requisição ficam representadas na aba '''Query''' da tabela de configuração de requisição. Quando uma URL possui queries, o programa automaticamente faz a quebra dela, mantendo o texto até o '''?''' na parte superior e o dividindo o restante em linhas de uma tabela, onde é possível visualizá-las em detalhes.
</div>
<div align="justify">
Também é possível inserir queries manualmente, preenchendo o parâmetro e o valor ao utilizar um clique duplo na célula desejada. Da mesma forma que nas outras tabelas, sempre que uma nova linha é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>

==== Parâmetros e valores ====
São representados pelas colunas da tabela de queries. Quando estão presentes na URL colada na barra de texto acima, o programa os identifica automaticamente. É possível editá-los após isso.

Além do mais, na última coluna dessa tabela sempre haverá um checkbox que inicia marcado por padrão. Quando marcada, o programa incluirá a query na requisição, é possível desmarcá-la para que a query em questão seja ignorada. É uma forma prática de alterar a requisição sem ter de refazê-la ou criar uma nova.
</div>

[[Image: CGWebRequest_07(2).png|centro]]

=== Headers ===
<div align="justify">
Nesta aba é possível inserir e editar os cabeçalhos de uma requisição. Com funcionamento semelhante à aba '''Query''', os headers possuem um nome e um valor, representados pelas colunas '''Header''' e '''Value'''. Eles podem ser editados utilizando-se um clique duplo na célula desejada e novos podem ser criados selecionando a última linha da tabela. Sempre que a última linha é preenchida, uma nova linha em branco é criada automaticamente no final da tabela.

Há um checkbox na última coluna dessa tabela, que permite selecionar se um header deve, ou não, ser enviado junto com a requisição. O checkbox vem marcado por padrão. É comum que requisições diferentes possuam headers iguais, portanto essa opção é muito útil.
</div>

[[Image: CGWebRequest_08(2).png|centro]]

=== Body ===
<div align="justify">
Esta aba permite personalizar o corpo da requisição. Ela é subdividida entre outras 3 abas, que servem para selecionar o tipo, o formato no qual o body será enviado. É necessário selecionar o tipo compatível com a requisição desejada. Os tipos disponíveis são: JSON, XML e RAW.

Além disso, há uma caixa de texto onde o código do body pode ser digitado livremente. O conteúdo ali contido será enviado com a requisição. Abaixo, um exemplo de um body do tipo JSON:

[[Image: CGWebRequest_09(2).png|centro]]

*'''Limpar:''' Botão que limpa todo o conteúdo do body quando clicado.
*'''Abrir:''' Botão que permite ler o conteúdo de uma arquivo externo e adicioná-lo ao body. É necessário que o arquivo seja do tipo JSON. Quando lido, o conteúdo será exibido na caixa de texto destinada ao body, abaixo dos botões.
</div>

== Resposta ==
<div align="justify">
O painel inferior do lado direito é destinado a tudo aquilo que for retornado pela requisição.

*'''Código:''' No canto superior esquerdo desse painel ficará registrado o código de status da resposta. É o primeiro indicativo de sucesso ou fracasso de uma requisição, e sempre será exibido assim que ela for completada (se for completada).

*'''Tempo:''' O tempo de requisição é exibido logo ao lado do código de status, e registra em segundos a duração desde o envio da requisição até o recebimento da resposta.

*'''Botão Salvar:''' Fica no canto superior direito desse painel, e permite salvar o conteúdo da resposta em uma arquivo JSON.

[[Image: CGWebRequest_10(2).png|750px|centro]]
</div>

=== Response ===
<div align="justify">
Aba que exibe um campo de texto com o corpo da resposta. Como pode variar muito, o campo destinado a ela e é extenso e possui barras de rolagem para facilitar a navegação. A imagem acima mostra um exemplo de resposta no formato JSON.
</div>

=== Headers ===
<div align="justify">
Nessa aba é possível visualizar os cabeçalhos da resposta. Eles ficam exibidos em uma tabela com duas colunas: '''Header''' e '''Value''', que representam o nome e o valor de cada header. É possível visualizar um exemplo na imagem abaixo:

[[Image: CGWebRequest_11.png|500px|centro]]
</div>

== Menu superior ==

=== Collection ===
<div align="justify">
Esta opção permite controlar coleções, grupos de requisições criadas pelo usuário. Por padrão, as requisições exibidas no painel de coleção (no lado esquerdo da tela) fazem parte de uma coleção que é salva automaticamente sempre que o programa é fechado. O arquivo '''Collection.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

Além da lista de requisições, o arquivo também guarda a configuração de timeout definida pelo usuário (para mais detalhes ver [[CGWebRequestClient#Timeout|Timeout]]).

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de coleção para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. A coleção carregada será exibida no painel de coleção.

*'''Salvar:''' Essa opção permite salvar a coleção atual em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de coleção ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.

[[Image: CGWebRequest_12.png|750px|centro]]
</div>

=== Environment ===
<div align="justify">
Esta do menu superior permite controlar os ambientes, grupos de variáveis criadas pelo usuário. Por padrão, as variáveis exibidas na aba '''Env''' do do painel de configuração de requisição (no lado superior direito da tela) fazem parte de um arquivo que é salvo automaticamente sempre que o programa é fechado. O arquivo '''Env.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de environment para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. As variáveis carregadas serão exibidas na aba '''Env''' do painel de configuração de requisição.

*'''Salvar:''' Essa opção permite salvar as variáveis atuais em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de environment ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.
</div>

=== Opções ===

==== Exportar Curl ====
<div align="justify">
Essa opção abre uma janela que exibe a requisição selecionada formatada no padrão cURL. É possível aumentar e diminuir a janela, o que pode facilitar a visualização no caso de requisições com conteúdo mais extenso.

Vale ressaltar que a requisição exibida sempre será aquela que estiver selecionada no momento.

[[Image: CGWebRequest_13.png|centro]]

*'''Copiar:''' Copia a cURL para a área de transferência. Uma mensagem aparece na parte debaixo da janela, confirmando a ação.
*'''Salvar:''' Abre uma janela que permite salvar a cURL em um arquivo de texto.
</div>

==== Timeout ====
<div align="justify">
Essa opção abre uma janela onde é possível configurar o timeout geral para todas as requisições, que é medido em segundos. O valor pode ser inserido diretamente no campo '''Tempo em segundos''' ou pode ser incrementado de um em um através das setas disponíveis no componente.

Vale ressaltar que, quando o programa é fechado, o timeout configurado é salvo junto com a coleção atual. Quando ela for carregada novamente, seja na inicialização do programa ou via arquivo, o timeout também se manterá.

[[Image: CGWebRequest_14.png|450px|centro]]

*'''OK:''' Salva as configurações feitas e fecha a janela.
*'''Cancelar:''' Fecha a janela sem salvar as alterações feitas.
</div>

=== Ajuda ===
<div align="justify">
Essa opção do menu possui algumas informações que podem ser úteis e informativas para o usuário.
</div>

==== Sobre ====
<div align="justify">
Abre uma janela com informações sobre o programa.

[[Image: CGWebRequest_15.png|450px|centro]]
</div>

<div align="justify">

==== Página da Wiki ====
Essa opção abre o link externo que leva até esta página.
</div>

CGWebRequestClient

2026-07-20T14:07:51Z

Vinicius.moder: /* Tela inicial */

<div align="justify">
O '''CIGAM Web Request Client''' é uma ferramenta destinada à criação, ao envio e à validação de requisições. Com ele, é possível configurar métodos HTTP, URLs, parâmetros de query, headers, bodies, tempo de requisição e variáveis reutilizáveis, além de visualizar o código de status, o conteúdo e os headers das respostas.

Abaixo, detalhamos cada uma de suas funcionalidades para guiar a utilização correta da aplicação.
</div>

== Tela inicial ==
<div align="justify">
Ao iniciar, o programa exibirá uma janela completa dividida em 3 sessões principais, além do menu superior. O painel mais à esquerda exibe a coleção ativa e permite a criação de novas requisições. O painel superior à direita exibe detalhes da requisição atualmente selecionada, enquanto o painel inferior à direita exibe informações sobre a resposta da requisição atual, se houver.

A largura ou a altura desses painéis pode ser modificada pelo usuário ao parar o mouse na linha que as divide, clicar e arrastar. Isso pode facilitar a visualização em casos onde há muita informação relevante na tela.
</div>

[[Image: CGWebRequest_01.png|750px|centro]]

== Coleção ==
<div align="justify">
Nesse painel, ficam exibidas, de forma simplificada, todas as requisições criadas pelo usuário, em forma de tabela. Em uma das colunas, é exibido o verbo selecionado para cada requisição (que pode ser alterado a qualquer momento) e na outra é exibido o nome da requisição, que pode ser personalizado pelo usuário.
</div>

=== Verbo ===
<div align="justify">
Para escolher ou alterar o verbo de uma requisição basta clicar na seta que fica no lado direito da caixa de seleção na coluna '''verb''' no painel da coleção. Uma lista com os verbos disponíveis será exibida, então basta selecionar o desejado. Note-se que cada um deles possui uma cor específica, facilitando a visualização e compreensão. Os verbos disponíveis são:

*'''GET:''' Azul
*'''POST:''' Verde
*'''PUT:''' Amarelo
*'''DELETE:''' Vermelho
*'''PATCH:''' Roxo
*'''HEAD:''' Rosa
*'''OPTIONS:''' Marrom
*'''PROPFIND:''' Bege
</div>

[[Image: CGWebRequest_02.png|400px|centro]]

=== Nome ===
<div align="justify">
A coluna '''request''' da tabela permite a personalização do nome da requisição. Para adicionar um nome ou editá-lo, basta dar dois cliques na linha em questão, o que habilitará o cursor para digitação.
</div>

[[Image: CGWebRequest_03.png|400px|centro]]

=== Adicionar ===
<div align="justify">
Para adicionar uma nova requisição basta selecionar a última linha da tabela de requisições e personalizá-la com o verbo e o nome desejados. Sempre que o usuário modifica essa última linha, o programa automaticamente cria a próxima linha em branco.
</div>

=== Menu de Contexto ===
<div align="justify">
Clicar com o botão direito em alguma requisição irá exibir um menu de contexto com 3 opções:

[[Image: CGWebRequest_04.png|400px|centro]]

*'''Duplicate:''' Essa opção duplica a requisição selecionada, criando uma igual na última linha da tabela.
*'''Delete:''' Essa opção exclui a requisição selecionada.
*'''Exportar Curl:''' Essa opção exibe uma janela com a requisição selecionada formatada no padrão cURL. Para mais detalhes veja [[CGWebRequestClient#Exportar Curl|Exportar Curl]].
</div>

== Requisição ==
<div align="justify">
O painel de requisição é onde os detalhes podem ser configurados. O verbo selecionado (pode ser feito no painel de coleção, à esquerda) é exibido junto com sua respectiva cor de referência. Logo ao lado fica a caixa de texto da URL e, mais abaixo, um painel com abas que permitem as mais diversas configurações.

[[Image: CGWebRequest_16.png|750px|centro]]

=== URL ===
</div>
<div align="justify">
A caixa de texto da URL pode ser preenchida com o endereço desejado. Tendo feito isso, o valor preenchido previamente ficará salvo automaticamente. Dessa forma, o usuário pode navegar entre uma requisição e outra sem perder uma URL previamente digitada Ou seja, sempre que uma determinada requisição for selecionada no painel de coleção, a URL dela será exibida no painel de requisição.

</div>
<div align="justify">
Ao lado da barra de URL localiza-se o botão '''Enviar''', que, como o nome sugere, faz o envio da requisição. Ao clicar nele, o programa irá trabalhar para executar os comandos com base na configuração previamente estabelecida. Para que se obtenha sucesso, é necessário configurar todos os campos previamente.
</div>

[[Image: CGWebRequest_05(2).png|750px|centro]]

=== Env ===
<div align="justify">
Nessa aba do painel de configuração de requisição é possível configurar uma série de variáveis que podem facilitar a interação com diferentes requisições. É possível visualizar e editar variáveis conforme for desejado. Para tanto, basta utilizar um clique duplo na célula em questão, o que habilita o editor, permitindo a alteração por parte do usuário.
</div>
<div align="justify">
Para criar uma variável, tal qual na tabela de coleção, basta clicar na última linha e digitar o nome e o valor desejado. Sempre que uma nova variável é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>
<div align="justify">
Toda variável possui um nome e um valor, que estão representadas nas colunas '''Variable''' e '''Value'''. O nome de uma variável pode ser incluído em uma URL para facilitar sua alteração quando várias requisições possuem uma mesma URL. Para incluir a variável dessa forma, basta utilizar o nome dela entre chaves '''{{}}''' (chaves duplas):
</div>

<div align="justify">
*'''Nome:''' API
*'''Valor:''' <nowiki>/https://minhaapi.com/exemplo</nowiki>
*'''URL:''' <nowiki>{{API}}</nowiki>/login
</div>

[[Image: CGWebRequest_06(2).png|centro]]

=== Query ===
<div align="justify">
As queries de uma requisição ficam representadas na aba '''Query''' da tabela de configuração de requisição. Quando uma URL possui queries, o programa automaticamente faz a quebra dela, mantendo o texto até o '''?''' na parte superior e o dividindo o restante em linhas de uma tabela, onde é possível visualizá-las em detalhes.
</div>
<div align="justify">
Também é possível inserir queries manualmente, preenchendo o parâmetro e o valor ao utilizar um clique duplo na célula desejada. Da mesma forma que nas outras tabelas, sempre que uma nova linha é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>

==== Parâmetros e valores ====
São representados pelas colunas da tabela de queries. Quando estão presentes na URL colada na barra de texto acima, o programa os identifica automaticamente. É possível editá-los após isso.

Além do mais, na última coluna dessa tabela sempre haverá um checkbox que inicia marcado por padrão. Quando marcada, o programa incluirá a query na requisição, é possível desmarcá-la para que a query em questão seja ignorada. É uma forma prática de alterar a requisição sem ter de refazê-la ou criar uma nova.
</div>

[[Image: CGWebRequest_07(2).png|centro]]

=== Headers ===
<div align="justify">
Nesta aba é possível inserir e editar os cabeçalhos de uma requisição. Com funcionamento semelhante à aba '''Query''', os headers possuem um nome e um valor, representados pelas colunas '''Header''' e '''Value'''. Eles podem ser editados utilizando-se um clique duplo na célula desejada e novos podem ser criados selecionando a última linha da tabela. Sempre que a última linha é preenchida, uma nova linha em branco é criada automaticamente no final da tabela.

Há um checkbox na última coluna dessa tabela, que permite selecionar se um header deve, ou não, ser enviado junto com a requisição. O checkbox vem marcado por padrão. É comum que requisições diferentes possuam headers iguais, portanto essa opção é muito útil.
</div>

[[Image: CGWebRequest_08(2).png|centro]]

=== Body ===
<div align="justify">
Esta aba permite personalizar o corpo da requisição. Ela é subdividida entre outras 3 abas, que servem para selecionar o tipo, o formato no qual o body será enviado. É necessário selecionar o tipo compatível com a requisição desejada. Os tipos disponíveis são: JSON, XML e RAW.

Além disso, há uma caixa de texto onde o código do body pode ser digitado livremente. O conteúdo ali contido será enviado com a requisição. Abaixo, um exemplo de um body do tipo JSON:

[[Image: CGWebRequest_09(2).png|centro]]

*'''Limpar:''' Botão que limpa todo o conteúdo do body quando clicado.
*'''Abrir:''' Botão que permite ler o conteúdo de uma arquivo externo e adicioná-lo ao body. É necessário que o arquivo seja do tipo JSON. Quando lido, o conteúdo será exibido na caixa de texto destinada ao body, abaixo dos botões.
</div>

== Resposta ==
<div align="justify">
O painel inferior do lado direito é destinado a tudo aquilo que for retornado pela requisição.

*'''Código:''' No canto superior esquerdo desse painel ficará registrado o código de status da resposta. É o primeiro indicativo de sucesso ou fracasso de uma requisição, e sempre será exibido assim que ela for completada (se for completada).

*'''Tempo:''' O tempo de requisição é exibido logo ao lado do código de status, e registra em segundos a duração desde o envio da requisição até o recebimento da resposta.

*'''Botão Salvar:''' Fica no canto superior direito desse painel, e permite salvar o conteúdo da resposta em uma arquivo JSON.

[[Image: CGWebRequest_10(2).png|750px|centro]]
</div>

=== Response ===
<div align="justify">
Aba que exibe um campo de texto com o corpo da resposta. Como pode variar muito, o campo destinado a ela e é extenso e possui barras de rolagem para facilitar a navegação. A imagem acima mostra um exemplo de resposta no formato JSON.
</div>

=== Headers ===
<div align="justify">
Nessa aba é possível visualizar os cabeçalhos da resposta. Eles ficam exibidos em uma tabela com duas colunas: '''Header''' e '''Value''', que representam o nome e o valor de cada header. É possível visualizar um exemplo na imagem abaixo:

[[Image: CGWebRequest_11.png|500px|centro]]
</div>

== Menu superior ==

=== Collection ===
<div align="justify">
Esta opção permite controlar coleções, grupos de requisições criadas pelo usuário. Por padrão, as requisições exibidas no painel de coleção (no lado esquerdo da tela) fazem parte de uma coleção que é salva automaticamente sempre que o programa é fechado. O arquivo '''Collection.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

Além da lista de requisições, o arquivo também guarda a configuração de timeout definida pelo usuário (para mais detalhes ver [[CGWebRequestClient#Timeout|Timeout]]).

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de coleção para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. A coleção carregada será exibida no painel de coleção.

*'''Salvar:''' Essa opção permite salvar a coleção atual em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de coleção ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.

[[Image: CGWebRequest_12.png|750px|centro]]
</div>

=== Environment ===
<div align="justify">
Esta do menu superior permite controlar os ambientes, grupos de variáveis criadas pelo usuário. Por padrão, as variáveis exibidas na aba '''Env''' do do painel de configuração de requisição (no lado superior direito da tela) fazem parte de um arquivo que é salvo automaticamente sempre que o programa é fechado. O arquivo '''Env.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de environment para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. As variáveis carregadas serão exibidas na aba '''Env''' do painel de configuração de requisição.

*'''Salvar:''' Essa opção permite salvar as variáveis atuais em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de environment ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.
</div>

=== Opções ===

==== Exportar Curl ====
<div align="justify">
Essa opção abre uma janela que exibe a requisição selecionada formatada no padrão cURL. É possível aumentar e diminuir a janela, o que pode facilitar a visualização no caso de requisições com conteúdo mais extenso.

Vale ressaltar que a requisição exibida sempre será aquela que estiver selecionada no momento.

[[Image: CGWebRequest_13.png|centro]]

*'''Copiar:''' Copia a cURL para a área de transferência. Uma mensagem aparece na parte debaixo da janela, confirmando a ação.
*'''Salvar:''' Abre uma janela que permite salvar a cURL em um arquivo de texto.
</div>

==== Timeout ====
<div align="justify">
Essa opção abre uma janela onde é possível configurar o timeout geral para todas as requisições, que é medido em segundos. O valor pode ser inserido diretamente no campo '''Tempo em segundos''' ou pode ser incrementado de um em um através das setas disponíveis no componente.

Vale ressaltar que, quando o programa é fechado, o timeout configurado é salvo junto com a coleção atual. Quando ela for carregada novamente, seja na inicialização do programa ou via arquivo, o timeout também se manterá.

[[Image: CGWebRequest_14.png|450px|centro]]

*'''OK:''' Salva as configurações feitas e fecha a janela.
*'''Cancelar:''' Fecha a janela sem salvar as alterações feitas.
</div>

=== Ajuda ===
<div align="justify">
Essa opção do menu possui algumas informações que podem ser úteis e informativas para o usuário.
</div>

==== Sobre ====
<div align="justify">
Abre uma janela com informações sobre o '''CGWebRequest Client'''.

[[Image: CGWebRequest_15.png|450px|centro]]
</div>

<div align="justify">

==== Página da Wiki ====
Essa opção abre o link externo que leva até esta página.
</div>

CGWebRequestClient

2026-07-20T14:04:34Z

Vinicius.moder: /* URL */

<div align="justify">
O '''CIGAM Web Request Client''' é uma ferramenta destinada à criação, ao envio e à validação de requisições. Com ele, é possível configurar métodos HTTP, URLs, parâmetros de query, headers, bodies, tempo de requisição e variáveis reutilizáveis, além de visualizar o código de status, o conteúdo e os headers das respostas.

Abaixo, detalhamos cada uma de suas funcionalidades para guiar a utilização correta da aplicação.
</div>

== Tela inicial ==
<div align="justify">
Ao iniciar, o '''CGWebRequest Client''' exibirá uma janela completa dividida em 3 sessões principais, além do menu superior. O painel mais à esquerda exibe a coleção ativa e permite a criação de novas requisições. O painel superior à direita exibe detalhes da requisição atualmente selecionada, enquanto o painel inferior à direita exibe informações sobre a resposta da requisição atual, se houver.

A largura ou a altura desses painéis pode ser modificada pelo usuário ao parar o mouse na linha que as divide, clicar e arrastar. Isso pode facilitar a visualização em casos onde há muita informação relevante na tela.
</div>

[[Image: CGWebRequest_01.png|750px|centro]]

== Coleção ==
<div align="justify">
Nesse painel, ficam exibidas, de forma simplificada, todas as requisições criadas pelo usuário, em forma de tabela. Em uma das colunas, é exibido o verbo selecionado para cada requisição (que pode ser alterado a qualquer momento) e na outra é exibido o nome da requisição, que pode ser personalizado pelo usuário.
</div>

=== Verbo ===
<div align="justify">
Para escolher ou alterar o verbo de uma requisição basta clicar na seta que fica no lado direito da caixa de seleção na coluna '''verb''' no painel da coleção. Uma lista com os verbos disponíveis será exibida, então basta selecionar o desejado. Note-se que cada um deles possui uma cor específica, facilitando a visualização e compreensão. Os verbos disponíveis são:

*'''GET:''' Azul
*'''POST:''' Verde
*'''PUT:''' Amarelo
*'''DELETE:''' Vermelho
*'''PATCH:''' Roxo
*'''HEAD:''' Rosa
*'''OPTIONS:''' Marrom
*'''PROPFIND:''' Bege
</div>

[[Image: CGWebRequest_02.png|400px|centro]]

=== Nome ===
<div align="justify">
A coluna '''request''' da tabela permite a personalização do nome da requisição. Para adicionar um nome ou editá-lo, basta dar dois cliques na linha em questão, o que habilitará o cursor para digitação.
</div>

[[Image: CGWebRequest_03.png|400px|centro]]

=== Adicionar ===
<div align="justify">
Para adicionar uma nova requisição basta selecionar a última linha da tabela de requisições e personalizá-la com o verbo e o nome desejados. Sempre que o usuário modifica essa última linha, o programa automaticamente cria a próxima linha em branco.
</div>

=== Menu de Contexto ===
<div align="justify">
Clicar com o botão direito em alguma requisição irá exibir um menu de contexto com 3 opções:

[[Image: CGWebRequest_04.png|400px|centro]]

*'''Duplicate:''' Essa opção duplica a requisição selecionada, criando uma igual na última linha da tabela.
*'''Delete:''' Essa opção exclui a requisição selecionada.
*'''Exportar Curl:''' Essa opção exibe uma janela com a requisição selecionada formatada no padrão cURL. Para mais detalhes veja [[CGWebRequestClient#Exportar Curl|Exportar Curl]].
</div>

== Requisição ==
<div align="justify">
O painel de requisição é onde os detalhes podem ser configurados. O verbo selecionado (pode ser feito no painel de coleção, à esquerda) é exibido junto com sua respectiva cor de referência. Logo ao lado fica a caixa de texto da URL e, mais abaixo, um painel com abas que permitem as mais diversas configurações.

[[Image: CGWebRequest_16.png|750px|centro]]

=== URL ===
</div>
<div align="justify">
A caixa de texto da URL pode ser preenchida com o endereço desejado. Tendo feito isso, o valor preenchido previamente ficará salvo automaticamente. Dessa forma, o usuário pode navegar entre uma requisição e outra sem perder uma URL previamente digitada Ou seja, sempre que uma determinada requisição for selecionada no painel de coleção, a URL dela será exibida no painel de requisição.

</div>
<div align="justify">
Ao lado da barra de URL localiza-se o botão '''Enviar''', que, como o nome sugere, faz o envio da requisição. Ao clicar nele, o programa irá trabalhar para executar os comandos com base na configuração previamente estabelecida. Para que se obtenha sucesso, é necessário configurar todos os campos previamente.
</div>

[[Image: CGWebRequest_05(2).png|750px|centro]]

=== Env ===
<div align="justify">
Nessa aba do painel de configuração de requisição é possível configurar uma série de variáveis que podem facilitar a interação com diferentes requisições. É possível visualizar e editar variáveis conforme for desejado. Para tanto, basta utilizar um clique duplo na célula em questão, o que habilita o editor, permitindo a alteração por parte do usuário.
</div>
<div align="justify">
Para criar uma variável, tal qual na tabela de coleção, basta clicar na última linha e digitar o nome e o valor desejado. Sempre que uma nova variável é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>
<div align="justify">
Toda variável possui um nome e um valor, que estão representadas nas colunas '''Variable''' e '''Value'''. O nome de uma variável pode ser incluído em uma URL para facilitar sua alteração quando várias requisições possuem uma mesma URL. Para incluir a variável dessa forma, basta utilizar o nome dela entre chaves '''{{}}''' (chaves duplas):
</div>

<div align="justify">
*'''Nome:''' API
*'''Valor:''' <nowiki>/https://minhaapi.com/exemplo</nowiki>
*'''URL:''' <nowiki>{{API}}</nowiki>/login
</div>

[[Image: CGWebRequest_06(2).png|centro]]

=== Query ===
<div align="justify">
As queries de uma requisição ficam representadas na aba '''Query''' da tabela de configuração de requisição. Quando uma URL possui queries, o programa automaticamente faz a quebra dela, mantendo o texto até o '''?''' na parte superior e o dividindo o restante em linhas de uma tabela, onde é possível visualizá-las em detalhes.
</div>
<div align="justify">
Também é possível inserir queries manualmente, preenchendo o parâmetro e o valor ao utilizar um clique duplo na célula desejada. Da mesma forma que nas outras tabelas, sempre que uma nova linha é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>

==== Parâmetros e valores ====
São representados pelas colunas da tabela de queries. Quando estão presentes na URL colada na barra de texto acima, o programa os identifica automaticamente. É possível editá-los após isso.

Além do mais, na última coluna dessa tabela sempre haverá um checkbox que inicia marcado por padrão. Quando marcada, o programa incluirá a query na requisição, é possível desmarcá-la para que a query em questão seja ignorada. É uma forma prática de alterar a requisição sem ter de refazê-la ou criar uma nova.
</div>

[[Image: CGWebRequest_07(2).png|centro]]

=== Headers ===
<div align="justify">
Nesta aba é possível inserir e editar os cabeçalhos de uma requisição. Com funcionamento semelhante à aba '''Query''', os headers possuem um nome e um valor, representados pelas colunas '''Header''' e '''Value'''. Eles podem ser editados utilizando-se um clique duplo na célula desejada e novos podem ser criados selecionando a última linha da tabela. Sempre que a última linha é preenchida, uma nova linha em branco é criada automaticamente no final da tabela.

Há um checkbox na última coluna dessa tabela, que permite selecionar se um header deve, ou não, ser enviado junto com a requisição. O checkbox vem marcado por padrão. É comum que requisições diferentes possuam headers iguais, portanto essa opção é muito útil.
</div>

[[Image: CGWebRequest_08(2).png|centro]]

=== Body ===
<div align="justify">
Esta aba permite personalizar o corpo da requisição. Ela é subdividida entre outras 3 abas, que servem para selecionar o tipo, o formato no qual o body será enviado. É necessário selecionar o tipo compatível com a requisição desejada. Os tipos disponíveis são: JSON, XML e RAW.

Além disso, há uma caixa de texto onde o código do body pode ser digitado livremente. O conteúdo ali contido será enviado com a requisição. Abaixo, um exemplo de um body do tipo JSON:

[[Image: CGWebRequest_09(2).png|centro]]

*'''Limpar:''' Botão que limpa todo o conteúdo do body quando clicado.
*'''Abrir:''' Botão que permite ler o conteúdo de uma arquivo externo e adicioná-lo ao body. É necessário que o arquivo seja do tipo JSON. Quando lido, o conteúdo será exibido na caixa de texto destinada ao body, abaixo dos botões.
</div>

== Resposta ==
<div align="justify">
O painel inferior do lado direito é destinado a tudo aquilo que for retornado pela requisição.

*'''Código:''' No canto superior esquerdo desse painel ficará registrado o código de status da resposta. É o primeiro indicativo de sucesso ou fracasso de uma requisição, e sempre será exibido assim que ela for completada (se for completada).

*'''Tempo:''' O tempo de requisição é exibido logo ao lado do código de status, e registra em segundos a duração desde o envio da requisição até o recebimento da resposta.

*'''Botão Salvar:''' Fica no canto superior direito desse painel, e permite salvar o conteúdo da resposta em uma arquivo JSON.

[[Image: CGWebRequest_10(2).png|750px|centro]]
</div>

=== Response ===
<div align="justify">
Aba que exibe um campo de texto com o corpo da resposta. Como pode variar muito, o campo destinado a ela e é extenso e possui barras de rolagem para facilitar a navegação. A imagem acima mostra um exemplo de resposta no formato JSON.
</div>

=== Headers ===
<div align="justify">
Nessa aba é possível visualizar os cabeçalhos da resposta. Eles ficam exibidos em uma tabela com duas colunas: '''Header''' e '''Value''', que representam o nome e o valor de cada header. É possível visualizar um exemplo na imagem abaixo:

[[Image: CGWebRequest_11.png|500px|centro]]
</div>

== Menu superior ==

=== Collection ===
<div align="justify">
Esta opção permite controlar coleções, grupos de requisições criadas pelo usuário. Por padrão, as requisições exibidas no painel de coleção (no lado esquerdo da tela) fazem parte de uma coleção que é salva automaticamente sempre que o programa é fechado. O arquivo '''Collection.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

Além da lista de requisições, o arquivo também guarda a configuração de timeout definida pelo usuário (para mais detalhes ver [[CGWebRequestClient#Timeout|Timeout]]).

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de coleção para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. A coleção carregada será exibida no painel de coleção.

*'''Salvar:''' Essa opção permite salvar a coleção atual em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de coleção ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.

[[Image: CGWebRequest_12.png|750px|centro]]
</div>

=== Environment ===
<div align="justify">
Esta do menu superior permite controlar os ambientes, grupos de variáveis criadas pelo usuário. Por padrão, as variáveis exibidas na aba '''Env''' do do painel de configuração de requisição (no lado superior direito da tela) fazem parte de um arquivo que é salvo automaticamente sempre que o programa é fechado. O arquivo '''Env.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de environment para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. As variáveis carregadas serão exibidas na aba '''Env''' do painel de configuração de requisição.

*'''Salvar:''' Essa opção permite salvar as variáveis atuais em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de environment ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.
</div>

=== Opções ===

==== Exportar Curl ====
<div align="justify">
Essa opção abre uma janela que exibe a requisição selecionada formatada no padrão cURL. É possível aumentar e diminuir a janela, o que pode facilitar a visualização no caso de requisições com conteúdo mais extenso.

Vale ressaltar que a requisição exibida sempre será aquela que estiver selecionada no momento.

[[Image: CGWebRequest_13.png|centro]]

*'''Copiar:''' Copia a cURL para a área de transferência. Uma mensagem aparece na parte debaixo da janela, confirmando a ação.
*'''Salvar:''' Abre uma janela que permite salvar a cURL em um arquivo de texto.
</div>

==== Timeout ====
<div align="justify">
Essa opção abre uma janela onde é possível configurar o timeout geral para todas as requisições, que é medido em segundos. O valor pode ser inserido diretamente no campo '''Tempo em segundos''' ou pode ser incrementado de um em um através das setas disponíveis no componente.

Vale ressaltar que, quando o programa é fechado, o timeout configurado é salvo junto com a coleção atual. Quando ela for carregada novamente, seja na inicialização do programa ou via arquivo, o timeout também se manterá.

[[Image: CGWebRequest_14.png|450px|centro]]

*'''OK:''' Salva as configurações feitas e fecha a janela.
*'''Cancelar:''' Fecha a janela sem salvar as alterações feitas.
</div>

=== Ajuda ===
<div align="justify">
Essa opção do menu possui algumas informações que podem ser úteis e informativas para o usuário.
</div>

==== Sobre ====
<div align="justify">
Abre uma janela com informações sobre o '''CGWebRequest Client'''.

[[Image: CGWebRequest_15.png|450px|centro]]
</div>

<div align="justify">

==== Página da Wiki ====
Essa opção abre o link externo que leva até esta página.
</div>

CGWebRequestClient

2026-07-20T14:04:02Z

Vinicius.moder: /* Headers */

<div align="justify">
O '''CIGAM Web Request Client''' é uma ferramenta destinada à criação, ao envio e à validação de requisições. Com ele, é possível configurar métodos HTTP, URLs, parâmetros de query, headers, bodies, tempo de requisição e variáveis reutilizáveis, além de visualizar o código de status, o conteúdo e os headers das respostas.

Abaixo, detalhamos cada uma de suas funcionalidades para guiar a utilização correta da aplicação.
</div>

== Tela inicial ==
<div align="justify">
Ao iniciar, o '''CGWebRequest Client''' exibirá uma janela completa dividida em 3 sessões principais, além do menu superior. O painel mais à esquerda exibe a coleção ativa e permite a criação de novas requisições. O painel superior à direita exibe detalhes da requisição atualmente selecionada, enquanto o painel inferior à direita exibe informações sobre a resposta da requisição atual, se houver.

A largura ou a altura desses painéis pode ser modificada pelo usuário ao parar o mouse na linha que as divide, clicar e arrastar. Isso pode facilitar a visualização em casos onde há muita informação relevante na tela.
</div>

[[Image: CGWebRequest_01.png|750px|centro]]

== Coleção ==
<div align="justify">
Nesse painel, ficam exibidas, de forma simplificada, todas as requisições criadas pelo usuário, em forma de tabela. Em uma das colunas, é exibido o verbo selecionado para cada requisição (que pode ser alterado a qualquer momento) e na outra é exibido o nome da requisição, que pode ser personalizado pelo usuário.
</div>

=== Verbo ===
<div align="justify">
Para escolher ou alterar o verbo de uma requisição basta clicar na seta que fica no lado direito da caixa de seleção na coluna '''verb''' no painel da coleção. Uma lista com os verbos disponíveis será exibida, então basta selecionar o desejado. Note-se que cada um deles possui uma cor específica, facilitando a visualização e compreensão. Os verbos disponíveis são:

*'''GET:''' Azul
*'''POST:''' Verde
*'''PUT:''' Amarelo
*'''DELETE:''' Vermelho
*'''PATCH:''' Roxo
*'''HEAD:''' Rosa
*'''OPTIONS:''' Marrom
*'''PROPFIND:''' Bege
</div>

[[Image: CGWebRequest_02.png|400px|centro]]

=== Nome ===
<div align="justify">
A coluna '''request''' da tabela permite a personalização do nome da requisição. Para adicionar um nome ou editá-lo, basta dar dois cliques na linha em questão, o que habilitará o cursor para digitação.
</div>

[[Image: CGWebRequest_03.png|400px|centro]]

=== Adicionar ===
<div align="justify">
Para adicionar uma nova requisição basta selecionar a última linha da tabela de requisições e personalizá-la com o verbo e o nome desejados. Sempre que o usuário modifica essa última linha, o programa automaticamente cria a próxima linha em branco.
</div>

=== Menu de Contexto ===
<div align="justify">
Clicar com o botão direito em alguma requisição irá exibir um menu de contexto com 3 opções:

[[Image: CGWebRequest_04.png|400px|centro]]

*'''Duplicate:''' Essa opção duplica a requisição selecionada, criando uma igual na última linha da tabela.
*'''Delete:''' Essa opção exclui a requisição selecionada.
*'''Exportar Curl:''' Essa opção exibe uma janela com a requisição selecionada formatada no padrão cURL. Para mais detalhes veja [[CGWebRequestClient#Exportar Curl|Exportar Curl]].
</div>

== Requisição ==
<div align="justify">
O painel de requisição é onde os detalhes podem ser configurados. O verbo selecionado (pode ser feito no painel de coleção, à esquerda) é exibido junto com sua respectiva cor de referência. Logo ao lado fica a caixa de texto da URL e, mais abaixo, um painel com abas que permitem as mais diversas configurações.

[[Image: CGWebRequest_16.png|750px|centro]]

=== URL ===
</div>
<div align="justify">
A caixa de texto da URL pode ser preenchida com o endereço desejado. Tendo feito isso, o valor preenchido previamente ficará salvo automaticamente. Dessa forma, o usuário pode navegar entre uma requisição e outra sem perder uma URL previamente digitada Ou seja, sempre que uma determinada requisição for selecionada no painel de coleção, a URL dela será exibida no painel de requisição.

</div>
<div align="justify">
Ao lado da barra de URL localiza-se o botão '''Enviar''', que, como o nome sugere, faz o envio da requisição. Ao clicar nele, o programa irá trabalhar para executar os comandos com base na configuração previamente estabelecida. Para que haja se obtenha sucesso, é necessário configurar todos os campos previamente.
</div>

[[Image: CGWebRequest_05(2).png|750px|centro]]

=== Env ===
<div align="justify">
Nessa aba do painel de configuração de requisição é possível configurar uma série de variáveis que podem facilitar a interação com diferentes requisições. É possível visualizar e editar variáveis conforme for desejado. Para tanto, basta utilizar um clique duplo na célula em questão, o que habilita o editor, permitindo a alteração por parte do usuário.
</div>
<div align="justify">
Para criar uma variável, tal qual na tabela de coleção, basta clicar na última linha e digitar o nome e o valor desejado. Sempre que uma nova variável é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>
<div align="justify">
Toda variável possui um nome e um valor, que estão representadas nas colunas '''Variable''' e '''Value'''. O nome de uma variável pode ser incluído em uma URL para facilitar sua alteração quando várias requisições possuem uma mesma URL. Para incluir a variável dessa forma, basta utilizar o nome dela entre chaves '''{{}}''' (chaves duplas):
</div>

<div align="justify">
*'''Nome:''' API
*'''Valor:''' <nowiki>/https://minhaapi.com/exemplo</nowiki>
*'''URL:''' <nowiki>{{API}}</nowiki>/login
</div>

[[Image: CGWebRequest_06(2).png|centro]]

=== Query ===
<div align="justify">
As queries de uma requisição ficam representadas na aba '''Query''' da tabela de configuração de requisição. Quando uma URL possui queries, o programa automaticamente faz a quebra dela, mantendo o texto até o '''?''' na parte superior e o dividindo o restante em linhas de uma tabela, onde é possível visualizá-las em detalhes.
</div>
<div align="justify">
Também é possível inserir queries manualmente, preenchendo o parâmetro e o valor ao utilizar um clique duplo na célula desejada. Da mesma forma que nas outras tabelas, sempre que uma nova linha é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>

==== Parâmetros e valores ====
São representados pelas colunas da tabela de queries. Quando estão presentes na URL colada na barra de texto acima, o programa os identifica automaticamente. É possível editá-los após isso.

Além do mais, na última coluna dessa tabela sempre haverá um checkbox que inicia marcado por padrão. Quando marcada, o programa incluirá a query na requisição, é possível desmarcá-la para que a query em questão seja ignorada. É uma forma prática de alterar a requisição sem ter de refazê-la ou criar uma nova.
</div>

[[Image: CGWebRequest_07(2).png|centro]]

=== Headers ===
<div align="justify">
Nesta aba é possível inserir e editar os cabeçalhos de uma requisição. Com funcionamento semelhante à aba '''Query''', os headers possuem um nome e um valor, representados pelas colunas '''Header''' e '''Value'''. Eles podem ser editados utilizando-se um clique duplo na célula desejada e novos podem ser criados selecionando a última linha da tabela. Sempre que a última linha é preenchida, uma nova linha em branco é criada automaticamente no final da tabela.

Há um checkbox na última coluna dessa tabela, que permite selecionar se um header deve, ou não, ser enviado junto com a requisição. O checkbox vem marcado por padrão. É comum que requisições diferentes possuam headers iguais, portanto essa opção é muito útil.
</div>

[[Image: CGWebRequest_08(2).png|centro]]

=== Body ===
<div align="justify">
Esta aba permite personalizar o corpo da requisição. Ela é subdividida entre outras 3 abas, que servem para selecionar o tipo, o formato no qual o body será enviado. É necessário selecionar o tipo compatível com a requisição desejada. Os tipos disponíveis são: JSON, XML e RAW.

Além disso, há uma caixa de texto onde o código do body pode ser digitado livremente. O conteúdo ali contido será enviado com a requisição. Abaixo, um exemplo de um body do tipo JSON:

[[Image: CGWebRequest_09(2).png|centro]]

*'''Limpar:''' Botão que limpa todo o conteúdo do body quando clicado.
*'''Abrir:''' Botão que permite ler o conteúdo de uma arquivo externo e adicioná-lo ao body. É necessário que o arquivo seja do tipo JSON. Quando lido, o conteúdo será exibido na caixa de texto destinada ao body, abaixo dos botões.
</div>

== Resposta ==
<div align="justify">
O painel inferior do lado direito é destinado a tudo aquilo que for retornado pela requisição.

*'''Código:''' No canto superior esquerdo desse painel ficará registrado o código de status da resposta. É o primeiro indicativo de sucesso ou fracasso de uma requisição, e sempre será exibido assim que ela for completada (se for completada).

*'''Tempo:''' O tempo de requisição é exibido logo ao lado do código de status, e registra em segundos a duração desde o envio da requisição até o recebimento da resposta.

*'''Botão Salvar:''' Fica no canto superior direito desse painel, e permite salvar o conteúdo da resposta em uma arquivo JSON.

[[Image: CGWebRequest_10(2).png|750px|centro]]
</div>

=== Response ===
<div align="justify">
Aba que exibe um campo de texto com o corpo da resposta. Como pode variar muito, o campo destinado a ela e é extenso e possui barras de rolagem para facilitar a navegação. A imagem acima mostra um exemplo de resposta no formato JSON.
</div>

=== Headers ===
<div align="justify">
Nessa aba é possível visualizar os cabeçalhos da resposta. Eles ficam exibidos em uma tabela com duas colunas: '''Header''' e '''Value''', que representam o nome e o valor de cada header. É possível visualizar um exemplo na imagem abaixo:

[[Image: CGWebRequest_11.png|500px|centro]]
</div>

== Menu superior ==

=== Collection ===
<div align="justify">
Esta opção permite controlar coleções, grupos de requisições criadas pelo usuário. Por padrão, as requisições exibidas no painel de coleção (no lado esquerdo da tela) fazem parte de uma coleção que é salva automaticamente sempre que o programa é fechado. O arquivo '''Collection.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

Além da lista de requisições, o arquivo também guarda a configuração de timeout definida pelo usuário (para mais detalhes ver [[CGWebRequestClient#Timeout|Timeout]]).

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de coleção para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. A coleção carregada será exibida no painel de coleção.

*'''Salvar:''' Essa opção permite salvar a coleção atual em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de coleção ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.

[[Image: CGWebRequest_12.png|750px|centro]]
</div>

=== Environment ===
<div align="justify">
Esta do menu superior permite controlar os ambientes, grupos de variáveis criadas pelo usuário. Por padrão, as variáveis exibidas na aba '''Env''' do do painel de configuração de requisição (no lado superior direito da tela) fazem parte de um arquivo que é salvo automaticamente sempre que o programa é fechado. O arquivo '''Env.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de environment para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. As variáveis carregadas serão exibidas na aba '''Env''' do painel de configuração de requisição.

*'''Salvar:''' Essa opção permite salvar as variáveis atuais em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de environment ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.
</div>

=== Opções ===

==== Exportar Curl ====
<div align="justify">
Essa opção abre uma janela que exibe a requisição selecionada formatada no padrão cURL. É possível aumentar e diminuir a janela, o que pode facilitar a visualização no caso de requisições com conteúdo mais extenso.

Vale ressaltar que a requisição exibida sempre será aquela que estiver selecionada no momento.

[[Image: CGWebRequest_13.png|centro]]

*'''Copiar:''' Copia a cURL para a área de transferência. Uma mensagem aparece na parte debaixo da janela, confirmando a ação.
*'''Salvar:''' Abre uma janela que permite salvar a cURL em um arquivo de texto.
</div>

==== Timeout ====
<div align="justify">
Essa opção abre uma janela onde é possível configurar o timeout geral para todas as requisições, que é medido em segundos. O valor pode ser inserido diretamente no campo '''Tempo em segundos''' ou pode ser incrementado de um em um através das setas disponíveis no componente.

Vale ressaltar que, quando o programa é fechado, o timeout configurado é salvo junto com a coleção atual. Quando ela for carregada novamente, seja na inicialização do programa ou via arquivo, o timeout também se manterá.

[[Image: CGWebRequest_14.png|450px|centro]]

*'''OK:''' Salva as configurações feitas e fecha a janela.
*'''Cancelar:''' Fecha a janela sem salvar as alterações feitas.
</div>

=== Ajuda ===
<div align="justify">
Essa opção do menu possui algumas informações que podem ser úteis e informativas para o usuário.
</div>

==== Sobre ====
<div align="justify">
Abre uma janela com informações sobre o '''CGWebRequest Client'''.

[[Image: CGWebRequest_15.png|450px|centro]]
</div>

<div align="justify">

==== Página da Wiki ====
Essa opção abre o link externo que leva até esta página.
</div>

CGWebRequestClient

2026-07-20T14:03:39Z

Vinicius.moder: /* Parâmetros e valores */

<div align="justify">
O '''CIGAM Web Request Client''' é uma ferramenta destinada à criação, ao envio e à validação de requisições. Com ele, é possível configurar métodos HTTP, URLs, parâmetros de query, headers, bodies, tempo de requisição e variáveis reutilizáveis, além de visualizar o código de status, o conteúdo e os headers das respostas.

Abaixo, detalhamos cada uma de suas funcionalidades para guiar a utilização correta da aplicação.
</div>

== Tela inicial ==
<div align="justify">
Ao iniciar, o '''CGWebRequest Client''' exibirá uma janela completa dividida em 3 sessões principais, além do menu superior. O painel mais à esquerda exibe a coleção ativa e permite a criação de novas requisições. O painel superior à direita exibe detalhes da requisição atualmente selecionada, enquanto o painel inferior à direita exibe informações sobre a resposta da requisição atual, se houver.

A largura ou a altura desses painéis pode ser modificada pelo usuário ao parar o mouse na linha que as divide, clicar e arrastar. Isso pode facilitar a visualização em casos onde há muita informação relevante na tela.
</div>

[[Image: CGWebRequest_01.png|750px|centro]]

== Coleção ==
<div align="justify">
Nesse painel, ficam exibidas, de forma simplificada, todas as requisições criadas pelo usuário, em forma de tabela. Em uma das colunas, é exibido o verbo selecionado para cada requisição (que pode ser alterado a qualquer momento) e na outra é exibido o nome da requisição, que pode ser personalizado pelo usuário.
</div>

=== Verbo ===
<div align="justify">
Para escolher ou alterar o verbo de uma requisição basta clicar na seta que fica no lado direito da caixa de seleção na coluna '''verb''' no painel da coleção. Uma lista com os verbos disponíveis será exibida, então basta selecionar o desejado. Note-se que cada um deles possui uma cor específica, facilitando a visualização e compreensão. Os verbos disponíveis são:

*'''GET:''' Azul
*'''POST:''' Verde
*'''PUT:''' Amarelo
*'''DELETE:''' Vermelho
*'''PATCH:''' Roxo
*'''HEAD:''' Rosa
*'''OPTIONS:''' Marrom
*'''PROPFIND:''' Bege
</div>

[[Image: CGWebRequest_02.png|400px|centro]]

=== Nome ===
<div align="justify">
A coluna '''request''' da tabela permite a personalização do nome da requisição. Para adicionar um nome ou editá-lo, basta dar dois cliques na linha em questão, o que habilitará o cursor para digitação.
</div>

[[Image: CGWebRequest_03.png|400px|centro]]

=== Adicionar ===
<div align="justify">
Para adicionar uma nova requisição basta selecionar a última linha da tabela de requisições e personalizá-la com o verbo e o nome desejados. Sempre que o usuário modifica essa última linha, o programa automaticamente cria a próxima linha em branco.
</div>

=== Menu de Contexto ===
<div align="justify">
Clicar com o botão direito em alguma requisição irá exibir um menu de contexto com 3 opções:

[[Image: CGWebRequest_04.png|400px|centro]]

*'''Duplicate:''' Essa opção duplica a requisição selecionada, criando uma igual na última linha da tabela.
*'''Delete:''' Essa opção exclui a requisição selecionada.
*'''Exportar Curl:''' Essa opção exibe uma janela com a requisição selecionada formatada no padrão cURL. Para mais detalhes veja [[CGWebRequestClient#Exportar Curl|Exportar Curl]].
</div>

== Requisição ==
<div align="justify">
O painel de requisição é onde os detalhes podem ser configurados. O verbo selecionado (pode ser feito no painel de coleção, à esquerda) é exibido junto com sua respectiva cor de referência. Logo ao lado fica a caixa de texto da URL e, mais abaixo, um painel com abas que permitem as mais diversas configurações.

[[Image: CGWebRequest_16.png|750px|centro]]

=== URL ===
</div>
<div align="justify">
A caixa de texto da URL pode ser preenchida com o endereço desejado. Tendo feito isso, o valor preenchido previamente ficará salvo automaticamente. Dessa forma, o usuário pode navegar entre uma requisição e outra sem perder uma URL previamente digitada Ou seja, sempre que uma determinada requisição for selecionada no painel de coleção, a URL dela será exibida no painel de requisição.

</div>
<div align="justify">
Ao lado da barra de URL localiza-se o botão '''Enviar''', que, como o nome sugere, faz o envio da requisição. Ao clicar nele, o programa irá trabalhar para executar os comandos com base na configuração previamente estabelecida. Para que haja se obtenha sucesso, é necessário configurar todos os campos previamente.
</div>

[[Image: CGWebRequest_05(2).png|750px|centro]]

=== Env ===
<div align="justify">
Nessa aba do painel de configuração de requisição é possível configurar uma série de variáveis que podem facilitar a interação com diferentes requisições. É possível visualizar e editar variáveis conforme for desejado. Para tanto, basta utilizar um clique duplo na célula em questão, o que habilita o editor, permitindo a alteração por parte do usuário.
</div>
<div align="justify">
Para criar uma variável, tal qual na tabela de coleção, basta clicar na última linha e digitar o nome e o valor desejado. Sempre que uma nova variável é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>
<div align="justify">
Toda variável possui um nome e um valor, que estão representadas nas colunas '''Variable''' e '''Value'''. O nome de uma variável pode ser incluído em uma URL para facilitar sua alteração quando várias requisições possuem uma mesma URL. Para incluir a variável dessa forma, basta utilizar o nome dela entre chaves '''{{}}''' (chaves duplas):
</div>

<div align="justify">
*'''Nome:''' API
*'''Valor:''' <nowiki>/https://minhaapi.com/exemplo</nowiki>
*'''URL:''' <nowiki>{{API}}</nowiki>/login
</div>

[[Image: CGWebRequest_06(2).png|centro]]

=== Query ===
<div align="justify">
As queries de uma requisição ficam representadas na aba '''Query''' da tabela de configuração de requisição. Quando uma URL possui queries, o programa automaticamente faz a quebra dela, mantendo o texto até o '''?''' na parte superior e o dividindo o restante em linhas de uma tabela, onde é possível visualizá-las em detalhes.
</div>
<div align="justify">
Também é possível inserir queries manualmente, preenchendo o parâmetro e o valor ao utilizar um clique duplo na célula desejada. Da mesma forma que nas outras tabelas, sempre que uma nova linha é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>

==== Parâmetros e valores ====
São representados pelas colunas da tabela de queries. Quando estão presentes na URL colada na barra de texto acima, o programa os identifica automaticamente. É possível editá-los após isso.

Além do mais, na última coluna dessa tabela sempre haverá um checkbox que inicia marcado por padrão. Quando marcada, o programa incluirá a query na requisição, é possível desmarcá-la para que a query em questão seja ignorada. É uma forma prática de alterar a requisição sem ter de refazê-la ou criar uma nova.
</div>

[[Image: CGWebRequest_07(2).png|centro]]

=== Headers ===
<div align="justify">
Nesta aba é possível inserir e editar os cabeçalhos de uma requisição. Com funcionamento semelhante à aba '''Query''', os headers possuem um nome e um valor, representados pelas colunas '''Header''' e '''Value'''. Eles podem ser editados utilizando-se um clique duplo na célula desejada e novos podem ser criados selecionando a última linha da tabela. Sempre que a última linha é preenchida, uma nova linha em branco é criada automaticamente no final da tabela.

Há um checkbox na última coluna dessa tabela, que permite selecionar se um header deve, ou não, ser enviado junto com a requisição. O checkbox vem marcada por padrão. É comum que requisições diferentes possuam headers iguais, portanto essa opção é muito útil.
</div>

[[Image: CGWebRequest_08(2).png|centro]]

=== Body ===
<div align="justify">
Esta aba permite personalizar o corpo da requisição. Ela é subdividida entre outras 3 abas, que servem para selecionar o tipo, o formato no qual o body será enviado. É necessário selecionar o tipo compatível com a requisição desejada. Os tipos disponíveis são: JSON, XML e RAW.

Além disso, há uma caixa de texto onde o código do body pode ser digitado livremente. O conteúdo ali contido será enviado com a requisição. Abaixo, um exemplo de um body do tipo JSON:

[[Image: CGWebRequest_09(2).png|centro]]

*'''Limpar:''' Botão que limpa todo o conteúdo do body quando clicado.
*'''Abrir:''' Botão que permite ler o conteúdo de uma arquivo externo e adicioná-lo ao body. É necessário que o arquivo seja do tipo JSON. Quando lido, o conteúdo será exibido na caixa de texto destinada ao body, abaixo dos botões.
</div>

== Resposta ==
<div align="justify">
O painel inferior do lado direito é destinado a tudo aquilo que for retornado pela requisição.

*'''Código:''' No canto superior esquerdo desse painel ficará registrado o código de status da resposta. É o primeiro indicativo de sucesso ou fracasso de uma requisição, e sempre será exibido assim que ela for completada (se for completada).

*'''Tempo:''' O tempo de requisição é exibido logo ao lado do código de status, e registra em segundos a duração desde o envio da requisição até o recebimento da resposta.

*'''Botão Salvar:''' Fica no canto superior direito desse painel, e permite salvar o conteúdo da resposta em uma arquivo JSON.

[[Image: CGWebRequest_10(2).png|750px|centro]]
</div>

=== Response ===
<div align="justify">
Aba que exibe um campo de texto com o corpo da resposta. Como pode variar muito, o campo destinado a ela e é extenso e possui barras de rolagem para facilitar a navegação. A imagem acima mostra um exemplo de resposta no formato JSON.
</div>

=== Headers ===
<div align="justify">
Nessa aba é possível visualizar os cabeçalhos da resposta. Eles ficam exibidos em uma tabela com duas colunas: '''Header''' e '''Value''', que representam o nome e o valor de cada header. É possível visualizar um exemplo na imagem abaixo:

[[Image: CGWebRequest_11.png|500px|centro]]
</div>

== Menu superior ==

=== Collection ===
<div align="justify">
Esta opção permite controlar coleções, grupos de requisições criadas pelo usuário. Por padrão, as requisições exibidas no painel de coleção (no lado esquerdo da tela) fazem parte de uma coleção que é salva automaticamente sempre que o programa é fechado. O arquivo '''Collection.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

Além da lista de requisições, o arquivo também guarda a configuração de timeout definida pelo usuário (para mais detalhes ver [[CGWebRequestClient#Timeout|Timeout]]).

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de coleção para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. A coleção carregada será exibida no painel de coleção.

*'''Salvar:''' Essa opção permite salvar a coleção atual em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de coleção ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.

[[Image: CGWebRequest_12.png|750px|centro]]
</div>

=== Environment ===
<div align="justify">
Esta do menu superior permite controlar os ambientes, grupos de variáveis criadas pelo usuário. Por padrão, as variáveis exibidas na aba '''Env''' do do painel de configuração de requisição (no lado superior direito da tela) fazem parte de um arquivo que é salvo automaticamente sempre que o programa é fechado. O arquivo '''Env.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de environment para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. As variáveis carregadas serão exibidas na aba '''Env''' do painel de configuração de requisição.

*'''Salvar:''' Essa opção permite salvar as variáveis atuais em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de environment ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.
</div>

=== Opções ===

==== Exportar Curl ====
<div align="justify">
Essa opção abre uma janela que exibe a requisição selecionada formatada no padrão cURL. É possível aumentar e diminuir a janela, o que pode facilitar a visualização no caso de requisições com conteúdo mais extenso.

Vale ressaltar que a requisição exibida sempre será aquela que estiver selecionada no momento.

[[Image: CGWebRequest_13.png|centro]]

*'''Copiar:''' Copia a cURL para a área de transferência. Uma mensagem aparece na parte debaixo da janela, confirmando a ação.
*'''Salvar:''' Abre uma janela que permite salvar a cURL em um arquivo de texto.
</div>

==== Timeout ====
<div align="justify">
Essa opção abre uma janela onde é possível configurar o timeout geral para todas as requisições, que é medido em segundos. O valor pode ser inserido diretamente no campo '''Tempo em segundos''' ou pode ser incrementado de um em um através das setas disponíveis no componente.

Vale ressaltar que, quando o programa é fechado, o timeout configurado é salvo junto com a coleção atual. Quando ela for carregada novamente, seja na inicialização do programa ou via arquivo, o timeout também se manterá.

[[Image: CGWebRequest_14.png|450px|centro]]

*'''OK:''' Salva as configurações feitas e fecha a janela.
*'''Cancelar:''' Fecha a janela sem salvar as alterações feitas.
</div>

=== Ajuda ===
<div align="justify">
Essa opção do menu possui algumas informações que podem ser úteis e informativas para o usuário.
</div>

==== Sobre ====
<div align="justify">
Abre uma janela com informações sobre o '''CGWebRequest Client'''.

[[Image: CGWebRequest_15.png|450px|centro]]
</div>

<div align="justify">

==== Página da Wiki ====
Essa opção abre o link externo que leva até esta página.
</div>

CGWebRequestClient

2026-07-20T14:03:18Z

Vinicius.moder: /* Headers */

<div align="justify">
O '''CIGAM Web Request Client''' é uma ferramenta destinada à criação, ao envio e à validação de requisições. Com ele, é possível configurar métodos HTTP, URLs, parâmetros de query, headers, bodies, tempo de requisição e variáveis reutilizáveis, além de visualizar o código de status, o conteúdo e os headers das respostas.

Abaixo, detalhamos cada uma de suas funcionalidades para guiar a utilização correta da aplicação.
</div>

== Tela inicial ==
<div align="justify">
Ao iniciar, o '''CGWebRequest Client''' exibirá uma janela completa dividida em 3 sessões principais, além do menu superior. O painel mais à esquerda exibe a coleção ativa e permite a criação de novas requisições. O painel superior à direita exibe detalhes da requisição atualmente selecionada, enquanto o painel inferior à direita exibe informações sobre a resposta da requisição atual, se houver.

A largura ou a altura desses painéis pode ser modificada pelo usuário ao parar o mouse na linha que as divide, clicar e arrastar. Isso pode facilitar a visualização em casos onde há muita informação relevante na tela.
</div>

[[Image: CGWebRequest_01.png|750px|centro]]

== Coleção ==
<div align="justify">
Nesse painel, ficam exibidas, de forma simplificada, todas as requisições criadas pelo usuário, em forma de tabela. Em uma das colunas, é exibido o verbo selecionado para cada requisição (que pode ser alterado a qualquer momento) e na outra é exibido o nome da requisição, que pode ser personalizado pelo usuário.
</div>

=== Verbo ===
<div align="justify">
Para escolher ou alterar o verbo de uma requisição basta clicar na seta que fica no lado direito da caixa de seleção na coluna '''verb''' no painel da coleção. Uma lista com os verbos disponíveis será exibida, então basta selecionar o desejado. Note-se que cada um deles possui uma cor específica, facilitando a visualização e compreensão. Os verbos disponíveis são:

*'''GET:''' Azul
*'''POST:''' Verde
*'''PUT:''' Amarelo
*'''DELETE:''' Vermelho
*'''PATCH:''' Roxo
*'''HEAD:''' Rosa
*'''OPTIONS:''' Marrom
*'''PROPFIND:''' Bege
</div>

[[Image: CGWebRequest_02.png|400px|centro]]

=== Nome ===
<div align="justify">
A coluna '''request''' da tabela permite a personalização do nome da requisição. Para adicionar um nome ou editá-lo, basta dar dois cliques na linha em questão, o que habilitará o cursor para digitação.
</div>

[[Image: CGWebRequest_03.png|400px|centro]]

=== Adicionar ===
<div align="justify">
Para adicionar uma nova requisição basta selecionar a última linha da tabela de requisições e personalizá-la com o verbo e o nome desejados. Sempre que o usuário modifica essa última linha, o programa automaticamente cria a próxima linha em branco.
</div>

=== Menu de Contexto ===
<div align="justify">
Clicar com o botão direito em alguma requisição irá exibir um menu de contexto com 3 opções:

[[Image: CGWebRequest_04.png|400px|centro]]

*'''Duplicate:''' Essa opção duplica a requisição selecionada, criando uma igual na última linha da tabela.
*'''Delete:''' Essa opção exclui a requisição selecionada.
*'''Exportar Curl:''' Essa opção exibe uma janela com a requisição selecionada formatada no padrão cURL. Para mais detalhes veja [[CGWebRequestClient#Exportar Curl|Exportar Curl]].
</div>

== Requisição ==
<div align="justify">
O painel de requisição é onde os detalhes podem ser configurados. O verbo selecionado (pode ser feito no painel de coleção, à esquerda) é exibido junto com sua respectiva cor de referência. Logo ao lado fica a caixa de texto da URL e, mais abaixo, um painel com abas que permitem as mais diversas configurações.

[[Image: CGWebRequest_16.png|750px|centro]]

=== URL ===
</div>
<div align="justify">
A caixa de texto da URL pode ser preenchida com o endereço desejado. Tendo feito isso, o valor preenchido previamente ficará salvo automaticamente. Dessa forma, o usuário pode navegar entre uma requisição e outra sem perder uma URL previamente digitada Ou seja, sempre que uma determinada requisição for selecionada no painel de coleção, a URL dela será exibida no painel de requisição.

</div>
<div align="justify">
Ao lado da barra de URL localiza-se o botão '''Enviar''', que, como o nome sugere, faz o envio da requisição. Ao clicar nele, o programa irá trabalhar para executar os comandos com base na configuração previamente estabelecida. Para que haja se obtenha sucesso, é necessário configurar todos os campos previamente.
</div>

[[Image: CGWebRequest_05(2).png|750px|centro]]

=== Env ===
<div align="justify">
Nessa aba do painel de configuração de requisição é possível configurar uma série de variáveis que podem facilitar a interação com diferentes requisições. É possível visualizar e editar variáveis conforme for desejado. Para tanto, basta utilizar um clique duplo na célula em questão, o que habilita o editor, permitindo a alteração por parte do usuário.
</div>
<div align="justify">
Para criar uma variável, tal qual na tabela de coleção, basta clicar na última linha e digitar o nome e o valor desejado. Sempre que uma nova variável é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>
<div align="justify">
Toda variável possui um nome e um valor, que estão representadas nas colunas '''Variable''' e '''Value'''. O nome de uma variável pode ser incluído em uma URL para facilitar sua alteração quando várias requisições possuem uma mesma URL. Para incluir a variável dessa forma, basta utilizar o nome dela entre chaves '''{{}}''' (chaves duplas):
</div>

<div align="justify">
*'''Nome:''' API
*'''Valor:''' <nowiki>/https://minhaapi.com/exemplo</nowiki>
*'''URL:''' <nowiki>{{API}}</nowiki>/login
</div>

[[Image: CGWebRequest_06(2).png|centro]]

=== Query ===
<div align="justify">
As queries de uma requisição ficam representadas na aba '''Query''' da tabela de configuração de requisição. Quando uma URL possui queries, o programa automaticamente faz a quebra dela, mantendo o texto até o '''?''' na parte superior e o dividindo o restante em linhas de uma tabela, onde é possível visualizá-las em detalhes.
</div>
<div align="justify">
Também é possível inserir queries manualmente, preenchendo o parâmetro e o valor ao utilizar um clique duplo na célula desejada. Da mesma forma que nas outras tabelas, sempre que uma nova linha é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>

==== Parâmetros e valores ====
São representados pelas colunas da tabela de queries. Quando estão presentes na URL colada na barra de texto acima, o programa os identifica automaticamente. É possível editá-los após isso.

Além do mais, na última coluna dessa tabela sempre haverá um checkbox que inicia marcada por padrão. Quando marcada, o programa incluirá a query na requisição, é possível desmarcá-la para que a query em questão seja ignorada. É uma forma prática de alterar a requisição sem ter de refazê-la ou criar uma nova.
</div>

[[Image: CGWebRequest_07(2).png|centro]]

=== Headers ===
<div align="justify">
Nesta aba é possível inserir e editar os cabeçalhos de uma requisição. Com funcionamento semelhante à aba '''Query''', os headers possuem um nome e um valor, representados pelas colunas '''Header''' e '''Value'''. Eles podem ser editados utilizando-se um clique duplo na célula desejada e novos podem ser criados selecionando a última linha da tabela. Sempre que a última linha é preenchida, uma nova linha em branco é criada automaticamente no final da tabela.

Há um checkbox na última coluna dessa tabela, que permite selecionar se um header deve, ou não, ser enviado junto com a requisição. O checkbox vem marcada por padrão. É comum que requisições diferentes possuam headers iguais, portanto essa opção é muito útil.
</div>

[[Image: CGWebRequest_08(2).png|centro]]

=== Body ===
<div align="justify">
Esta aba permite personalizar o corpo da requisição. Ela é subdividida entre outras 3 abas, que servem para selecionar o tipo, o formato no qual o body será enviado. É necessário selecionar o tipo compatível com a requisição desejada. Os tipos disponíveis são: JSON, XML e RAW.

Além disso, há uma caixa de texto onde o código do body pode ser digitado livremente. O conteúdo ali contido será enviado com a requisição. Abaixo, um exemplo de um body do tipo JSON:

[[Image: CGWebRequest_09(2).png|centro]]

*'''Limpar:''' Botão que limpa todo o conteúdo do body quando clicado.
*'''Abrir:''' Botão que permite ler o conteúdo de uma arquivo externo e adicioná-lo ao body. É necessário que o arquivo seja do tipo JSON. Quando lido, o conteúdo será exibido na caixa de texto destinada ao body, abaixo dos botões.
</div>

== Resposta ==
<div align="justify">
O painel inferior do lado direito é destinado a tudo aquilo que for retornado pela requisição.

*'''Código:''' No canto superior esquerdo desse painel ficará registrado o código de status da resposta. É o primeiro indicativo de sucesso ou fracasso de uma requisição, e sempre será exibido assim que ela for completada (se for completada).

*'''Tempo:''' O tempo de requisição é exibido logo ao lado do código de status, e registra em segundos a duração desde o envio da requisição até o recebimento da resposta.

*'''Botão Salvar:''' Fica no canto superior direito desse painel, e permite salvar o conteúdo da resposta em uma arquivo JSON.

[[Image: CGWebRequest_10(2).png|750px|centro]]
</div>

=== Response ===
<div align="justify">
Aba que exibe um campo de texto com o corpo da resposta. Como pode variar muito, o campo destinado a ela e é extenso e possui barras de rolagem para facilitar a navegação. A imagem acima mostra um exemplo de resposta no formato JSON.
</div>

=== Headers ===
<div align="justify">
Nessa aba é possível visualizar os cabeçalhos da resposta. Eles ficam exibidos em uma tabela com duas colunas: '''Header''' e '''Value''', que representam o nome e o valor de cada header. É possível visualizar um exemplo na imagem abaixo:

[[Image: CGWebRequest_11.png|500px|centro]]
</div>

== Menu superior ==

=== Collection ===
<div align="justify">
Esta opção permite controlar coleções, grupos de requisições criadas pelo usuário. Por padrão, as requisições exibidas no painel de coleção (no lado esquerdo da tela) fazem parte de uma coleção que é salva automaticamente sempre que o programa é fechado. O arquivo '''Collection.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

Além da lista de requisições, o arquivo também guarda a configuração de timeout definida pelo usuário (para mais detalhes ver [[CGWebRequestClient#Timeout|Timeout]]).

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de coleção para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. A coleção carregada será exibida no painel de coleção.

*'''Salvar:''' Essa opção permite salvar a coleção atual em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de coleção ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.

[[Image: CGWebRequest_12.png|750px|centro]]
</div>

=== Environment ===
<div align="justify">
Esta do menu superior permite controlar os ambientes, grupos de variáveis criadas pelo usuário. Por padrão, as variáveis exibidas na aba '''Env''' do do painel de configuração de requisição (no lado superior direito da tela) fazem parte de um arquivo que é salvo automaticamente sempre que o programa é fechado. O arquivo '''Env.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de environment para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. As variáveis carregadas serão exibidas na aba '''Env''' do painel de configuração de requisição.

*'''Salvar:''' Essa opção permite salvar as variáveis atuais em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de environment ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.
</div>

=== Opções ===

==== Exportar Curl ====
<div align="justify">
Essa opção abre uma janela que exibe a requisição selecionada formatada no padrão cURL. É possível aumentar e diminuir a janela, o que pode facilitar a visualização no caso de requisições com conteúdo mais extenso.

Vale ressaltar que a requisição exibida sempre será aquela que estiver selecionada no momento.

[[Image: CGWebRequest_13.png|centro]]

*'''Copiar:''' Copia a cURL para a área de transferência. Uma mensagem aparece na parte debaixo da janela, confirmando a ação.
*'''Salvar:''' Abre uma janela que permite salvar a cURL em um arquivo de texto.
</div>

==== Timeout ====
<div align="justify">
Essa opção abre uma janela onde é possível configurar o timeout geral para todas as requisições, que é medido em segundos. O valor pode ser inserido diretamente no campo '''Tempo em segundos''' ou pode ser incrementado de um em um através das setas disponíveis no componente.

Vale ressaltar que, quando o programa é fechado, o timeout configurado é salvo junto com a coleção atual. Quando ela for carregada novamente, seja na inicialização do programa ou via arquivo, o timeout também se manterá.

[[Image: CGWebRequest_14.png|450px|centro]]

*'''OK:''' Salva as configurações feitas e fecha a janela.
*'''Cancelar:''' Fecha a janela sem salvar as alterações feitas.
</div>

=== Ajuda ===
<div align="justify">
Essa opção do menu possui algumas informações que podem ser úteis e informativas para o usuário.
</div>

==== Sobre ====
<div align="justify">
Abre uma janela com informações sobre o '''CGWebRequest Client'''.

[[Image: CGWebRequest_15.png|450px|centro]]
</div>

<div align="justify">

==== Página da Wiki ====
Essa opção abre o link externo que leva até esta página.
</div>

CGWebRequestClient

2026-07-20T14:03:00Z

Vinicius.moder: /* Parâmetros e valores */

<div align="justify">
O '''CIGAM Web Request Client''' é uma ferramenta destinada à criação, ao envio e à validação de requisições. Com ele, é possível configurar métodos HTTP, URLs, parâmetros de query, headers, bodies, tempo de requisição e variáveis reutilizáveis, além de visualizar o código de status, o conteúdo e os headers das respostas.

Abaixo, detalhamos cada uma de suas funcionalidades para guiar a utilização correta da aplicação.
</div>

== Tela inicial ==
<div align="justify">
Ao iniciar, o '''CGWebRequest Client''' exibirá uma janela completa dividida em 3 sessões principais, além do menu superior. O painel mais à esquerda exibe a coleção ativa e permite a criação de novas requisições. O painel superior à direita exibe detalhes da requisição atualmente selecionada, enquanto o painel inferior à direita exibe informações sobre a resposta da requisição atual, se houver.

A largura ou a altura desses painéis pode ser modificada pelo usuário ao parar o mouse na linha que as divide, clicar e arrastar. Isso pode facilitar a visualização em casos onde há muita informação relevante na tela.
</div>

[[Image: CGWebRequest_01.png|750px|centro]]

== Coleção ==
<div align="justify">
Nesse painel, ficam exibidas, de forma simplificada, todas as requisições criadas pelo usuário, em forma de tabela. Em uma das colunas, é exibido o verbo selecionado para cada requisição (que pode ser alterado a qualquer momento) e na outra é exibido o nome da requisição, que pode ser personalizado pelo usuário.
</div>

=== Verbo ===
<div align="justify">
Para escolher ou alterar o verbo de uma requisição basta clicar na seta que fica no lado direito da caixa de seleção na coluna '''verb''' no painel da coleção. Uma lista com os verbos disponíveis será exibida, então basta selecionar o desejado. Note-se que cada um deles possui uma cor específica, facilitando a visualização e compreensão. Os verbos disponíveis são:

*'''GET:''' Azul
*'''POST:''' Verde
*'''PUT:''' Amarelo
*'''DELETE:''' Vermelho
*'''PATCH:''' Roxo
*'''HEAD:''' Rosa
*'''OPTIONS:''' Marrom
*'''PROPFIND:''' Bege
</div>

[[Image: CGWebRequest_02.png|400px|centro]]

=== Nome ===
<div align="justify">
A coluna '''request''' da tabela permite a personalização do nome da requisição. Para adicionar um nome ou editá-lo, basta dar dois cliques na linha em questão, o que habilitará o cursor para digitação.
</div>

[[Image: CGWebRequest_03.png|400px|centro]]

=== Adicionar ===
<div align="justify">
Para adicionar uma nova requisição basta selecionar a última linha da tabela de requisições e personalizá-la com o verbo e o nome desejados. Sempre que o usuário modifica essa última linha, o programa automaticamente cria a próxima linha em branco.
</div>

=== Menu de Contexto ===
<div align="justify">
Clicar com o botão direito em alguma requisição irá exibir um menu de contexto com 3 opções:

[[Image: CGWebRequest_04.png|400px|centro]]

*'''Duplicate:''' Essa opção duplica a requisição selecionada, criando uma igual na última linha da tabela.
*'''Delete:''' Essa opção exclui a requisição selecionada.
*'''Exportar Curl:''' Essa opção exibe uma janela com a requisição selecionada formatada no padrão cURL. Para mais detalhes veja [[CGWebRequestClient#Exportar Curl|Exportar Curl]].
</div>

== Requisição ==
<div align="justify">
O painel de requisição é onde os detalhes podem ser configurados. O verbo selecionado (pode ser feito no painel de coleção, à esquerda) é exibido junto com sua respectiva cor de referência. Logo ao lado fica a caixa de texto da URL e, mais abaixo, um painel com abas que permitem as mais diversas configurações.

[[Image: CGWebRequest_16.png|750px|centro]]

=== URL ===
</div>
<div align="justify">
A caixa de texto da URL pode ser preenchida com o endereço desejado. Tendo feito isso, o valor preenchido previamente ficará salvo automaticamente. Dessa forma, o usuário pode navegar entre uma requisição e outra sem perder uma URL previamente digitada Ou seja, sempre que uma determinada requisição for selecionada no painel de coleção, a URL dela será exibida no painel de requisição.

</div>
<div align="justify">
Ao lado da barra de URL localiza-se o botão '''Enviar''', que, como o nome sugere, faz o envio da requisição. Ao clicar nele, o programa irá trabalhar para executar os comandos com base na configuração previamente estabelecida. Para que haja se obtenha sucesso, é necessário configurar todos os campos previamente.
</div>

[[Image: CGWebRequest_05(2).png|750px|centro]]

=== Env ===
<div align="justify">
Nessa aba do painel de configuração de requisição é possível configurar uma série de variáveis que podem facilitar a interação com diferentes requisições. É possível visualizar e editar variáveis conforme for desejado. Para tanto, basta utilizar um clique duplo na célula em questão, o que habilita o editor, permitindo a alteração por parte do usuário.
</div>
<div align="justify">
Para criar uma variável, tal qual na tabela de coleção, basta clicar na última linha e digitar o nome e o valor desejado. Sempre que uma nova variável é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>
<div align="justify">
Toda variável possui um nome e um valor, que estão representadas nas colunas '''Variable''' e '''Value'''. O nome de uma variável pode ser incluído em uma URL para facilitar sua alteração quando várias requisições possuem uma mesma URL. Para incluir a variável dessa forma, basta utilizar o nome dela entre chaves '''{{}}''' (chaves duplas):
</div>

<div align="justify">
*'''Nome:''' API
*'''Valor:''' <nowiki>/https://minhaapi.com/exemplo</nowiki>
*'''URL:''' <nowiki>{{API}}</nowiki>/login
</div>

[[Image: CGWebRequest_06(2).png|centro]]

=== Query ===
<div align="justify">
As queries de uma requisição ficam representadas na aba '''Query''' da tabela de configuração de requisição. Quando uma URL possui queries, o programa automaticamente faz a quebra dela, mantendo o texto até o '''?''' na parte superior e o dividindo o restante em linhas de uma tabela, onde é possível visualizá-las em detalhes.
</div>
<div align="justify">
Também é possível inserir queries manualmente, preenchendo o parâmetro e o valor ao utilizar um clique duplo na célula desejada. Da mesma forma que nas outras tabelas, sempre que uma nova linha é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>

==== Parâmetros e valores ====
São representados pelas colunas da tabela de queries. Quando estão presentes na URL colada na barra de texto acima, o programa os identifica automaticamente. É possível editá-los após isso.

Além do mais, na última coluna dessa tabela sempre haverá um checkbox que inicia marcada por padrão. Quando marcada, o programa incluirá a query na requisição, é possível desmarcá-la para que a query em questão seja ignorada. É uma forma prática de alterar a requisição sem ter de refazê-la ou criar uma nova.
</div>

[[Image: CGWebRequest_07(2).png|centro]]

=== Headers ===
<div align="justify">
Nesta aba é possível inserir e editar os cabeçalhos de uma requisição. Com funcionamento semelhante à aba '''Query''', os headers possuem um nome e um valor, representados pelas colunas '''Header''' e '''Value'''. Eles podem ser editados utilizando-se um clique duplo na célula desejada e novos podem ser criados selecionando a última linha da tabela. Sempre que a última linha é preenchida, uma nova linha em branco é criada automaticamente no final da tabela.

Há uma checkbox na última coluna dessa tabela, que permite selecionar se um header deve, ou não, ser enviado junto com a requisição. A checkbox vem marcada por padrão. É comum que requisições diferentes possuam headers iguais, portanto essa opção é muito útil.
</div>

[[Image: CGWebRequest_08(2).png|centro]]

=== Body ===
<div align="justify">
Esta aba permite personalizar o corpo da requisição. Ela é subdividida entre outras 3 abas, que servem para selecionar o tipo, o formato no qual o body será enviado. É necessário selecionar o tipo compatível com a requisição desejada. Os tipos disponíveis são: JSON, XML e RAW.

Além disso, há uma caixa de texto onde o código do body pode ser digitado livremente. O conteúdo ali contido será enviado com a requisição. Abaixo, um exemplo de um body do tipo JSON:

[[Image: CGWebRequest_09(2).png|centro]]

*'''Limpar:''' Botão que limpa todo o conteúdo do body quando clicado.
*'''Abrir:''' Botão que permite ler o conteúdo de uma arquivo externo e adicioná-lo ao body. É necessário que o arquivo seja do tipo JSON. Quando lido, o conteúdo será exibido na caixa de texto destinada ao body, abaixo dos botões.
</div>

== Resposta ==
<div align="justify">
O painel inferior do lado direito é destinado a tudo aquilo que for retornado pela requisição.

*'''Código:''' No canto superior esquerdo desse painel ficará registrado o código de status da resposta. É o primeiro indicativo de sucesso ou fracasso de uma requisição, e sempre será exibido assim que ela for completada (se for completada).

*'''Tempo:''' O tempo de requisição é exibido logo ao lado do código de status, e registra em segundos a duração desde o envio da requisição até o recebimento da resposta.

*'''Botão Salvar:''' Fica no canto superior direito desse painel, e permite salvar o conteúdo da resposta em uma arquivo JSON.

[[Image: CGWebRequest_10(2).png|750px|centro]]
</div>

=== Response ===
<div align="justify">
Aba que exibe um campo de texto com o corpo da resposta. Como pode variar muito, o campo destinado a ela e é extenso e possui barras de rolagem para facilitar a navegação. A imagem acima mostra um exemplo de resposta no formato JSON.
</div>

=== Headers ===
<div align="justify">
Nessa aba é possível visualizar os cabeçalhos da resposta. Eles ficam exibidos em uma tabela com duas colunas: '''Header''' e '''Value''', que representam o nome e o valor de cada header. É possível visualizar um exemplo na imagem abaixo:

[[Image: CGWebRequest_11.png|500px|centro]]
</div>

== Menu superior ==

=== Collection ===
<div align="justify">
Esta opção permite controlar coleções, grupos de requisições criadas pelo usuário. Por padrão, as requisições exibidas no painel de coleção (no lado esquerdo da tela) fazem parte de uma coleção que é salva automaticamente sempre que o programa é fechado. O arquivo '''Collection.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

Além da lista de requisições, o arquivo também guarda a configuração de timeout definida pelo usuário (para mais detalhes ver [[CGWebRequestClient#Timeout|Timeout]]).

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de coleção para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. A coleção carregada será exibida no painel de coleção.

*'''Salvar:''' Essa opção permite salvar a coleção atual em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de coleção ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.

[[Image: CGWebRequest_12.png|750px|centro]]
</div>

=== Environment ===
<div align="justify">
Esta do menu superior permite controlar os ambientes, grupos de variáveis criadas pelo usuário. Por padrão, as variáveis exibidas na aba '''Env''' do do painel de configuração de requisição (no lado superior direito da tela) fazem parte de um arquivo que é salvo automaticamente sempre que o programa é fechado. O arquivo '''Env.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de environment para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. As variáveis carregadas serão exibidas na aba '''Env''' do painel de configuração de requisição.

*'''Salvar:''' Essa opção permite salvar as variáveis atuais em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de environment ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.
</div>

=== Opções ===

==== Exportar Curl ====
<div align="justify">
Essa opção abre uma janela que exibe a requisição selecionada formatada no padrão cURL. É possível aumentar e diminuir a janela, o que pode facilitar a visualização no caso de requisições com conteúdo mais extenso.

Vale ressaltar que a requisição exibida sempre será aquela que estiver selecionada no momento.

[[Image: CGWebRequest_13.png|centro]]

*'''Copiar:''' Copia a cURL para a área de transferência. Uma mensagem aparece na parte debaixo da janela, confirmando a ação.
*'''Salvar:''' Abre uma janela que permite salvar a cURL em um arquivo de texto.
</div>

==== Timeout ====
<div align="justify">
Essa opção abre uma janela onde é possível configurar o timeout geral para todas as requisições, que é medido em segundos. O valor pode ser inserido diretamente no campo '''Tempo em segundos''' ou pode ser incrementado de um em um através das setas disponíveis no componente.

Vale ressaltar que, quando o programa é fechado, o timeout configurado é salvo junto com a coleção atual. Quando ela for carregada novamente, seja na inicialização do programa ou via arquivo, o timeout também se manterá.

[[Image: CGWebRequest_14.png|450px|centro]]

*'''OK:''' Salva as configurações feitas e fecha a janela.
*'''Cancelar:''' Fecha a janela sem salvar as alterações feitas.
</div>

=== Ajuda ===
<div align="justify">
Essa opção do menu possui algumas informações que podem ser úteis e informativas para o usuário.
</div>

==== Sobre ====
<div align="justify">
Abre uma janela com informações sobre o '''CGWebRequest Client'''.

[[Image: CGWebRequest_15.png|450px|centro]]
</div>

<div align="justify">

==== Página da Wiki ====
Essa opção abre o link externo que leva até esta página.
</div>

CGWebRequestClient

2026-07-20T14:01:09Z

Vinicius.moder:

<div align="justify">
O '''CIGAM Web Request Client''' é uma ferramenta destinada à criação, ao envio e à validação de requisições. Com ele, é possível configurar métodos HTTP, URLs, parâmetros de query, headers, bodies, tempo de requisição e variáveis reutilizáveis, além de visualizar o código de status, o conteúdo e os headers das respostas.

Abaixo, detalhamos cada uma de suas funcionalidades para guiar a utilização correta da aplicação.
</div>

== Tela inicial ==
<div align="justify">
Ao iniciar, o '''CGWebRequest Client''' exibirá uma janela completa dividida em 3 sessões principais, além do menu superior. O painel mais à esquerda exibe a coleção ativa e permite a criação de novas requisições. O painel superior à direita exibe detalhes da requisição atualmente selecionada, enquanto o painel inferior à direita exibe informações sobre a resposta da requisição atual, se houver.

A largura ou a altura desses painéis pode ser modificada pelo usuário ao parar o mouse na linha que as divide, clicar e arrastar. Isso pode facilitar a visualização em casos onde há muita informação relevante na tela.
</div>

[[Image: CGWebRequest_01.png|750px|centro]]

== Coleção ==
<div align="justify">
Nesse painel, ficam exibidas, de forma simplificada, todas as requisições criadas pelo usuário, em forma de tabela. Em uma das colunas, é exibido o verbo selecionado para cada requisição (que pode ser alterado a qualquer momento) e na outra é exibido o nome da requisição, que pode ser personalizado pelo usuário.
</div>

=== Verbo ===
<div align="justify">
Para escolher ou alterar o verbo de uma requisição basta clicar na seta que fica no lado direito da caixa de seleção na coluna '''verb''' no painel da coleção. Uma lista com os verbos disponíveis será exibida, então basta selecionar o desejado. Note-se que cada um deles possui uma cor específica, facilitando a visualização e compreensão. Os verbos disponíveis são:

*'''GET:''' Azul
*'''POST:''' Verde
*'''PUT:''' Amarelo
*'''DELETE:''' Vermelho
*'''PATCH:''' Roxo
*'''HEAD:''' Rosa
*'''OPTIONS:''' Marrom
*'''PROPFIND:''' Bege
</div>

[[Image: CGWebRequest_02.png|400px|centro]]

=== Nome ===
<div align="justify">
A coluna '''request''' da tabela permite a personalização do nome da requisição. Para adicionar um nome ou editá-lo, basta dar dois cliques na linha em questão, o que habilitará o cursor para digitação.
</div>

[[Image: CGWebRequest_03.png|400px|centro]]

=== Adicionar ===
<div align="justify">
Para adicionar uma nova requisição basta selecionar a última linha da tabela de requisições e personalizá-la com o verbo e o nome desejados. Sempre que o usuário modifica essa última linha, o programa automaticamente cria a próxima linha em branco.
</div>

=== Menu de Contexto ===
<div align="justify">
Clicar com o botão direito em alguma requisição irá exibir um menu de contexto com 3 opções:

[[Image: CGWebRequest_04.png|400px|centro]]

*'''Duplicate:''' Essa opção duplica a requisição selecionada, criando uma igual na última linha da tabela.
*'''Delete:''' Essa opção exclui a requisição selecionada.
*'''Exportar Curl:''' Essa opção exibe uma janela com a requisição selecionada formatada no padrão cURL. Para mais detalhes veja [[CGWebRequestClient#Exportar Curl|Exportar Curl]].
</div>

== Requisição ==
<div align="justify">
O painel de requisição é onde os detalhes podem ser configurados. O verbo selecionado (pode ser feito no painel de coleção, à esquerda) é exibido junto com sua respectiva cor de referência. Logo ao lado fica a caixa de texto da URL e, mais abaixo, um painel com abas que permitem as mais diversas configurações.

[[Image: CGWebRequest_16.png|750px|centro]]

=== URL ===
</div>
<div align="justify">
A caixa de texto da URL pode ser preenchida com o endereço desejado. Tendo feito isso, o valor preenchido previamente ficará salvo automaticamente. Dessa forma, o usuário pode navegar entre uma requisição e outra sem perder uma URL previamente digitada Ou seja, sempre que uma determinada requisição for selecionada no painel de coleção, a URL dela será exibida no painel de requisição.

</div>
<div align="justify">
Ao lado da barra de URL localiza-se o botão '''Enviar''', que, como o nome sugere, faz o envio da requisição. Ao clicar nele, o programa irá trabalhar para executar os comandos com base na configuração previamente estabelecida. Para que haja se obtenha sucesso, é necessário configurar todos os campos previamente.
</div>

[[Image: CGWebRequest_05(2).png|750px|centro]]

=== Env ===
<div align="justify">
Nessa aba do painel de configuração de requisição é possível configurar uma série de variáveis que podem facilitar a interação com diferentes requisições. É possível visualizar e editar variáveis conforme for desejado. Para tanto, basta utilizar um clique duplo na célula em questão, o que habilita o editor, permitindo a alteração por parte do usuário.
</div>
<div align="justify">
Para criar uma variável, tal qual na tabela de coleção, basta clicar na última linha e digitar o nome e o valor desejado. Sempre que uma nova variável é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>
<div align="justify">
Toda variável possui um nome e um valor, que estão representadas nas colunas '''Variable''' e '''Value'''. O nome de uma variável pode ser incluído em uma URL para facilitar sua alteração quando várias requisições possuem uma mesma URL. Para incluir a variável dessa forma, basta utilizar o nome dela entre chaves '''{{}}''' (chaves duplas):
</div>

<div align="justify">
*'''Nome:''' API
*'''Valor:''' <nowiki>/https://minhaapi.com/exemplo</nowiki>
*'''URL:''' <nowiki>{{API}}</nowiki>/login
</div>

[[Image: CGWebRequest_06(2).png|centro]]

=== Query ===
<div align="justify">
As queries de uma requisição ficam representadas na aba '''Query''' da tabela de configuração de requisição. Quando uma URL possui queries, o programa automaticamente faz a quebra dela, mantendo o texto até o '''?''' na parte superior e o dividindo o restante em linhas de uma tabela, onde é possível visualizá-las em detalhes.
</div>
<div align="justify">
Também é possível inserir queries manualmente, preenchendo o parâmetro e o valor ao utilizar um clique duplo na célula desejada. Da mesma forma que nas outras tabelas, sempre que uma nova linha é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>

==== Parâmetros e valores ====
São representados pelas colunas da tabela de queries. Quando estão presentes na URL colada na barra de texto acima, o programa os identifica automaticamente. É possível editá-los após isso.

Além do mais, na última coluna dessa tabela sempre haverá uma checkbox que inicia marcada por padrão. Quando marcada, o programa incluirá a query na requisição, é possível desmarcá-la para que a query em questão seja ignorada. É uma forma prática de alterar a requisição sem ter de refazê-la ou criar uma nova.
</div>

[[Image: CGWebRequest_07(2).png|centro]]

=== Headers ===
<div align="justify">
Nesta aba é possível inserir e editar os cabeçalhos de uma requisição. Com funcionamento semelhante à aba '''Query''', os headers possuem um nome e um valor, representados pelas colunas '''Header''' e '''Value'''. Eles podem ser editados utilizando-se um clique duplo na célula desejada e novos podem ser criados selecionando a última linha da tabela. Sempre que a última linha é preenchida, uma nova linha em branco é criada automaticamente no final da tabela.

Há uma checkbox na última coluna dessa tabela, que permite selecionar se um header deve, ou não, ser enviado junto com a requisição. A checkbox vem marcada por padrão. É comum que requisições diferentes possuam headers iguais, portanto essa opção é muito útil.
</div>

[[Image: CGWebRequest_08(2).png|centro]]

=== Body ===
<div align="justify">
Esta aba permite personalizar o corpo da requisição. Ela é subdividida entre outras 3 abas, que servem para selecionar o tipo, o formato no qual o body será enviado. É necessário selecionar o tipo compatível com a requisição desejada. Os tipos disponíveis são: JSON, XML e RAW.

Além disso, há uma caixa de texto onde o código do body pode ser digitado livremente. O conteúdo ali contido será enviado com a requisição. Abaixo, um exemplo de um body do tipo JSON:

[[Image: CGWebRequest_09(2).png|centro]]

*'''Limpar:''' Botão que limpa todo o conteúdo do body quando clicado.
*'''Abrir:''' Botão que permite ler o conteúdo de uma arquivo externo e adicioná-lo ao body. É necessário que o arquivo seja do tipo JSON. Quando lido, o conteúdo será exibido na caixa de texto destinada ao body, abaixo dos botões.
</div>

== Resposta ==
<div align="justify">
O painel inferior do lado direito é destinado a tudo aquilo que for retornado pela requisição.

*'''Código:''' No canto superior esquerdo desse painel ficará registrado o código de status da resposta. É o primeiro indicativo de sucesso ou fracasso de uma requisição, e sempre será exibido assim que ela for completada (se for completada).

*'''Tempo:''' O tempo de requisição é exibido logo ao lado do código de status, e registra em segundos a duração desde o envio da requisição até o recebimento da resposta.

*'''Botão Salvar:''' Fica no canto superior direito desse painel, e permite salvar o conteúdo da resposta em uma arquivo JSON.

[[Image: CGWebRequest_10(2).png|750px|centro]]
</div>

=== Response ===
<div align="justify">
Aba que exibe um campo de texto com o corpo da resposta. Como pode variar muito, o campo destinado a ela e é extenso e possui barras de rolagem para facilitar a navegação. A imagem acima mostra um exemplo de resposta no formato JSON.
</div>

=== Headers ===
<div align="justify">
Nessa aba é possível visualizar os cabeçalhos da resposta. Eles ficam exibidos em uma tabela com duas colunas: '''Header''' e '''Value''', que representam o nome e o valor de cada header. É possível visualizar um exemplo na imagem abaixo:

[[Image: CGWebRequest_11.png|500px|centro]]
</div>

== Menu superior ==

=== Collection ===
<div align="justify">
Esta opção permite controlar coleções, grupos de requisições criadas pelo usuário. Por padrão, as requisições exibidas no painel de coleção (no lado esquerdo da tela) fazem parte de uma coleção que é salva automaticamente sempre que o programa é fechado. O arquivo '''Collection.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

Além da lista de requisições, o arquivo também guarda a configuração de timeout definida pelo usuário (para mais detalhes ver [[CGWebRequestClient#Timeout|Timeout]]).

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de coleção para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. A coleção carregada será exibida no painel de coleção.

*'''Salvar:''' Essa opção permite salvar a coleção atual em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de coleção ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.

[[Image: CGWebRequest_12.png|750px|centro]]
</div>

=== Environment ===
<div align="justify">
Esta do menu superior permite controlar os ambientes, grupos de variáveis criadas pelo usuário. Por padrão, as variáveis exibidas na aba '''Env''' do do painel de configuração de requisição (no lado superior direito da tela) fazem parte de um arquivo que é salvo automaticamente sempre que o programa é fechado. O arquivo '''Env.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de environment para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. As variáveis carregadas serão exibidas na aba '''Env''' do painel de configuração de requisição.

*'''Salvar:''' Essa opção permite salvar as variáveis atuais em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de environment ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.
</div>

=== Opções ===

==== Exportar Curl ====
<div align="justify">
Essa opção abre uma janela que exibe a requisição selecionada formatada no padrão cURL. É possível aumentar e diminuir a janela, o que pode facilitar a visualização no caso de requisições com conteúdo mais extenso.

Vale ressaltar que a requisição exibida sempre será aquela que estiver selecionada no momento.

[[Image: CGWebRequest_13.png|centro]]

*'''Copiar:''' Copia a cURL para a área de transferência. Uma mensagem aparece na parte debaixo da janela, confirmando a ação.
*'''Salvar:''' Abre uma janela que permite salvar a cURL em um arquivo de texto.
</div>

==== Timeout ====
<div align="justify">
Essa opção abre uma janela onde é possível configurar o timeout geral para todas as requisições, que é medido em segundos. O valor pode ser inserido diretamente no campo '''Tempo em segundos''' ou pode ser incrementado de um em um através das setas disponíveis no componente.

Vale ressaltar que, quando o programa é fechado, o timeout configurado é salvo junto com a coleção atual. Quando ela for carregada novamente, seja na inicialização do programa ou via arquivo, o timeout também se manterá.

[[Image: CGWebRequest_14.png|450px|centro]]

*'''OK:''' Salva as configurações feitas e fecha a janela.
*'''Cancelar:''' Fecha a janela sem salvar as alterações feitas.
</div>

=== Ajuda ===
<div align="justify">
Essa opção do menu possui algumas informações que podem ser úteis e informativas para o usuário.
</div>

==== Sobre ====
<div align="justify">
Abre uma janela com informações sobre o '''CGWebRequest Client'''.

[[Image: CGWebRequest_15.png|450px|centro]]
</div>

<div align="justify">

==== Página da Wiki ====
Essa opção abre o link externo que leva até esta página.
</div>

CGWebRequestClient

2026-07-20T14:00:47Z

Vinicius.moder:

<div align="justify">
O '''CIGAM WebRequest Client''' é uma ferramenta destinada à criação, ao envio e à validação de requisições. Com ele, é possível configurar métodos HTTP, URLs, parâmetros de query, headers, bodies, tempo de requisição e variáveis reutilizáveis, além de visualizar o código de status, o conteúdo e os headers das respostas.

Abaixo, detalhamos cada uma de suas funcionalidades para guiar a utilização correta da aplicação.
</div>

== Tela inicial ==
<div align="justify">
Ao iniciar, o '''CGWebRequest Client''' exibirá uma janela completa dividida em 3 sessões principais, além do menu superior. O painel mais à esquerda exibe a coleção ativa e permite a criação de novas requisições. O painel superior à direita exibe detalhes da requisição atualmente selecionada, enquanto o painel inferior à direita exibe informações sobre a resposta da requisição atual, se houver.

A largura ou a altura desses painéis pode ser modificada pelo usuário ao parar o mouse na linha que as divide, clicar e arrastar. Isso pode facilitar a visualização em casos onde há muita informação relevante na tela.
</div>

[[Image: CGWebRequest_01.png|750px|centro]]

== Coleção ==
<div align="justify">
Nesse painel, ficam exibidas, de forma simplificada, todas as requisições criadas pelo usuário, em forma de tabela. Em uma das colunas, é exibido o verbo selecionado para cada requisição (que pode ser alterado a qualquer momento) e na outra é exibido o nome da requisição, que pode ser personalizado pelo usuário.
</div>

=== Verbo ===
<div align="justify">
Para escolher ou alterar o verbo de uma requisição basta clicar na seta que fica no lado direito da caixa de seleção na coluna '''verb''' no painel da coleção. Uma lista com os verbos disponíveis será exibida, então basta selecionar o desejado. Note-se que cada um deles possui uma cor específica, facilitando a visualização e compreensão. Os verbos disponíveis são:

*'''GET:''' Azul
*'''POST:''' Verde
*'''PUT:''' Amarelo
*'''DELETE:''' Vermelho
*'''PATCH:''' Roxo
*'''HEAD:''' Rosa
*'''OPTIONS:''' Marrom
*'''PROPFIND:''' Bege
</div>

[[Image: CGWebRequest_02.png|400px|centro]]

=== Nome ===
<div align="justify">
A coluna '''request''' da tabela permite a personalização do nome da requisição. Para adicionar um nome ou editá-lo, basta dar dois cliques na linha em questão, o que habilitará o cursor para digitação.
</div>

[[Image: CGWebRequest_03.png|400px|centro]]

=== Adicionar ===
<div align="justify">
Para adicionar uma nova requisição basta selecionar a última linha da tabela de requisições e personalizá-la com o verbo e o nome desejados. Sempre que o usuário modifica essa última linha, o programa automaticamente cria a próxima linha em branco.
</div>

=== Menu de Contexto ===
<div align="justify">
Clicar com o botão direito em alguma requisição irá exibir um menu de contexto com 3 opções:

[[Image: CGWebRequest_04.png|400px|centro]]

*'''Duplicate:''' Essa opção duplica a requisição selecionada, criando uma igual na última linha da tabela.
*'''Delete:''' Essa opção exclui a requisição selecionada.
*'''Exportar Curl:''' Essa opção exibe uma janela com a requisição selecionada formatada no padrão cURL. Para mais detalhes veja [[CGWebRequestClient#Exportar Curl|Exportar Curl]].
</div>

== Requisição ==
<div align="justify">
O painel de requisição é onde os detalhes podem ser configurados. O verbo selecionado (pode ser feito no painel de coleção, à esquerda) é exibido junto com sua respectiva cor de referência. Logo ao lado fica a caixa de texto da URL e, mais abaixo, um painel com abas que permitem as mais diversas configurações.

[[Image: CGWebRequest_16.png|750px|centro]]

=== URL ===
</div>
<div align="justify">
A caixa de texto da URL pode ser preenchida com o endereço desejado. Tendo feito isso, o valor preenchido previamente ficará salvo automaticamente. Dessa forma, o usuário pode navegar entre uma requisição e outra sem perder uma URL previamente digitada Ou seja, sempre que uma determinada requisição for selecionada no painel de coleção, a URL dela será exibida no painel de requisição.

</div>
<div align="justify">
Ao lado da barra de URL localiza-se o botão '''Enviar''', que, como o nome sugere, faz o envio da requisição. Ao clicar nele, o programa irá trabalhar para executar os comandos com base na configuração previamente estabelecida. Para que haja se obtenha sucesso, é necessário configurar todos os campos previamente.
</div>

[[Image: CGWebRequest_05(2).png|750px|centro]]

=== Env ===
<div align="justify">
Nessa aba do painel de configuração de requisição é possível configurar uma série de variáveis que podem facilitar a interação com diferentes requisições. É possível visualizar e editar variáveis conforme for desejado. Para tanto, basta utilizar um clique duplo na célula em questão, o que habilita o editor, permitindo a alteração por parte do usuário.
</div>
<div align="justify">
Para criar uma variável, tal qual na tabela de coleção, basta clicar na última linha e digitar o nome e o valor desejado. Sempre que uma nova variável é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>
<div align="justify">
Toda variável possui um nome e um valor, que estão representadas nas colunas '''Variable''' e '''Value'''. O nome de uma variável pode ser incluído em uma URL para facilitar sua alteração quando várias requisições possuem uma mesma URL. Para incluir a variável dessa forma, basta utilizar o nome dela entre chaves '''{{}}''' (chaves duplas):
</div>

<div align="justify">
*'''Nome:''' API
*'''Valor:''' <nowiki>/https://minhaapi.com/exemplo</nowiki>
*'''URL:''' <nowiki>{{API}}</nowiki>/login
</div>

[[Image: CGWebRequest_06(2).png|centro]]

=== Query ===
<div align="justify">
As queries de uma requisição ficam representadas na aba '''Query''' da tabela de configuração de requisição. Quando uma URL possui queries, o programa automaticamente faz a quebra dela, mantendo o texto até o '''?''' na parte superior e o dividindo o restante em linhas de uma tabela, onde é possível visualizá-las em detalhes.
</div>
<div align="justify">
Também é possível inserir queries manualmente, preenchendo o parâmetro e o valor ao utilizar um clique duplo na célula desejada. Da mesma forma que nas outras tabelas, sempre que uma nova linha é criada, o programa automaticamente adiciona uma linha em branco no final da tabela.
</div>

==== Parâmetros e valores ====
São representados pelas colunas da tabela de queries. Quando estão presentes na URL colada na barra de texto acima, o programa os identifica automaticamente. É possível editá-los após isso.

Além do mais, na última coluna dessa tabela sempre haverá uma checkbox que inicia marcada por padrão. Quando marcada, o programa incluirá a query na requisição, é possível desmarcá-la para que a query em questão seja ignorada. É uma forma prática de alterar a requisição sem ter de refazê-la ou criar uma nova.
</div>

[[Image: CGWebRequest_07(2).png|centro]]

=== Headers ===
<div align="justify">
Nesta aba é possível inserir e editar os cabeçalhos de uma requisição. Com funcionamento semelhante à aba '''Query''', os headers possuem um nome e um valor, representados pelas colunas '''Header''' e '''Value'''. Eles podem ser editados utilizando-se um clique duplo na célula desejada e novos podem ser criados selecionando a última linha da tabela. Sempre que a última linha é preenchida, uma nova linha em branco é criada automaticamente no final da tabela.

Há uma checkbox na última coluna dessa tabela, que permite selecionar se um header deve, ou não, ser enviado junto com a requisição. A checkbox vem marcada por padrão. É comum que requisições diferentes possuam headers iguais, portanto essa opção é muito útil.
</div>

[[Image: CGWebRequest_08(2).png|centro]]

=== Body ===
<div align="justify">
Esta aba permite personalizar o corpo da requisição. Ela é subdividida entre outras 3 abas, que servem para selecionar o tipo, o formato no qual o body será enviado. É necessário selecionar o tipo compatível com a requisição desejada. Os tipos disponíveis são: JSON, XML e RAW.

Além disso, há uma caixa de texto onde o código do body pode ser digitado livremente. O conteúdo ali contido será enviado com a requisição. Abaixo, um exemplo de um body do tipo JSON:

[[Image: CGWebRequest_09(2).png|centro]]

*'''Limpar:''' Botão que limpa todo o conteúdo do body quando clicado.
*'''Abrir:''' Botão que permite ler o conteúdo de uma arquivo externo e adicioná-lo ao body. É necessário que o arquivo seja do tipo JSON. Quando lido, o conteúdo será exibido na caixa de texto destinada ao body, abaixo dos botões.
</div>

== Resposta ==
<div align="justify">
O painel inferior do lado direito é destinado a tudo aquilo que for retornado pela requisição.

*'''Código:''' No canto superior esquerdo desse painel ficará registrado o código de status da resposta. É o primeiro indicativo de sucesso ou fracasso de uma requisição, e sempre será exibido assim que ela for completada (se for completada).

*'''Tempo:''' O tempo de requisição é exibido logo ao lado do código de status, e registra em segundos a duração desde o envio da requisição até o recebimento da resposta.

*'''Botão Salvar:''' Fica no canto superior direito desse painel, e permite salvar o conteúdo da resposta em uma arquivo JSON.

[[Image: CGWebRequest_10(2).png|750px|centro]]
</div>

=== Response ===
<div align="justify">
Aba que exibe um campo de texto com o corpo da resposta. Como pode variar muito, o campo destinado a ela e é extenso e possui barras de rolagem para facilitar a navegação. A imagem acima mostra um exemplo de resposta no formato JSON.
</div>

=== Headers ===
<div align="justify">
Nessa aba é possível visualizar os cabeçalhos da resposta. Eles ficam exibidos em uma tabela com duas colunas: '''Header''' e '''Value''', que representam o nome e o valor de cada header. É possível visualizar um exemplo na imagem abaixo:

[[Image: CGWebRequest_11.png|500px|centro]]
</div>

== Menu superior ==

=== Collection ===
<div align="justify">
Esta opção permite controlar coleções, grupos de requisições criadas pelo usuário. Por padrão, as requisições exibidas no painel de coleção (no lado esquerdo da tela) fazem parte de uma coleção que é salva automaticamente sempre que o programa é fechado. O arquivo '''Collection.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

Além da lista de requisições, o arquivo também guarda a configuração de timeout definida pelo usuário (para mais detalhes ver [[CGWebRequestClient#Timeout|Timeout]]).

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de coleção para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. A coleção carregada será exibida no painel de coleção.

*'''Salvar:''' Essa opção permite salvar a coleção atual em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de coleção ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.

[[Image: CGWebRequest_12.png|750px|centro]]
</div>

=== Environment ===
<div align="justify">
Esta do menu superior permite controlar os ambientes, grupos de variáveis criadas pelo usuário. Por padrão, as variáveis exibidas na aba '''Env''' do do painel de configuração de requisição (no lado superior direito da tela) fazem parte de um arquivo que é salvo automaticamente sempre que o programa é fechado. O arquivo '''Env.json''' é criado no pasta '''AppData''' do usuário. Esse arquivo também é aberto automaticamente sempre que o programa é iniciado.

*'''Abrir:''' Ao escolher essa opção, uma janela será aberta para que o usuário escolha um arquivo de environment para ser aberto. Por padrão, a pasta exibida primeiro será a '''AppData''' do usuário, porém é possível escolher o arquivo de qualquer local ao qual se tenha acesso. As variáveis carregadas serão exibidas na aba '''Env''' do painel de configuração de requisição.

*'''Salvar:''' Essa opção permite salvar as variáveis atuais em um arquivo JSON. O programa já faz isso automaticamente quando é encerrado, porém pode ser útil caso o usuário queira trabalhar com diferentes arquivos de environment ou queira enviar o arquivo para outra pessoa. Uma janela será aberta para que seja selecionado o local e o nome do novo arquivo.
</div>

=== Opções ===

==== Exportar Curl ====
<div align="justify">
Essa opção abre uma janela que exibe a requisição selecionada formatada no padrão cURL. É possível aumentar e diminuir a janela, o que pode facilitar a visualização no caso de requisições com conteúdo mais extenso.

Vale ressaltar que a requisição exibida sempre será aquela que estiver selecionada no momento.

[[Image: CGWebRequest_13.png|centro]]

*'''Copiar:''' Copia a cURL para a área de transferência. Uma mensagem aparece na parte debaixo da janela, confirmando a ação.
*'''Salvar:''' Abre uma janela que permite salvar a cURL em um arquivo de texto.
</div>

==== Timeout ====
<div align="justify">
Essa opção abre uma janela onde é possível configurar o timeout geral para todas as requisições, que é medido em segundos. O valor pode ser inserido diretamente no campo '''Tempo em segundos''' ou pode ser incrementado de um em um através das setas disponíveis no componente.

Vale ressaltar que, quando o programa é fechado, o timeout configurado é salvo junto com a coleção atual. Quando ela for carregada novamente, seja na inicialização do programa ou via arquivo, o timeout também se manterá.

[[Image: CGWebRequest_14.png|450px|centro]]

*'''OK:''' Salva as configurações feitas e fecha a janela.
*'''Cancelar:''' Fecha a janela sem salvar as alterações feitas.
</div>

=== Ajuda ===
<div align="justify">
Essa opção do menu possui algumas informações que podem ser úteis e informativas para o usuário.
</div>

==== Sobre ====
<div align="justify">
Abre uma janela com informações sobre o '''CGWebRequest Client'''.

[[Image: CGWebRequest_15.png|450px|centro]]
</div>

<div align="justify">

==== Página da Wiki ====
Essa opção abre o link externo que leva até esta página.
</div>