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

GE Parâmetros

2026-04-28T12:50:50Z

Alessandro.voto:

[[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]]
 
 
[[GE_Parâmetros_Usuários|Usuários]]
 

[[GE_TG - Tecnologia de Grupo|TG - Tecnologia de Grupo]]
 
[[GE_Questionário|Questionário]]
 

[[GE_Coleções|Coleções]]
 
[[GE_Configurações|Configurações]]
 

[[GE_* Modelos de Relatórios|* Modelos de Relatórios]]
 
[[GE_Modelos de e-mail|Modelos de e-mail]]
 
[[GE_Limites Permitidos|Limites Permitidos]]
 
[[GE_Limites Tipo de Operação|Limites Tipo de Operação]]
 
[[GE_Unidades de Negócio|Unidades de Negócio]]
 
[[GE_Tabela de Preços|Tabela de Preços]]
 
[[GE_Parâmetros_Organograma|Organograma]]
 
[[GE_Parâmetros_Responsáveis Setor|Responsáveis Setor]]
 

[[GE_Personalizar Campos Empresa/Pessoa|Personalizar Campos Empresa/Pessoa]]
 
[[GE_Personalizar Campos Contato|Personalizar Campos Contato]]
 
[[GE_Últimos Ids Sequenciais|Últimos Ids Sequenciais]]
 
[[GE_Último Número de Empresa/Pessoa|Último Número de Empresa/Pessoa]]
 

[[GE_Manutenção de Calendário|Manutenção de Calendário]]
 
[[GE_Parâmetros_Impressoras X Documentos|Impressoras X Documentos]]
 

[[GE_Gerenciamento de acessos externos - Portais|Gerenciamento de acessos externos - Portais]]
 
[[GE_Motivo|Motivo]]
 
[[GE_Gerenciamento de Perfil de uso dos Portais| Gerenciamento de Perfil de uso dos Portais]]
 
[[GE_Parâmetros OAuth|Parâmetros OAuth]]

GE - Como Fazer - Integração CIGAM e WMS Fullsoft

2026-03-12T14:03:21Z

Alessandro.voto: /* Como Fazer - Integração CIGAM e WMS Fullsoft */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[categoria:Como Fazer Utilidades/Diversos_3]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Integração CIGAM e WMS Fullsoft]]

== Palavras-Chave ==
Integração CIGAM vs WMS FullSoft. Como Integrar CIGAM com WMS FullSoft. Warehouse Management System (WMS). Integração CIGAM e WMS.

= Como Fazer - Integração CIGAM e WMS Fullsoft =
Este tópico apresenta orientações para a integração entre o CIGAM e o WMS Fullsoft, abordando os principais pontos de configuração, comunicação e validação das informações trocadas entre os sistemas.

Durante o processo de implantação ou em situações de análise de inconsistências na integração, pode ser necessário habilitar a geração de LOG para auxiliar no diagnóstico e no acompanhamento do processamento. Após esse período, recomenda-se manter a geração de LOG desativada, evitando a criação desnecessária de registros e possível impacto no desempenho do ambiente.

Para mais informações sobre como habilitar o LOG, consulte: [[Como ativar o log no WMS?]]

= Quais são os tipos de materiais suportados entre CIGAM x WMS Fullsoft? =

Permite que sejam utilizados materiais simples e com controle de lote. É possível também ter o controle de Materiais com Configurador de Produto.


'''Não escopo:''' Grade, Especificações Independentes ou Estoque e Números de Série.

= Qual o Banco de dados homologado?=

Homologado somente em banco de dados Microsoft SQL Server.

=Módulos necessários=
* '''[[Suprimentos]]:''' [[ES_Gestão de Materiais|Gestão de Materiais]], [[CO_Compras|Compras]] e [[CO_Requisições de Materiais|Requisições de Materiais]]
* '''[[FA_Faturamento/Pedido|Faturamento/Pedido]]:''' [[FA_Pedidos|Pedidos]] e [[FA_Nota Fiscal|Nota Fiscal]]
* '''[[GE_Genéricos|Genéricos]]:''' [[Integrador]]
* '''[[PC_Programação e Controle de Produção|Programação e Controle de Produção]]:''' Somente quando houver Indústria

=Módulos/Funcionalidades não escopo=
* [[CL_Gestão de Lojas|Gestão de Lojas]]: [[CL_Orçamento|Orçamento]] e [[CL_Orçamento por Controle|Orçamento por Controle]]
* [[GM_Gestão de Serviços|Gestão de Serviços]]: [[GM_Movimentos_Ordem de Serviço|Ordens de Serviço]] com vínculos de Materiais
* [[CO_Devolução de Entradas|Devolução de Entradas]] e [[FA_Devolução de Saídas|Saídas]]
* Faturamento Parcial
* O método "'''MovimentoAvaria'''" não utiliza lotes.

=Quais documentos podem ser utilizados entre CIGAM x WMS Fullsoft?=
* Notas Fiscais de Entrada
* Separação de Pedidos
* Separação de Entregas
* Separação de Requisições de Materiais
* Balanço de Estoque


'''Importante:''' Qualquer funcionalidade não mencionada é considerada como não escopo e deve sempre ser avaliada com equipe técnica.

=Como é realizada a Integração?=

A integração entre CIGAM x WMS FULLSOFT é realizada através de Web Service.


Web Service é uma forma de comunicação entre sistemas, a qual permite integrar dados padronizados entre ambos. Como meio de comunicação são utilizadas mensagens no formato '''XML'''.


Desta forma, é realizado via um '''HTTP''' pela internet, ou seja, é um link compartilhado entre ambos para receber e enviar o '''XML'''.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoft.png|850px|center|Integração CIGAM vs WMS Fullsoft]]

=Serviços/Métodos para Integração WMS Fullsoft=

Será disponibilizado um link ao cliente, o qual estará desta forma:

<pre>
https://cliente.cigam.cloud/WebServicesProd/Integrador/nome_do_webservice
</pre>


Após a informação [...]Integrador/[...], ou seja, depois da “/” (barra) indica que deve ser informado o '''nome do webservice'''.


São '''6 WebServices''' que podem vinculados a este link:

<pre>
CadastroBalanco.integrador.asmx
CadastroEmpresas.integrador.asmx
CadastroItemRequisicaoMaterial.integrador.asmx
CadastroMaterais.integrador.asmx
CadastroMovimentos.integrador.asmx
CadastroPedidos.integrador.asmx
</pre>


Dentro de cada um deles, haverá os '''métodos''', ou seja, as '''funções''' que este '''webservices''' pode realizar nesta integração.


Para o correto funcionamento dos '''Serviços''' e junto a eles os '''Métodos''', são necessários cadastros de '''COLEÇÕES'''.

{| class="wikitable" style="margin:auto;width:90%"
|-
! Serviço (WebService) !! Método
|-
| CadastroBalanco.integrador.asmx || Cadastrar
|-
| CadastroEmpresas.integrador.asmx || ListarTransportadoras
|-
| rowspan="2" | CadastroItemRequisicaoMaterial.integrador.asmx
| ListarItensRequisicoesSeparacao
|-
| ApontamentoSeparacaoItemRequisicao
|-
| rowspan="6" | CadastroMateriais.integrador.asmx
| ListarItensConferencia
|-
| ListarItensFaturamento
|-
| ListarItensFaturamento
|-
| ListarCodigoBarrasItensSeparacao
|-
| ListarCodigoBarrasItensConferencia
|-
| ListarCodigoBarrasItensFaturamento
|-
| rowspan="10" | CadastroMovimentos.integrador.asmx
| ListarOPsConferencia
|-
| ListarNFsConferencia
|-
| ApontamentoConferencia
|-
| ApontamentoConferenciaLote
|-
| ApontamentoSeparacao
|-
| ApontamentoSeparacaoLote
|-
| ConfirmarRecebimentoOP
|-
| ListarAvulsosConferencia
|-
| ListarAvulsosConferencia
|-
| ListarRetornoBeneficiamentoConferencia
|-
| rowspan="10" | CadastroPedidos.integrador.asmx
| ListarPedidosSeparacao
|-
| ListarPedidosSeparacao
|-
| ApontamentoSeparacaoPedido
|-
| ApontamentoInicioSeparacaoItemPedido
|-
| ApontamentoSeparacaoItemPedido
|-
| ApontamentoCancelamentoPedido
|-
| ListarEntregasSeparacao
|-
| ApontamentoSeparacaoEntrega
|-
| DevolucaoSeparacaoEntrega
|-
| DevolucaoSeparacaoEntregaParcial
|}

=O que são as Coleções?=

As '''Coleções''' são parâmetros para que o método possa executar a comunicação corretamente e padronizada.

* Exemplo do Serviço: CadastroMateriais + Método: ListarItensConferencia + '''Coleção''': MACF


No exemplo citado, o '''MACF''' – Itens para Conferência, refere-se que ao executar o Serviço + Método trará todos os itens que são disponibilizados para que seja realizada a Conferência.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoft1.png|550px|center|Integração CIGAM vs WMS Fullsoft 1]]

== Cadastro de Coleções - CIGAM ==

As COLEÇÕES são a única maneira de padronizar as informações de envio (CIGAM) e retorno (WMS FULLSOFT).


Nas COLEÇÕES é onde se cadastra quais informações serão enviadas ao WMS FULLSFOT, são elas:

* Materiais
* Controles
* Centros de Armazenagem
* Clientes
* Tipos de Operação
* Unidade de Negócio


Para realizar os cadastros de COLEÇÕES, deve-se acessar o CIGAM no módulo [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Coleções|Coleções]].


Nesta tela, todos os cadastros devem ser realizados conforme as regras e padrões definidos para a respectiva regra de negócio e de acordo com os webservices estabelecidos.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadColecoes.png|850px|center|Integração CIGAM vs WMS Fullsoft - Coleções]]

== Cadastro de Coleções - Regras Padronizadas ==

Para que se tenha um cadastro correto de [[GE_Coleções|Coleções]] é necessário entender os principais cadastros a serem utilizados:

* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Unidade_de_Negócio|Unidade de Negócio]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Controles|Controles]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Centro_de_Armazenagem|Centro de Armazenagem]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Materiais|Materiais]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Tipos_de_Operações|Tipos de Operações]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Clientes,_Empresas_e_Transportadoras|Clientes]]

===Unidade de Negócio===

Deve ser avaliado quais Unidades de Negócio serão integradas com o WMS.


As Unidades desta escolha deverão ser cadastradas na Coleção: '''UNIW'''

===Controles===

Para os Controles a serem integrados com o WMS devem ter duas distinções: 


1. Para '''PEDIDOS''' devem ser separados em '''6 Coleções''': 

* '''CPPE''' - Controle de Pedidos Pendentes
* '''CPPS''' - Controle de Pedidos Liberados para Separação de Pedidos
* '''CPPI''' - Controle de Pedidos para Separações Iniciadas
* '''CPFA''' - Controle de Pedidos para Separações Finalizadas
* '''CPPC''' - Controle de Pedidos que podem ser Cancelados pelo WMS
* '''CPSZ''' - Controle de Pedidos que não podem ser Separados

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadControlesPedido.png|750px|center|Integração CIGAM vs WMS Fullsoft - Controles Pedido]]


2. Para '''REQUISIÇÕES DE MATERIAIS''' devem ser separados em '''3 Coleções''':

* '''CPRS''' - Controle para Requisição de Materiais Liberada ao WMS
* '''CPRP''' - Controle para Requisição de Materiais Separadas WMS
* '''CPRP''' - Controle para Req. de Mat. que não podem ser Separadas

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadControlesRequisicoes.png|650px|center|Integração CIGAM vs WMS Fullsoft - Controles Requisições]]


'''Observações Importantes referente aos Controles:'''

:Há a Coleção '''CPSP''' - Situação para itens pedidos para separação parcial.

:Funcionalidade a qual não é prevista na Integração.

:É importante que clientes que utilizam faturamento parcial, ao implementarem o WMS Fullsoft, realizem uma customização dessa funcionalidade tanto no CIGAM quanto no WMS Fullsoft.

:No CIGAM, é possível realizar o faturamento parcial, ou seja, um pedido pode ser faturado inúmeras vezes, enquanto houver saldo disponível. Quando há integração com o WMS Fullsoft, após o envio dos dados (número do pedido), ele será recebido e devolvido apenas uma única vez. Isso significa que, no WMS Fullsoft, não é possível separar o mesmo pedido múltiplas vezes.

:Após o início do processamento, o WMS Fullsoft só retornará as informações ao CIGAM quando o pedido estiver finalizado. Dessa forma, não é possível devolver um saldo menor do que o enviado pelo CIGAM. A quantidade devolvida deve ser exatamente a mesma enviada, garantindo a integridade do pedido para o cliente final.

===Centro de Armazenagem===

Para os Centros de Armazenagem devem ser separados em '''4 Coleções''':

* '''CACF''' - Centro de Armazenagem Recebimento
* '''CASP''' - Centro de Armazenagem Estoque Principal
* '''CAFA''' - Centro de Armazenagem para Faturamento
* '''CAAV''' - Centro de Armazenagem para itens Avariados

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadCentrosdeArmazenagem.png|750px|center|Integração CIGAM vs WMS Fullsoft - Centros de Armazenagem]]

===Materiais===

Para os '''Materiais''' devem ser separados em '''3 Coleções''':

* '''MACF''' - Materiais WMS (para conferência)
* '''MASP''' - Materiais WMS (para separação)
* '''MAFA''' - Materiais WMS (para faturamento)


'''Observação:''' Quando há '''Configurador de Produto''' e houver um código de barras para cada '''Identificador''' deverá ser realizado o cadastro de outras '''3 Coleções''':

* '''TGBC''' - Códigos de barras de itens para conferência
* '''TGBS''' - Códigos de barras de itens para separação
* '''TGBF''' - Códigos de barras de itens para faturamento


'''Importante:'''

:Mesmo quando o não houver a utilização do Configurador de Produto estas Coleções devem ser cadastradas a nível de Coleção sem informações adicionais, irão servir apenas a nível integridade em passar por estes dados e encontrar informações vazias.

===Tipos de Operações===

Para os '''Tipos de Operações''' devem ser separados em '''4 Coleções''':

* '''TOTC''' - Tipo de Operação para Movimentos de Recebimento
* '''TOTF''' - Tipo de Operação para Movimentos de Separação de Ped.
* '''TOAV''' - Tipo de Operação de Movimentos de Transf. Avariados
* '''TOTP''' - Tipo de Operação de Movimentos de Transf. Requisições


Todos os Tipos de Operação devem ter como característica serem com espécie de estoque de transferência e com correlato de entrada, para que possam ser removidos do WMS FULLSOFT e gerar a movimentação no CIGAM, mantendo assim, o histórico e integridade dos movimentos de estoque.

===Clientes, Empresas e Transportadoras===

Para os '''Clientes, Empresas, Transportadoras''' e todos cadastros em relação a [[GE_Empresas/Pessoas|Empresas/Pessoas]] no CIGAM, devem ser separados por '''3 Coleções''':

* '''EMCL''' - Clientes e Outros
* '''EMTR''' - Transportadoras
* '''EMFO''' - Fornecedores

===Ocorrências de Produção===

Para que seja possível Endereçar as Ordens de Produção, devem ser vinculadas a '''Coleção – OPSP''' as ocorrências que devem ser enviadas ao WMS Fullsoft.

* '''EMCL''' - Clientes e Outros
* '''EMTR''' - Transportadoras
* '''EMFO''' - Fornecedores

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftFluxoGeral.png|750px|center|Integração CIGAM vs WMS Fullsoft - Fluxo Geral]]

=Balanço e Inventários=
==Parâmetros do Serviço responsável pelo Inventário==

O retorno dos dados oriundos da FULLSOFT no Serviço devem respeitar os seguintes campos grifados em vermelho.


As tags, "statusRegistro" e "sequencia" conforme anexo devem ser '''FIXOS''' "'''L'''" e "'''1'''".

* [[WMS_CadastroBalanco.integrador]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftInventarioParametros.png|750px|center|Integração CIGAM vs WMS Fullsoft - Inventario - Parâmetros]]

==Parâmetros WMS==

Para que o CIGAM receba informações de Estoque conforme Unidade de Negócio, deve ser parametrizado no WMS Fullsoft no programa '''WF9011'''.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftInventarioParametrosWMS.png|850px|center|Integração CIGAM vs WMS Fullsoft - Inventario - Parâmetros WMS]]


'''Importante:'''

:As informações de Inventário/Balanço virão do SINC (sincronizador do WMS Fullsoft). O CIGAM só irá receber as informações depois que for finalizado no SINC, ou seja, somente depois que a houver o "commit" pelo SINC.

:Isso garante que o CIGAM não irá receber as informações gradativamente pela integração.

==Painel Integrador CIGAM==

Ao realizar Pesquisas no CIGAM, será possível visualizar as informações recebidas, neste caso o BALANÇO/INVENTÁRIO oriundo do WMS, o qual gerou dados na Tabela '''GEINTEGR'''.

* [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Pesquisas|Pesquisas]] > [[GE_Pesquisas_Rotinas|Rotinas]] > [[GE_Painel Integrador|Painel Integrador]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftInventarioPainelIntegrador.png|850px|center|Integração CIGAM vs WMS Fullsoft - Inventario - Painel Integrador]]

==Integrador CIGAM==

Após finalizada a contagem no WMS, deve ser ligado o [[GE_Integrador|Integrador CIGAM]] com a opção "'''Balanços'''". Assim os balanços liberados pelo WMS poderão ser integrados ao CIGAM.

* [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Rotinas|Rotinas]] > [[GE_Rotinas_EDI|EDI]] > [[GE_Rotinas_EDI_Recebe|Recebe]] > [[GE_Integrador|Integrador]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftIntegradorCIGAM.png|750px|center|Integração CIGAM vs WMS Fullsoft - Integrador CIGAM]]

==Balanço do Estoque - Rotina CIGAM==

Após a geração do Integrador CIGAM, as informações serão populadas na tela de Balanço com informações oriundas do WMS.

* [[Suprimentos]] > [[ES_Gestão de Materiais|Gestão de Materiais]] > [[ES_Rotinas|Rotinas]] > [[ES_Rotinas_Operacionais|Operacionais]] > [[Es_Balanço|Balanço]] > [[ES_Balanço apurado|Balanço apurado]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftBalancoEstoqueCIGAM.png|750px|center|Integração CIGAM vs WMS Fullsoft - Balanço de Estoque - CIGAM]]

==Divergência de Balanço CIGAM==

Sendo assim, após receber as informações via tela de [[ES_Balanço apurado|Balanço Apurado]], para espelhar os Estoques poderá ser utilizada a rotina [[ES_Divergências de Balanço|Divergências de Balanço]].

* [[Suprimentos]] > [[ES_Gestão de Materiais|Gestão de Materiais]] > [[ES_Rotinas|Rotinas]] > [[ES_Rotinas_Operacionais|Operacionais]] > [[Es_Balanço|Balanço]] > [[ES_Divergências de Balanço|Divergências de Balanço]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftDivergenciaBalancoCIGAM.png|750px|center|Integração CIGAM vs WMS Fullsoft - Divergência de Balanço - CIGAM]]


É importante utilizar tipos de operações exclusivos para entradas e saídas a fins de ter histórico das informações de movimentações de estoque e entender a razão das divergências de estoque.

=Requisição de Materiais=
==Como Fazer Requisição de Materiais==

Avaliação do Estoque antes de separar a Requisição pelo WMS:

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoPesquisaEstoque.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição - Pesquisa de Materiais]]


'''Requisição de Materiais:''' Na Requisição ao WMS está sendo solicitado para que sejam transferidas 50 Unidades para o CA 999. A requisição já está no Controle "'''Liberado WM'''".

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoMaterial.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição de Materiais]]

 
[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftFluxoRequisicaoMaterial.png|850px|center|Integração CIGAM vs WMS Fullsoft - Requisição de Materiais]]

==Serviços==
===ListarItensRequisicoesSeparacao===

Para conseguir identificar o XML enviado ao WMS, deve ser executado via CGWebserviceInvoker este serviço: ListarItensRequisicoesSeparacao

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftServicosListarItens.png|550px|center|Integração CIGAM vs WMS Fullsoft - Serviços - ListarItensRequisicoesSeparacao]]

===ApontamentoSeparacaoItemRequisicao===

Para realizar a separação da Requisição deve-se utilizar do método "ApontamentoSeparacaoItemRequisicao" onde conforme os parâmetros irá receber os dados de retorno, com base nos dados de envio. Desta forma, gerando assim as movimentações.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftServicosApontamentoSeparacaoItemRequisicao.png|550px|center|Integração CIGAM vs WMS Fullsoft - Serviços - ApontamentoSeparacaoItemRequisicao]]


Gerando assim as movimentações corretamente conforme a Requisição de Materiais.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftServicosApontamentoSeparacaoItemRequisicao2.png|750px|center|Integração CIGAM vs WMS Fullsoft - Serviços - ApontamentoSeparacaoItemRequisicao]]


Desta forma, a Requisição troca o Controle para Separada e o item ficará como Atendido:

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoAtendida.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição Atendida]]


Mantendo os Estoque conforme necessidade.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoAtendidaEstoque.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição Atendida - Estoque]]

=Integração e Comunicação Webservice=
<center><youtube>V_00MkY78yI</youtube></center>

=Como avaliar se os materiais estão sendo integrados?=
<center><youtube>8vfIdsT6oAo</youtube></center>

=Envio e Retorno da Nota Fiscal de Entrada=
<center><youtube>uDUFe7--s2I</youtube></center>

=Início, separação e cancelamento de pedidos=
<center><youtube>cchyZy2oFGU</youtube></center>



=FAQs Relacionadas=
* [[IN Integrador CIGAM Fullsoft]]
*[[Como devo acionar quando existir ocorrências de informações incoerentes na integração com WMS?]]
*[[Como identificar o porquê não houve troca de controle no CIGAM após cancelamento no WMS?]]
*[[Como proceder ao identificar um erro de saída sem saldo?]]
*[[Como proceder a leitura de uma Ordem de Produção que está tendo lentidão a ser passada para o Coletor?]]
*[[Como proceder quando o Cigam não está fazendo movimentação de saldo quando uma requisição é separada no WMS?]]
*[[Como proceder quando o material novo não aparece para o WMS?]]
*[[Nota/Pedido não está aparecendo, o que fazer?]]
*[[Ordem de Produção (OP) não está aparecendo, o que fazer?]]
*[[XML está com erro de retorno, o que avaliar?]]
*[[Como realizar contagem de Estoque pelo WMS?]]
*[[Como ativar o log no WMS?]]
*[[Como cancelar o Pedido pelo WMS?]]
*[[Pedido cancelado, não é possível realizar a separação?]]
*[[Divergência na Nota Fiscal de Entrada, o que fazer?]]

GE - Como Fazer - Integração CIGAM e WMS Fullsoft

2026-03-12T14:02:16Z

Alessandro.voto: /* Como Fazer - Integração CIGAM e WMS Fullsoft */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[categoria:Como Fazer Utilidades/Diversos_3]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Integração CIGAM e WMS Fullsoft]]

== Palavras-Chave ==
Integração CIGAM vs WMS FullSoft. Como Integrar CIGAM com WMS FullSoft. Warehouse Management System (WMS). Integração CIGAM e WMS.

= Como Fazer - Integração CIGAM e WMS Fullsoft =
Este tópico apresenta orientações para a integração entre o CIGAM e o WMS Fullsoft, abordando os principais pontos de configuração, comunicação e validação das informações trocadas entre os sistemas.

Durante o processo de implantação ou em situações de análise de inconsistências na integração, pode ser necessário habilitar a geração de LOG para auxiliar no diagnóstico e no acompanhamento do processamento. Após esse período, recomenda-se manter a geração de LOG desativada, evitando a criação desnecessária de registros e possível impacto no desempenho do ambiente.

Para mais informações sobre como habilitar o LOG, consulte: [[Como ativar o log no WMS?|Como ativar o log no WMS?]]

= Quais são os tipos de materiais suportados entre CIGAM x WMS Fullsoft? =

Permite que sejam utilizados materiais simples e com controle de lote. É possível também ter o controle de Materiais com Configurador de Produto.


'''Não escopo:''' Grade, Especificações Independentes ou Estoque e Números de Série.

= Qual o Banco de dados homologado?=

Homologado somente em banco de dados Microsoft SQL Server.

=Módulos necessários=
* '''[[Suprimentos]]:''' [[ES_Gestão de Materiais|Gestão de Materiais]], [[CO_Compras|Compras]] e [[CO_Requisições de Materiais|Requisições de Materiais]]
* '''[[FA_Faturamento/Pedido|Faturamento/Pedido]]:''' [[FA_Pedidos|Pedidos]] e [[FA_Nota Fiscal|Nota Fiscal]]
* '''[[GE_Genéricos|Genéricos]]:''' [[Integrador]]
* '''[[PC_Programação e Controle de Produção|Programação e Controle de Produção]]:''' Somente quando houver Indústria

=Módulos/Funcionalidades não escopo=
* [[CL_Gestão de Lojas|Gestão de Lojas]]: [[CL_Orçamento|Orçamento]] e [[CL_Orçamento por Controle|Orçamento por Controle]]
* [[GM_Gestão de Serviços|Gestão de Serviços]]: [[GM_Movimentos_Ordem de Serviço|Ordens de Serviço]] com vínculos de Materiais
* [[CO_Devolução de Entradas|Devolução de Entradas]] e [[FA_Devolução de Saídas|Saídas]]
* Faturamento Parcial
* O método "'''MovimentoAvaria'''" não utiliza lotes.

=Quais documentos podem ser utilizados entre CIGAM x WMS Fullsoft?=
* Notas Fiscais de Entrada
* Separação de Pedidos
* Separação de Entregas
* Separação de Requisições de Materiais
* Balanço de Estoque


'''Importante:''' Qualquer funcionalidade não mencionada é considerada como não escopo e deve sempre ser avaliada com equipe técnica.

=Como é realizada a Integração?=

A integração entre CIGAM x WMS FULLSOFT é realizada através de Web Service.


Web Service é uma forma de comunicação entre sistemas, a qual permite integrar dados padronizados entre ambos. Como meio de comunicação são utilizadas mensagens no formato '''XML'''.


Desta forma, é realizado via um '''HTTP''' pela internet, ou seja, é um link compartilhado entre ambos para receber e enviar o '''XML'''.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoft.png|850px|center|Integração CIGAM vs WMS Fullsoft]]

=Serviços/Métodos para Integração WMS Fullsoft=

Será disponibilizado um link ao cliente, o qual estará desta forma:

<pre>
https://cliente.cigam.cloud/WebServicesProd/Integrador/nome_do_webservice
</pre>


Após a informação [...]Integrador/[...], ou seja, depois da “/” (barra) indica que deve ser informado o '''nome do webservice'''.


São '''6 WebServices''' que podem vinculados a este link:

<pre>
CadastroBalanco.integrador.asmx
CadastroEmpresas.integrador.asmx
CadastroItemRequisicaoMaterial.integrador.asmx
CadastroMaterais.integrador.asmx
CadastroMovimentos.integrador.asmx
CadastroPedidos.integrador.asmx
</pre>


Dentro de cada um deles, haverá os '''métodos''', ou seja, as '''funções''' que este '''webservices''' pode realizar nesta integração.


Para o correto funcionamento dos '''Serviços''' e junto a eles os '''Métodos''', são necessários cadastros de '''COLEÇÕES'''.

{| class="wikitable" style="margin:auto;width:90%"
|-
! Serviço (WebService) !! Método
|-
| CadastroBalanco.integrador.asmx || Cadastrar
|-
| CadastroEmpresas.integrador.asmx || ListarTransportadoras
|-
| rowspan="2" | CadastroItemRequisicaoMaterial.integrador.asmx
| ListarItensRequisicoesSeparacao
|-
| ApontamentoSeparacaoItemRequisicao
|-
| rowspan="6" | CadastroMateriais.integrador.asmx
| ListarItensConferencia
|-
| ListarItensFaturamento
|-
| ListarItensFaturamento
|-
| ListarCodigoBarrasItensSeparacao
|-
| ListarCodigoBarrasItensConferencia
|-
| ListarCodigoBarrasItensFaturamento
|-
| rowspan="10" | CadastroMovimentos.integrador.asmx
| ListarOPsConferencia
|-
| ListarNFsConferencia
|-
| ApontamentoConferencia
|-
| ApontamentoConferenciaLote
|-
| ApontamentoSeparacao
|-
| ApontamentoSeparacaoLote
|-
| ConfirmarRecebimentoOP
|-
| ListarAvulsosConferencia
|-
| ListarAvulsosConferencia
|-
| ListarRetornoBeneficiamentoConferencia
|-
| rowspan="10" | CadastroPedidos.integrador.asmx
| ListarPedidosSeparacao
|-
| ListarPedidosSeparacao
|-
| ApontamentoSeparacaoPedido
|-
| ApontamentoInicioSeparacaoItemPedido
|-
| ApontamentoSeparacaoItemPedido
|-
| ApontamentoCancelamentoPedido
|-
| ListarEntregasSeparacao
|-
| ApontamentoSeparacaoEntrega
|-
| DevolucaoSeparacaoEntrega
|-
| DevolucaoSeparacaoEntregaParcial
|}

=O que são as Coleções?=

As '''Coleções''' são parâmetros para que o método possa executar a comunicação corretamente e padronizada.

* Exemplo do Serviço: CadastroMateriais + Método: ListarItensConferencia + '''Coleção''': MACF


No exemplo citado, o '''MACF''' – Itens para Conferência, refere-se que ao executar o Serviço + Método trará todos os itens que são disponibilizados para que seja realizada a Conferência.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoft1.png|550px|center|Integração CIGAM vs WMS Fullsoft 1]]

== Cadastro de Coleções - CIGAM ==

As COLEÇÕES são a única maneira de padronizar as informações de envio (CIGAM) e retorno (WMS FULLSOFT).


Nas COLEÇÕES é onde se cadastra quais informações serão enviadas ao WMS FULLSFOT, são elas:

* Materiais
* Controles
* Centros de Armazenagem
* Clientes
* Tipos de Operação
* Unidade de Negócio


Para realizar os cadastros de COLEÇÕES, deve-se acessar o CIGAM no módulo [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Coleções|Coleções]].


Nesta tela, todos os cadastros devem ser realizados conforme as regras e padrões definidos para a respectiva regra de negócio e de acordo com os webservices estabelecidos.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadColecoes.png|850px|center|Integração CIGAM vs WMS Fullsoft - Coleções]]

== Cadastro de Coleções - Regras Padronizadas ==

Para que se tenha um cadastro correto de [[GE_Coleções|Coleções]] é necessário entender os principais cadastros a serem utilizados:

* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Unidade_de_Negócio|Unidade de Negócio]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Controles|Controles]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Centro_de_Armazenagem|Centro de Armazenagem]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Materiais|Materiais]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Tipos_de_Operações|Tipos de Operações]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Clientes,_Empresas_e_Transportadoras|Clientes]]

===Unidade de Negócio===

Deve ser avaliado quais Unidades de Negócio serão integradas com o WMS.


As Unidades desta escolha deverão ser cadastradas na Coleção: '''UNIW'''

===Controles===

Para os Controles a serem integrados com o WMS devem ter duas distinções: 


1. Para '''PEDIDOS''' devem ser separados em '''6 Coleções''': 

* '''CPPE''' - Controle de Pedidos Pendentes
* '''CPPS''' - Controle de Pedidos Liberados para Separação de Pedidos
* '''CPPI''' - Controle de Pedidos para Separações Iniciadas
* '''CPFA''' - Controle de Pedidos para Separações Finalizadas
* '''CPPC''' - Controle de Pedidos que podem ser Cancelados pelo WMS
* '''CPSZ''' - Controle de Pedidos que não podem ser Separados

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadControlesPedido.png|750px|center|Integração CIGAM vs WMS Fullsoft - Controles Pedido]]


2. Para '''REQUISIÇÕES DE MATERIAIS''' devem ser separados em '''3 Coleções''':

* '''CPRS''' - Controle para Requisição de Materiais Liberada ao WMS
* '''CPRP''' - Controle para Requisição de Materiais Separadas WMS
* '''CPRP''' - Controle para Req. de Mat. que não podem ser Separadas

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadControlesRequisicoes.png|650px|center|Integração CIGAM vs WMS Fullsoft - Controles Requisições]]


'''Observações Importantes referente aos Controles:'''

:Há a Coleção '''CPSP''' - Situação para itens pedidos para separação parcial.

:Funcionalidade a qual não é prevista na Integração.

:É importante que clientes que utilizam faturamento parcial, ao implementarem o WMS Fullsoft, realizem uma customização dessa funcionalidade tanto no CIGAM quanto no WMS Fullsoft.

:No CIGAM, é possível realizar o faturamento parcial, ou seja, um pedido pode ser faturado inúmeras vezes, enquanto houver saldo disponível. Quando há integração com o WMS Fullsoft, após o envio dos dados (número do pedido), ele será recebido e devolvido apenas uma única vez. Isso significa que, no WMS Fullsoft, não é possível separar o mesmo pedido múltiplas vezes.

:Após o início do processamento, o WMS Fullsoft só retornará as informações ao CIGAM quando o pedido estiver finalizado. Dessa forma, não é possível devolver um saldo menor do que o enviado pelo CIGAM. A quantidade devolvida deve ser exatamente a mesma enviada, garantindo a integridade do pedido para o cliente final.

===Centro de Armazenagem===

Para os Centros de Armazenagem devem ser separados em '''4 Coleções''':

* '''CACF''' - Centro de Armazenagem Recebimento
* '''CASP''' - Centro de Armazenagem Estoque Principal
* '''CAFA''' - Centro de Armazenagem para Faturamento
* '''CAAV''' - Centro de Armazenagem para itens Avariados

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadCentrosdeArmazenagem.png|750px|center|Integração CIGAM vs WMS Fullsoft - Centros de Armazenagem]]

===Materiais===

Para os '''Materiais''' devem ser separados em '''3 Coleções''':

* '''MACF''' - Materiais WMS (para conferência)
* '''MASP''' - Materiais WMS (para separação)
* '''MAFA''' - Materiais WMS (para faturamento)


'''Observação:''' Quando há '''Configurador de Produto''' e houver um código de barras para cada '''Identificador''' deverá ser realizado o cadastro de outras '''3 Coleções''':

* '''TGBC''' - Códigos de barras de itens para conferência
* '''TGBS''' - Códigos de barras de itens para separação
* '''TGBF''' - Códigos de barras de itens para faturamento


'''Importante:'''

:Mesmo quando o não houver a utilização do Configurador de Produto estas Coleções devem ser cadastradas a nível de Coleção sem informações adicionais, irão servir apenas a nível integridade em passar por estes dados e encontrar informações vazias.

===Tipos de Operações===

Para os '''Tipos de Operações''' devem ser separados em '''4 Coleções''':

* '''TOTC''' - Tipo de Operação para Movimentos de Recebimento
* '''TOTF''' - Tipo de Operação para Movimentos de Separação de Ped.
* '''TOAV''' - Tipo de Operação de Movimentos de Transf. Avariados
* '''TOTP''' - Tipo de Operação de Movimentos de Transf. Requisições


Todos os Tipos de Operação devem ter como característica serem com espécie de estoque de transferência e com correlato de entrada, para que possam ser removidos do WMS FULLSOFT e gerar a movimentação no CIGAM, mantendo assim, o histórico e integridade dos movimentos de estoque.

===Clientes, Empresas e Transportadoras===

Para os '''Clientes, Empresas, Transportadoras''' e todos cadastros em relação a [[GE_Empresas/Pessoas|Empresas/Pessoas]] no CIGAM, devem ser separados por '''3 Coleções''':

* '''EMCL''' - Clientes e Outros
* '''EMTR''' - Transportadoras
* '''EMFO''' - Fornecedores

===Ocorrências de Produção===

Para que seja possível Endereçar as Ordens de Produção, devem ser vinculadas a '''Coleção – OPSP''' as ocorrências que devem ser enviadas ao WMS Fullsoft.

* '''EMCL''' - Clientes e Outros
* '''EMTR''' - Transportadoras
* '''EMFO''' - Fornecedores

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftFluxoGeral.png|750px|center|Integração CIGAM vs WMS Fullsoft - Fluxo Geral]]

=Balanço e Inventários=
==Parâmetros do Serviço responsável pelo Inventário==

O retorno dos dados oriundos da FULLSOFT no Serviço devem respeitar os seguintes campos grifados em vermelho.


As tags, "statusRegistro" e "sequencia" conforme anexo devem ser '''FIXOS''' "'''L'''" e "'''1'''".

* [[WMS_CadastroBalanco.integrador]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftInventarioParametros.png|750px|center|Integração CIGAM vs WMS Fullsoft - Inventario - Parâmetros]]

==Parâmetros WMS==

Para que o CIGAM receba informações de Estoque conforme Unidade de Negócio, deve ser parametrizado no WMS Fullsoft no programa '''WF9011'''.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftInventarioParametrosWMS.png|850px|center|Integração CIGAM vs WMS Fullsoft - Inventario - Parâmetros WMS]]


'''Importante:'''

:As informações de Inventário/Balanço virão do SINC (sincronizador do WMS Fullsoft). O CIGAM só irá receber as informações depois que for finalizado no SINC, ou seja, somente depois que a houver o "commit" pelo SINC.

:Isso garante que o CIGAM não irá receber as informações gradativamente pela integração.

==Painel Integrador CIGAM==

Ao realizar Pesquisas no CIGAM, será possível visualizar as informações recebidas, neste caso o BALANÇO/INVENTÁRIO oriundo do WMS, o qual gerou dados na Tabela '''GEINTEGR'''.

* [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Pesquisas|Pesquisas]] > [[GE_Pesquisas_Rotinas|Rotinas]] > [[GE_Painel Integrador|Painel Integrador]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftInventarioPainelIntegrador.png|850px|center|Integração CIGAM vs WMS Fullsoft - Inventario - Painel Integrador]]

==Integrador CIGAM==

Após finalizada a contagem no WMS, deve ser ligado o [[GE_Integrador|Integrador CIGAM]] com a opção "'''Balanços'''". Assim os balanços liberados pelo WMS poderão ser integrados ao CIGAM.

* [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Rotinas|Rotinas]] > [[GE_Rotinas_EDI|EDI]] > [[GE_Rotinas_EDI_Recebe|Recebe]] > [[GE_Integrador|Integrador]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftIntegradorCIGAM.png|750px|center|Integração CIGAM vs WMS Fullsoft - Integrador CIGAM]]

==Balanço do Estoque - Rotina CIGAM==

Após a geração do Integrador CIGAM, as informações serão populadas na tela de Balanço com informações oriundas do WMS.

* [[Suprimentos]] > [[ES_Gestão de Materiais|Gestão de Materiais]] > [[ES_Rotinas|Rotinas]] > [[ES_Rotinas_Operacionais|Operacionais]] > [[Es_Balanço|Balanço]] > [[ES_Balanço apurado|Balanço apurado]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftBalancoEstoqueCIGAM.png|750px|center|Integração CIGAM vs WMS Fullsoft - Balanço de Estoque - CIGAM]]

==Divergência de Balanço CIGAM==

Sendo assim, após receber as informações via tela de [[ES_Balanço apurado|Balanço Apurado]], para espelhar os Estoques poderá ser utilizada a rotina [[ES_Divergências de Balanço|Divergências de Balanço]].

* [[Suprimentos]] > [[ES_Gestão de Materiais|Gestão de Materiais]] > [[ES_Rotinas|Rotinas]] > [[ES_Rotinas_Operacionais|Operacionais]] > [[Es_Balanço|Balanço]] > [[ES_Divergências de Balanço|Divergências de Balanço]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftDivergenciaBalancoCIGAM.png|750px|center|Integração CIGAM vs WMS Fullsoft - Divergência de Balanço - CIGAM]]


É importante utilizar tipos de operações exclusivos para entradas e saídas a fins de ter histórico das informações de movimentações de estoque e entender a razão das divergências de estoque.

=Requisição de Materiais=
==Como Fazer Requisição de Materiais==

Avaliação do Estoque antes de separar a Requisição pelo WMS:

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoPesquisaEstoque.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição - Pesquisa de Materiais]]


'''Requisição de Materiais:''' Na Requisição ao WMS está sendo solicitado para que sejam transferidas 50 Unidades para o CA 999. A requisição já está no Controle "'''Liberado WM'''".

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoMaterial.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição de Materiais]]

 
[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftFluxoRequisicaoMaterial.png|850px|center|Integração CIGAM vs WMS Fullsoft - Requisição de Materiais]]

==Serviços==
===ListarItensRequisicoesSeparacao===

Para conseguir identificar o XML enviado ao WMS, deve ser executado via CGWebserviceInvoker este serviço: ListarItensRequisicoesSeparacao

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftServicosListarItens.png|550px|center|Integração CIGAM vs WMS Fullsoft - Serviços - ListarItensRequisicoesSeparacao]]

===ApontamentoSeparacaoItemRequisicao===

Para realizar a separação da Requisição deve-se utilizar do método "ApontamentoSeparacaoItemRequisicao" onde conforme os parâmetros irá receber os dados de retorno, com base nos dados de envio. Desta forma, gerando assim as movimentações.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftServicosApontamentoSeparacaoItemRequisicao.png|550px|center|Integração CIGAM vs WMS Fullsoft - Serviços - ApontamentoSeparacaoItemRequisicao]]


Gerando assim as movimentações corretamente conforme a Requisição de Materiais.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftServicosApontamentoSeparacaoItemRequisicao2.png|750px|center|Integração CIGAM vs WMS Fullsoft - Serviços - ApontamentoSeparacaoItemRequisicao]]


Desta forma, a Requisição troca o Controle para Separada e o item ficará como Atendido:

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoAtendida.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição Atendida]]


Mantendo os Estoque conforme necessidade.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoAtendidaEstoque.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição Atendida - Estoque]]

=Integração e Comunicação Webservice=
<center><youtube>V_00MkY78yI</youtube></center>

=Como avaliar se os materiais estão sendo integrados?=
<center><youtube>8vfIdsT6oAo</youtube></center>

=Envio e Retorno da Nota Fiscal de Entrada=
<center><youtube>uDUFe7--s2I</youtube></center>

=Início, separação e cancelamento de pedidos=
<center><youtube>cchyZy2oFGU</youtube></center>



=FAQs Relacionadas=
* [[IN Integrador CIGAM Fullsoft]]
*[[Como devo acionar quando existir ocorrências de informações incoerentes na integração com WMS?]]
*[[Como identificar o porquê não houve troca de controle no CIGAM após cancelamento no WMS?]]
*[[Como proceder ao identificar um erro de saída sem saldo?]]
*[[Como proceder a leitura de uma Ordem de Produção que está tendo lentidão a ser passada para o Coletor?]]
*[[Como proceder quando o Cigam não está fazendo movimentação de saldo quando uma requisição é separada no WMS?]]
*[[Como proceder quando o material novo não aparece para o WMS?]]
*[[Nota/Pedido não está aparecendo, o que fazer?]]
*[[Ordem de Produção (OP) não está aparecendo, o que fazer?]]
*[[XML está com erro de retorno, o que avaliar?]]
*[[Como realizar contagem de Estoque pelo WMS?]]
*[[Como ativar o log no WMS?]]
*[[Como cancelar o Pedido pelo WMS?]]
*[[Pedido cancelado, não é possível realizar a separação?]]
*[[Divergência na Nota Fiscal de Entrada, o que fazer?]]

GE - Como Fazer - Integração CIGAM e WMS Fullsoft

2026-03-12T13:54:51Z

Alessandro.voto: /* Como Fazer - Integração CIGAM e WMS Fullsoft */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[categoria:Como Fazer Utilidades/Diversos_3]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Integração CIGAM e WMS Fullsoft]]

== Palavras-Chave ==
Integração CIGAM vs WMS FullSoft. Como Integrar CIGAM com WMS FullSoft. Warehouse Management System (WMS). Integração CIGAM e WMS.

= Como Fazer - Integração CIGAM e WMS Fullsoft =
Este tópico apresenta orientações para a integração entre o CIGAM e o WMS Fullsoft, abordando os principais pontos de configuração, comunicação e validação das informações trocadas entre os sistemas.

Durante o processo de implantação ou em situações de análise de inconsistências na integração, pode ser necessário habilitar a geração de LOG para auxiliar no diagnóstico e no acompanhamento do processamento. Após esse período, recomenda-se manter a geração de LOG desativada, evitando a criação desnecessária de registros e possível impacto no desempenho do ambiente.

Para mais informações sobre como habilitar o LOG, consulte: Como ativar o log no WMS?

= Quais são os tipos de materiais suportados entre CIGAM x WMS Fullsoft? =

Permite que sejam utilizados materiais simples e com controle de lote. É possível também ter o controle de Materiais com Configurador de Produto.


'''Não escopo:''' Grade, Especificações Independentes ou Estoque e Números de Série.

= Qual o Banco de dados homologado?=

Homologado somente em banco de dados Microsoft SQL Server.

=Módulos necessários=
* '''[[Suprimentos]]:''' [[ES_Gestão de Materiais|Gestão de Materiais]], [[CO_Compras|Compras]] e [[CO_Requisições de Materiais|Requisições de Materiais]]
* '''[[FA_Faturamento/Pedido|Faturamento/Pedido]]:''' [[FA_Pedidos|Pedidos]] e [[FA_Nota Fiscal|Nota Fiscal]]
* '''[[GE_Genéricos|Genéricos]]:''' [[Integrador]]
* '''[[PC_Programação e Controle de Produção|Programação e Controle de Produção]]:''' Somente quando houver Indústria

=Módulos/Funcionalidades não escopo=
* [[CL_Gestão de Lojas|Gestão de Lojas]]: [[CL_Orçamento|Orçamento]] e [[CL_Orçamento por Controle|Orçamento por Controle]]
* [[GM_Gestão de Serviços|Gestão de Serviços]]: [[GM_Movimentos_Ordem de Serviço|Ordens de Serviço]] com vínculos de Materiais
* [[CO_Devolução de Entradas|Devolução de Entradas]] e [[FA_Devolução de Saídas|Saídas]]
* Faturamento Parcial
* O método "'''MovimentoAvaria'''" não utiliza lotes.

=Quais documentos podem ser utilizados entre CIGAM x WMS Fullsoft?=
* Notas Fiscais de Entrada
* Separação de Pedidos
* Separação de Entregas
* Separação de Requisições de Materiais
* Balanço de Estoque


'''Importante:''' Qualquer funcionalidade não mencionada é considerada como não escopo e deve sempre ser avaliada com equipe técnica.

=Como é realizada a Integração?=

A integração entre CIGAM x WMS FULLSOFT é realizada através de Web Service.


Web Service é uma forma de comunicação entre sistemas, a qual permite integrar dados padronizados entre ambos. Como meio de comunicação são utilizadas mensagens no formato '''XML'''.


Desta forma, é realizado via um '''HTTP''' pela internet, ou seja, é um link compartilhado entre ambos para receber e enviar o '''XML'''.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoft.png|850px|center|Integração CIGAM vs WMS Fullsoft]]

=Serviços/Métodos para Integração WMS Fullsoft=

Será disponibilizado um link ao cliente, o qual estará desta forma:

<pre>
https://cliente.cigam.cloud/WebServicesProd/Integrador/nome_do_webservice
</pre>


Após a informação [...]Integrador/[...], ou seja, depois da “/” (barra) indica que deve ser informado o '''nome do webservice'''.


São '''6 WebServices''' que podem vinculados a este link:

<pre>
CadastroBalanco.integrador.asmx
CadastroEmpresas.integrador.asmx
CadastroItemRequisicaoMaterial.integrador.asmx
CadastroMaterais.integrador.asmx
CadastroMovimentos.integrador.asmx
CadastroPedidos.integrador.asmx
</pre>


Dentro de cada um deles, haverá os '''métodos''', ou seja, as '''funções''' que este '''webservices''' pode realizar nesta integração.


Para o correto funcionamento dos '''Serviços''' e junto a eles os '''Métodos''', são necessários cadastros de '''COLEÇÕES'''.

{| class="wikitable" style="margin:auto;width:90%"
|-
! Serviço (WebService) !! Método
|-
| CadastroBalanco.integrador.asmx || Cadastrar
|-
| CadastroEmpresas.integrador.asmx || ListarTransportadoras
|-
| rowspan="2" | CadastroItemRequisicaoMaterial.integrador.asmx
| ListarItensRequisicoesSeparacao
|-
| ApontamentoSeparacaoItemRequisicao
|-
| rowspan="6" | CadastroMateriais.integrador.asmx
| ListarItensConferencia
|-
| ListarItensFaturamento
|-
| ListarItensFaturamento
|-
| ListarCodigoBarrasItensSeparacao
|-
| ListarCodigoBarrasItensConferencia
|-
| ListarCodigoBarrasItensFaturamento
|-
| rowspan="10" | CadastroMovimentos.integrador.asmx
| ListarOPsConferencia
|-
| ListarNFsConferencia
|-
| ApontamentoConferencia
|-
| ApontamentoConferenciaLote
|-
| ApontamentoSeparacao
|-
| ApontamentoSeparacaoLote
|-
| ConfirmarRecebimentoOP
|-
| ListarAvulsosConferencia
|-
| ListarAvulsosConferencia
|-
| ListarRetornoBeneficiamentoConferencia
|-
| rowspan="10" | CadastroPedidos.integrador.asmx
| ListarPedidosSeparacao
|-
| ListarPedidosSeparacao
|-
| ApontamentoSeparacaoPedido
|-
| ApontamentoInicioSeparacaoItemPedido
|-
| ApontamentoSeparacaoItemPedido
|-
| ApontamentoCancelamentoPedido
|-
| ListarEntregasSeparacao
|-
| ApontamentoSeparacaoEntrega
|-
| DevolucaoSeparacaoEntrega
|-
| DevolucaoSeparacaoEntregaParcial
|}

=O que são as Coleções?=

As '''Coleções''' são parâmetros para que o método possa executar a comunicação corretamente e padronizada.

* Exemplo do Serviço: CadastroMateriais + Método: ListarItensConferencia + '''Coleção''': MACF


No exemplo citado, o '''MACF''' – Itens para Conferência, refere-se que ao executar o Serviço + Método trará todos os itens que são disponibilizados para que seja realizada a Conferência.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoft1.png|550px|center|Integração CIGAM vs WMS Fullsoft 1]]

== Cadastro de Coleções - CIGAM ==

As COLEÇÕES são a única maneira de padronizar as informações de envio (CIGAM) e retorno (WMS FULLSOFT).


Nas COLEÇÕES é onde se cadastra quais informações serão enviadas ao WMS FULLSFOT, são elas:

* Materiais
* Controles
* Centros de Armazenagem
* Clientes
* Tipos de Operação
* Unidade de Negócio


Para realizar os cadastros de COLEÇÕES, deve-se acessar o CIGAM no módulo [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Coleções|Coleções]].


Nesta tela, todos os cadastros devem ser realizados conforme as regras e padrões definidos para a respectiva regra de negócio e de acordo com os webservices estabelecidos.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadColecoes.png|850px|center|Integração CIGAM vs WMS Fullsoft - Coleções]]

== Cadastro de Coleções - Regras Padronizadas ==

Para que se tenha um cadastro correto de [[GE_Coleções|Coleções]] é necessário entender os principais cadastros a serem utilizados:

* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Unidade_de_Negócio|Unidade de Negócio]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Controles|Controles]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Centro_de_Armazenagem|Centro de Armazenagem]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Materiais|Materiais]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Tipos_de_Operações|Tipos de Operações]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Clientes,_Empresas_e_Transportadoras|Clientes]]

===Unidade de Negócio===

Deve ser avaliado quais Unidades de Negócio serão integradas com o WMS.


As Unidades desta escolha deverão ser cadastradas na Coleção: '''UNIW'''

===Controles===

Para os Controles a serem integrados com o WMS devem ter duas distinções: 


1. Para '''PEDIDOS''' devem ser separados em '''6 Coleções''': 

* '''CPPE''' - Controle de Pedidos Pendentes
* '''CPPS''' - Controle de Pedidos Liberados para Separação de Pedidos
* '''CPPI''' - Controle de Pedidos para Separações Iniciadas
* '''CPFA''' - Controle de Pedidos para Separações Finalizadas
* '''CPPC''' - Controle de Pedidos que podem ser Cancelados pelo WMS
* '''CPSZ''' - Controle de Pedidos que não podem ser Separados

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadControlesPedido.png|750px|center|Integração CIGAM vs WMS Fullsoft - Controles Pedido]]


2. Para '''REQUISIÇÕES DE MATERIAIS''' devem ser separados em '''3 Coleções''':

* '''CPRS''' - Controle para Requisição de Materiais Liberada ao WMS
* '''CPRP''' - Controle para Requisição de Materiais Separadas WMS
* '''CPRP''' - Controle para Req. de Mat. que não podem ser Separadas

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadControlesRequisicoes.png|650px|center|Integração CIGAM vs WMS Fullsoft - Controles Requisições]]


'''Observações Importantes referente aos Controles:'''

:Há a Coleção '''CPSP''' - Situação para itens pedidos para separação parcial.

:Funcionalidade a qual não é prevista na Integração.

:É importante que clientes que utilizam faturamento parcial, ao implementarem o WMS Fullsoft, realizem uma customização dessa funcionalidade tanto no CIGAM quanto no WMS Fullsoft.

:No CIGAM, é possível realizar o faturamento parcial, ou seja, um pedido pode ser faturado inúmeras vezes, enquanto houver saldo disponível. Quando há integração com o WMS Fullsoft, após o envio dos dados (número do pedido), ele será recebido e devolvido apenas uma única vez. Isso significa que, no WMS Fullsoft, não é possível separar o mesmo pedido múltiplas vezes.

:Após o início do processamento, o WMS Fullsoft só retornará as informações ao CIGAM quando o pedido estiver finalizado. Dessa forma, não é possível devolver um saldo menor do que o enviado pelo CIGAM. A quantidade devolvida deve ser exatamente a mesma enviada, garantindo a integridade do pedido para o cliente final.

===Centro de Armazenagem===

Para os Centros de Armazenagem devem ser separados em '''4 Coleções''':

* '''CACF''' - Centro de Armazenagem Recebimento
* '''CASP''' - Centro de Armazenagem Estoque Principal
* '''CAFA''' - Centro de Armazenagem para Faturamento
* '''CAAV''' - Centro de Armazenagem para itens Avariados

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadCentrosdeArmazenagem.png|750px|center|Integração CIGAM vs WMS Fullsoft - Centros de Armazenagem]]

===Materiais===

Para os '''Materiais''' devem ser separados em '''3 Coleções''':

* '''MACF''' - Materiais WMS (para conferência)
* '''MASP''' - Materiais WMS (para separação)
* '''MAFA''' - Materiais WMS (para faturamento)


'''Observação:''' Quando há '''Configurador de Produto''' e houver um código de barras para cada '''Identificador''' deverá ser realizado o cadastro de outras '''3 Coleções''':

* '''TGBC''' - Códigos de barras de itens para conferência
* '''TGBS''' - Códigos de barras de itens para separação
* '''TGBF''' - Códigos de barras de itens para faturamento


'''Importante:'''

:Mesmo quando o não houver a utilização do Configurador de Produto estas Coleções devem ser cadastradas a nível de Coleção sem informações adicionais, irão servir apenas a nível integridade em passar por estes dados e encontrar informações vazias.

===Tipos de Operações===

Para os '''Tipos de Operações''' devem ser separados em '''4 Coleções''':

* '''TOTC''' - Tipo de Operação para Movimentos de Recebimento
* '''TOTF''' - Tipo de Operação para Movimentos de Separação de Ped.
* '''TOAV''' - Tipo de Operação de Movimentos de Transf. Avariados
* '''TOTP''' - Tipo de Operação de Movimentos de Transf. Requisições


Todos os Tipos de Operação devem ter como característica serem com espécie de estoque de transferência e com correlato de entrada, para que possam ser removidos do WMS FULLSOFT e gerar a movimentação no CIGAM, mantendo assim, o histórico e integridade dos movimentos de estoque.

===Clientes, Empresas e Transportadoras===

Para os '''Clientes, Empresas, Transportadoras''' e todos cadastros em relação a [[GE_Empresas/Pessoas|Empresas/Pessoas]] no CIGAM, devem ser separados por '''3 Coleções''':

* '''EMCL''' - Clientes e Outros
* '''EMTR''' - Transportadoras
* '''EMFO''' - Fornecedores

===Ocorrências de Produção===

Para que seja possível Endereçar as Ordens de Produção, devem ser vinculadas a '''Coleção – OPSP''' as ocorrências que devem ser enviadas ao WMS Fullsoft.

* '''EMCL''' - Clientes e Outros
* '''EMTR''' - Transportadoras
* '''EMFO''' - Fornecedores

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftFluxoGeral.png|750px|center|Integração CIGAM vs WMS Fullsoft - Fluxo Geral]]

=Balanço e Inventários=
==Parâmetros do Serviço responsável pelo Inventário==

O retorno dos dados oriundos da FULLSOFT no Serviço devem respeitar os seguintes campos grifados em vermelho.


As tags, "statusRegistro" e "sequencia" conforme anexo devem ser '''FIXOS''' "'''L'''" e "'''1'''".

* [[WMS_CadastroBalanco.integrador]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftInventarioParametros.png|750px|center|Integração CIGAM vs WMS Fullsoft - Inventario - Parâmetros]]

==Parâmetros WMS==

Para que o CIGAM receba informações de Estoque conforme Unidade de Negócio, deve ser parametrizado no WMS Fullsoft no programa '''WF9011'''.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftInventarioParametrosWMS.png|850px|center|Integração CIGAM vs WMS Fullsoft - Inventario - Parâmetros WMS]]


'''Importante:'''

:As informações de Inventário/Balanço virão do SINC (sincronizador do WMS Fullsoft). O CIGAM só irá receber as informações depois que for finalizado no SINC, ou seja, somente depois que a houver o "commit" pelo SINC.

:Isso garante que o CIGAM não irá receber as informações gradativamente pela integração.

==Painel Integrador CIGAM==

Ao realizar Pesquisas no CIGAM, será possível visualizar as informações recebidas, neste caso o BALANÇO/INVENTÁRIO oriundo do WMS, o qual gerou dados na Tabela '''GEINTEGR'''.

* [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Pesquisas|Pesquisas]] > [[GE_Pesquisas_Rotinas|Rotinas]] > [[GE_Painel Integrador|Painel Integrador]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftInventarioPainelIntegrador.png|850px|center|Integração CIGAM vs WMS Fullsoft - Inventario - Painel Integrador]]

==Integrador CIGAM==

Após finalizada a contagem no WMS, deve ser ligado o [[GE_Integrador|Integrador CIGAM]] com a opção "'''Balanços'''". Assim os balanços liberados pelo WMS poderão ser integrados ao CIGAM.

* [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Rotinas|Rotinas]] > [[GE_Rotinas_EDI|EDI]] > [[GE_Rotinas_EDI_Recebe|Recebe]] > [[GE_Integrador|Integrador]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftIntegradorCIGAM.png|750px|center|Integração CIGAM vs WMS Fullsoft - Integrador CIGAM]]

==Balanço do Estoque - Rotina CIGAM==

Após a geração do Integrador CIGAM, as informações serão populadas na tela de Balanço com informações oriundas do WMS.

* [[Suprimentos]] > [[ES_Gestão de Materiais|Gestão de Materiais]] > [[ES_Rotinas|Rotinas]] > [[ES_Rotinas_Operacionais|Operacionais]] > [[Es_Balanço|Balanço]] > [[ES_Balanço apurado|Balanço apurado]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftBalancoEstoqueCIGAM.png|750px|center|Integração CIGAM vs WMS Fullsoft - Balanço de Estoque - CIGAM]]

==Divergência de Balanço CIGAM==

Sendo assim, após receber as informações via tela de [[ES_Balanço apurado|Balanço Apurado]], para espelhar os Estoques poderá ser utilizada a rotina [[ES_Divergências de Balanço|Divergências de Balanço]].

* [[Suprimentos]] > [[ES_Gestão de Materiais|Gestão de Materiais]] > [[ES_Rotinas|Rotinas]] > [[ES_Rotinas_Operacionais|Operacionais]] > [[Es_Balanço|Balanço]] > [[ES_Divergências de Balanço|Divergências de Balanço]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftDivergenciaBalancoCIGAM.png|750px|center|Integração CIGAM vs WMS Fullsoft - Divergência de Balanço - CIGAM]]


É importante utilizar tipos de operações exclusivos para entradas e saídas a fins de ter histórico das informações de movimentações de estoque e entender a razão das divergências de estoque.

=Requisição de Materiais=
==Como Fazer Requisição de Materiais==

Avaliação do Estoque antes de separar a Requisição pelo WMS:

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoPesquisaEstoque.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição - Pesquisa de Materiais]]


'''Requisição de Materiais:''' Na Requisição ao WMS está sendo solicitado para que sejam transferidas 50 Unidades para o CA 999. A requisição já está no Controle "'''Liberado WM'''".

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoMaterial.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição de Materiais]]

 
[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftFluxoRequisicaoMaterial.png|850px|center|Integração CIGAM vs WMS Fullsoft - Requisição de Materiais]]

==Serviços==
===ListarItensRequisicoesSeparacao===

Para conseguir identificar o XML enviado ao WMS, deve ser executado via CGWebserviceInvoker este serviço: ListarItensRequisicoesSeparacao

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftServicosListarItens.png|550px|center|Integração CIGAM vs WMS Fullsoft - Serviços - ListarItensRequisicoesSeparacao]]

===ApontamentoSeparacaoItemRequisicao===

Para realizar a separação da Requisição deve-se utilizar do método "ApontamentoSeparacaoItemRequisicao" onde conforme os parâmetros irá receber os dados de retorno, com base nos dados de envio. Desta forma, gerando assim as movimentações.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftServicosApontamentoSeparacaoItemRequisicao.png|550px|center|Integração CIGAM vs WMS Fullsoft - Serviços - ApontamentoSeparacaoItemRequisicao]]


Gerando assim as movimentações corretamente conforme a Requisição de Materiais.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftServicosApontamentoSeparacaoItemRequisicao2.png|750px|center|Integração CIGAM vs WMS Fullsoft - Serviços - ApontamentoSeparacaoItemRequisicao]]


Desta forma, a Requisição troca o Controle para Separada e o item ficará como Atendido:

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoAtendida.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição Atendida]]


Mantendo os Estoque conforme necessidade.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoAtendidaEstoque.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição Atendida - Estoque]]

=Integração e Comunicação Webservice=
<center><youtube>V_00MkY78yI</youtube></center>

=Como avaliar se os materiais estão sendo integrados?=
<center><youtube>8vfIdsT6oAo</youtube></center>

=Envio e Retorno da Nota Fiscal de Entrada=
<center><youtube>uDUFe7--s2I</youtube></center>

=Início, separação e cancelamento de pedidos=
<center><youtube>cchyZy2oFGU</youtube></center>



=FAQs Relacionadas=
* [[IN Integrador CIGAM Fullsoft]]
*[[Como devo acionar quando existir ocorrências de informações incoerentes na integração com WMS?]]
*[[Como identificar o porquê não houve troca de controle no CIGAM após cancelamento no WMS?]]
*[[Como proceder ao identificar um erro de saída sem saldo?]]
*[[Como proceder a leitura de uma Ordem de Produção que está tendo lentidão a ser passada para o Coletor?]]
*[[Como proceder quando o Cigam não está fazendo movimentação de saldo quando uma requisição é separada no WMS?]]
*[[Como proceder quando o material novo não aparece para o WMS?]]
*[[Nota/Pedido não está aparecendo, o que fazer?]]
*[[Ordem de Produção (OP) não está aparecendo, o que fazer?]]
*[[XML está com erro de retorno, o que avaliar?]]
*[[Como realizar contagem de Estoque pelo WMS?]]
*[[Como ativar o log no WMS?]]
*[[Como cancelar o Pedido pelo WMS?]]
*[[Pedido cancelado, não é possível realizar a separação?]]
*[[Divergência na Nota Fiscal de Entrada, o que fazer?]]

GE - Como Fazer - Integração CIGAM e WMS Fullsoft

2026-03-12T13:53:20Z

Alessandro.voto: /* Como Fazer - Integração CIGAM e WMS Fullsoft */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[categoria:Como Fazer Utilidades/Diversos_3]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Integração CIGAM e WMS Fullsoft]]

== Palavras-Chave ==
Integração CIGAM vs WMS FullSoft. Como Integrar CIGAM com WMS FullSoft. Warehouse Management System (WMS). Integração CIGAM e WMS.

= Como Fazer - Integração CIGAM e WMS Fullsoft =
Este tópico apresenta orientações para a integração entre o CIGAM e o WMS Fullsoft, abordando os principais pontos de configuração, comunicação e validação das informações trocadas entre os sistemas.

Durante o processo de implantação ou em situações de análise de inconsistências na integração, pode ser necessário habilitar a geração de LOG para auxiliar no diagnóstico e no acompanhamento do processamento. Após esse período, recomenda-se manter a geração de LOG desativada, evitando a criação desnecessária de registros e possível impacto no desempenho do ambiente.

Para mais informações sobre como habilitar o LOG, consulte: Como ativar o log no WMS?

= Quais são os tipos de materiais suportados entre CIGAM x WMS Fullsoft? =

Permite que sejam utilizados materiais simples e com controle de lote. É possível também ter o controle de Materiais com Configurador de Produto.


'''Não escopo:''' Grade, Especificações Independentes ou Estoque e Números de Série.

= Qual o Banco de dados homologado?=

Homologado somente em banco de dados Microsoft SQL Server.

=Módulos necessários=
* '''[[Suprimentos]]:''' [[ES_Gestão de Materiais|Gestão de Materiais]], [[CO_Compras|Compras]] e [[CO_Requisições de Materiais|Requisições de Materiais]]
* '''[[FA_Faturamento/Pedido|Faturamento/Pedido]]:''' [[FA_Pedidos|Pedidos]] e [[FA_Nota Fiscal|Nota Fiscal]]
* '''[[GE_Genéricos|Genéricos]]:''' [[Integrador]]
* '''[[PC_Programação e Controle de Produção|Programação e Controle de Produção]]:''' Somente quando houver Indústria

=Módulos/Funcionalidades não escopo=
* [[CL_Gestão de Lojas|Gestão de Lojas]]: [[CL_Orçamento|Orçamento]] e [[CL_Orçamento por Controle|Orçamento por Controle]]
* [[GM_Gestão de Serviços|Gestão de Serviços]]: [[GM_Movimentos_Ordem de Serviço|Ordens de Serviço]] com vínculos de Materiais
* [[CO_Devolução de Entradas|Devolução de Entradas]] e [[FA_Devolução de Saídas|Saídas]]
* Faturamento Parcial
* O método "'''MovimentoAvaria'''" não utiliza lotes.

=Quais documentos podem ser utilizados entre CIGAM x WMS Fullsoft?=
* Notas Fiscais de Entrada
* Separação de Pedidos
* Separação de Entregas
* Separação de Requisições de Materiais
* Balanço de Estoque


'''Importante:''' Qualquer funcionalidade não mencionada é considerada como não escopo e deve sempre ser avaliada com equipe técnica.

=Como é realizada a Integração?=

A integração entre CIGAM x WMS FULLSOFT é realizada através de Web Service.


Web Service é uma forma de comunicação entre sistemas, a qual permite integrar dados padronizados entre ambos. Como meio de comunicação são utilizadas mensagens no formato '''XML'''.


Desta forma, é realizado via um '''HTTP''' pela internet, ou seja, é um link compartilhado entre ambos para receber e enviar o '''XML'''.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoft.png|850px|center|Integração CIGAM vs WMS Fullsoft]]

=Serviços/Métodos para Integração WMS Fullsoft=

Será disponibilizado um link ao cliente, o qual estará desta forma:

<pre>
https://cliente.cigam.cloud/WebServicesProd/Integrador/nome_do_webservice
</pre>


Após a informação [...]Integrador/[...], ou seja, depois da “/” (barra) indica que deve ser informado o '''nome do webservice'''.


São '''6 WebServices''' que podem vinculados a este link:

<pre>
CadastroBalanco.integrador.asmx
CadastroEmpresas.integrador.asmx
CadastroItemRequisicaoMaterial.integrador.asmx
CadastroMaterais.integrador.asmx
CadastroMovimentos.integrador.asmx
CadastroPedidos.integrador.asmx
</pre>


Dentro de cada um deles, haverá os '''métodos''', ou seja, as '''funções''' que este '''webservices''' pode realizar nesta integração.


Para o correto funcionamento dos '''Serviços''' e junto a eles os '''Métodos''', são necessários cadastros de '''COLEÇÕES'''.

{| class="wikitable" style="margin:auto;width:90%"
|-
! Serviço (WebService) !! Método
|-
| CadastroBalanco.integrador.asmx || Cadastrar
|-
| CadastroEmpresas.integrador.asmx || ListarTransportadoras
|-
| rowspan="2" | CadastroItemRequisicaoMaterial.integrador.asmx
| ListarItensRequisicoesSeparacao
|-
| ApontamentoSeparacaoItemRequisicao
|-
| rowspan="6" | CadastroMateriais.integrador.asmx
| ListarItensConferencia
|-
| ListarItensFaturamento
|-
| ListarItensFaturamento
|-
| ListarCodigoBarrasItensSeparacao
|-
| ListarCodigoBarrasItensConferencia
|-
| ListarCodigoBarrasItensFaturamento
|-
| rowspan="10" | CadastroMovimentos.integrador.asmx
| ListarOPsConferencia
|-
| ListarNFsConferencia
|-
| ApontamentoConferencia
|-
| ApontamentoConferenciaLote
|-
| ApontamentoSeparacao
|-
| ApontamentoSeparacaoLote
|-
| ConfirmarRecebimentoOP
|-
| ListarAvulsosConferencia
|-
| ListarAvulsosConferencia
|-
| ListarRetornoBeneficiamentoConferencia
|-
| rowspan="10" | CadastroPedidos.integrador.asmx
| ListarPedidosSeparacao
|-
| ListarPedidosSeparacao
|-
| ApontamentoSeparacaoPedido
|-
| ApontamentoInicioSeparacaoItemPedido
|-
| ApontamentoSeparacaoItemPedido
|-
| ApontamentoCancelamentoPedido
|-
| ListarEntregasSeparacao
|-
| ApontamentoSeparacaoEntrega
|-
| DevolucaoSeparacaoEntrega
|-
| DevolucaoSeparacaoEntregaParcial
|}

=O que são as Coleções?=

As '''Coleções''' são parâmetros para que o método possa executar a comunicação corretamente e padronizada.

* Exemplo do Serviço: CadastroMateriais + Método: ListarItensConferencia + '''Coleção''': MACF


No exemplo citado, o '''MACF''' – Itens para Conferência, refere-se que ao executar o Serviço + Método trará todos os itens que são disponibilizados para que seja realizada a Conferência.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoft1.png|550px|center|Integração CIGAM vs WMS Fullsoft 1]]

== Cadastro de Coleções - CIGAM ==

As COLEÇÕES são a única maneira de padronizar as informações de envio (CIGAM) e retorno (WMS FULLSOFT).


Nas COLEÇÕES é onde se cadastra quais informações serão enviadas ao WMS FULLSFOT, são elas:

* Materiais
* Controles
* Centros de Armazenagem
* Clientes
* Tipos de Operação
* Unidade de Negócio


Para realizar os cadastros de COLEÇÕES, deve-se acessar o CIGAM no módulo [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Coleções|Coleções]].


Nesta tela, todos os cadastros devem ser realizados conforme as regras e padrões definidos para a respectiva regra de negócio e de acordo com os webservices estabelecidos.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadColecoes.png|850px|center|Integração CIGAM vs WMS Fullsoft - Coleções]]

== Cadastro de Coleções - Regras Padronizadas ==

Para que se tenha um cadastro correto de [[GE_Coleções|Coleções]] é necessário entender os principais cadastros a serem utilizados:

* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Unidade_de_Negócio|Unidade de Negócio]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Controles|Controles]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Centro_de_Armazenagem|Centro de Armazenagem]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Materiais|Materiais]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Tipos_de_Operações|Tipos de Operações]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Clientes,_Empresas_e_Transportadoras|Clientes]]

===Unidade de Negócio===

Deve ser avaliado quais Unidades de Negócio serão integradas com o WMS.


As Unidades desta escolha deverão ser cadastradas na Coleção: '''UNIW'''

===Controles===

Para os Controles a serem integrados com o WMS devem ter duas distinções: 


1. Para '''PEDIDOS''' devem ser separados em '''6 Coleções''': 

* '''CPPE''' - Controle de Pedidos Pendentes
* '''CPPS''' - Controle de Pedidos Liberados para Separação de Pedidos
* '''CPPI''' - Controle de Pedidos para Separações Iniciadas
* '''CPFA''' - Controle de Pedidos para Separações Finalizadas
* '''CPPC''' - Controle de Pedidos que podem ser Cancelados pelo WMS
* '''CPSZ''' - Controle de Pedidos que não podem ser Separados

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadControlesPedido.png|750px|center|Integração CIGAM vs WMS Fullsoft - Controles Pedido]]


2. Para '''REQUISIÇÕES DE MATERIAIS''' devem ser separados em '''3 Coleções''':

* '''CPRS''' - Controle para Requisição de Materiais Liberada ao WMS
* '''CPRP''' - Controle para Requisição de Materiais Separadas WMS
* '''CPRP''' - Controle para Req. de Mat. que não podem ser Separadas

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadControlesRequisicoes.png|650px|center|Integração CIGAM vs WMS Fullsoft - Controles Requisições]]


'''Observações Importantes referente aos Controles:'''

:Há a Coleção '''CPSP''' - Situação para itens pedidos para separação parcial.

:Funcionalidade a qual não é prevista na Integração.

:É importante que clientes que utilizam faturamento parcial, ao implementarem o WMS Fullsoft, realizem uma customização dessa funcionalidade tanto no CIGAM quanto no WMS Fullsoft.

:No CIGAM, é possível realizar o faturamento parcial, ou seja, um pedido pode ser faturado inúmeras vezes, enquanto houver saldo disponível. Quando há integração com o WMS Fullsoft, após o envio dos dados (número do pedido), ele será recebido e devolvido apenas uma única vez. Isso significa que, no WMS Fullsoft, não é possível separar o mesmo pedido múltiplas vezes.

:Após o início do processamento, o WMS Fullsoft só retornará as informações ao CIGAM quando o pedido estiver finalizado. Dessa forma, não é possível devolver um saldo menor do que o enviado pelo CIGAM. A quantidade devolvida deve ser exatamente a mesma enviada, garantindo a integridade do pedido para o cliente final.

===Centro de Armazenagem===

Para os Centros de Armazenagem devem ser separados em '''4 Coleções''':

* '''CACF''' - Centro de Armazenagem Recebimento
* '''CASP''' - Centro de Armazenagem Estoque Principal
* '''CAFA''' - Centro de Armazenagem para Faturamento
* '''CAAV''' - Centro de Armazenagem para itens Avariados

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadCentrosdeArmazenagem.png|750px|center|Integração CIGAM vs WMS Fullsoft - Centros de Armazenagem]]

===Materiais===

Para os '''Materiais''' devem ser separados em '''3 Coleções''':

* '''MACF''' - Materiais WMS (para conferência)
* '''MASP''' - Materiais WMS (para separação)
* '''MAFA''' - Materiais WMS (para faturamento)


'''Observação:''' Quando há '''Configurador de Produto''' e houver um código de barras para cada '''Identificador''' deverá ser realizado o cadastro de outras '''3 Coleções''':

* '''TGBC''' - Códigos de barras de itens para conferência
* '''TGBS''' - Códigos de barras de itens para separação
* '''TGBF''' - Códigos de barras de itens para faturamento


'''Importante:'''

:Mesmo quando o não houver a utilização do Configurador de Produto estas Coleções devem ser cadastradas a nível de Coleção sem informações adicionais, irão servir apenas a nível integridade em passar por estes dados e encontrar informações vazias.

===Tipos de Operações===

Para os '''Tipos de Operações''' devem ser separados em '''4 Coleções''':

* '''TOTC''' - Tipo de Operação para Movimentos de Recebimento
* '''TOTF''' - Tipo de Operação para Movimentos de Separação de Ped.
* '''TOAV''' - Tipo de Operação de Movimentos de Transf. Avariados
* '''TOTP''' - Tipo de Operação de Movimentos de Transf. Requisições


Todos os Tipos de Operação devem ter como característica serem com espécie de estoque de transferência e com correlato de entrada, para que possam ser removidos do WMS FULLSOFT e gerar a movimentação no CIGAM, mantendo assim, o histórico e integridade dos movimentos de estoque.

===Clientes, Empresas e Transportadoras===

Para os '''Clientes, Empresas, Transportadoras''' e todos cadastros em relação a [[GE_Empresas/Pessoas|Empresas/Pessoas]] no CIGAM, devem ser separados por '''3 Coleções''':

* '''EMCL''' - Clientes e Outros
* '''EMTR''' - Transportadoras
* '''EMFO''' - Fornecedores

===Ocorrências de Produção===

Para que seja possível Endereçar as Ordens de Produção, devem ser vinculadas a '''Coleção – OPSP''' as ocorrências que devem ser enviadas ao WMS Fullsoft.

* '''EMCL''' - Clientes e Outros
* '''EMTR''' - Transportadoras
* '''EMFO''' - Fornecedores

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftFluxoGeral.png|750px|center|Integração CIGAM vs WMS Fullsoft - Fluxo Geral]]

=Balanço e Inventários=
==Parâmetros do Serviço responsável pelo Inventário==

O retorno dos dados oriundos da FULLSOFT no Serviço devem respeitar os seguintes campos grifados em vermelho.


As tags, "statusRegistro" e "sequencia" conforme anexo devem ser '''FIXOS''' "'''L'''" e "'''1'''".

* [[WMS_CadastroBalanco.integrador]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftInventarioParametros.png|750px|center|Integração CIGAM vs WMS Fullsoft - Inventario - Parâmetros]]

==Parâmetros WMS==

Para que o CIGAM receba informações de Estoque conforme Unidade de Negócio, deve ser parametrizado no WMS Fullsoft no programa '''WF9011'''.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftInventarioParametrosWMS.png|850px|center|Integração CIGAM vs WMS Fullsoft - Inventario - Parâmetros WMS]]


'''Importante:'''

:As informações de Inventário/Balanço virão do SINC (sincronizador do WMS Fullsoft). O CIGAM só irá receber as informações depois que for finalizado no SINC, ou seja, somente depois que a houver o "commit" pelo SINC.

:Isso garante que o CIGAM não irá receber as informações gradativamente pela integração.

==Painel Integrador CIGAM==

Ao realizar Pesquisas no CIGAM, será possível visualizar as informações recebidas, neste caso o BALANÇO/INVENTÁRIO oriundo do WMS, o qual gerou dados na Tabela '''GEINTEGR'''.

* [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Pesquisas|Pesquisas]] > [[GE_Pesquisas_Rotinas|Rotinas]] > [[GE_Painel Integrador|Painel Integrador]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftInventarioPainelIntegrador.png|850px|center|Integração CIGAM vs WMS Fullsoft - Inventario - Painel Integrador]]

==Integrador CIGAM==

Após finalizada a contagem no WMS, deve ser ligado o [[GE_Integrador|Integrador CIGAM]] com a opção "'''Balanços'''". Assim os balanços liberados pelo WMS poderão ser integrados ao CIGAM.

* [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Rotinas|Rotinas]] > [[GE_Rotinas_EDI|EDI]] > [[GE_Rotinas_EDI_Recebe|Recebe]] > [[GE_Integrador|Integrador]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftIntegradorCIGAM.png|750px|center|Integração CIGAM vs WMS Fullsoft - Integrador CIGAM]]

==Balanço do Estoque - Rotina CIGAM==

Após a geração do Integrador CIGAM, as informações serão populadas na tela de Balanço com informações oriundas do WMS.

* [[Suprimentos]] > [[ES_Gestão de Materiais|Gestão de Materiais]] > [[ES_Rotinas|Rotinas]] > [[ES_Rotinas_Operacionais|Operacionais]] > [[Es_Balanço|Balanço]] > [[ES_Balanço apurado|Balanço apurado]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftBalancoEstoqueCIGAM.png|750px|center|Integração CIGAM vs WMS Fullsoft - Balanço de Estoque - CIGAM]]

==Divergência de Balanço CIGAM==

Sendo assim, após receber as informações via tela de [[ES_Balanço apurado|Balanço Apurado]], para espelhar os Estoques poderá ser utilizada a rotina [[ES_Divergências de Balanço|Divergências de Balanço]].

* [[Suprimentos]] > [[ES_Gestão de Materiais|Gestão de Materiais]] > [[ES_Rotinas|Rotinas]] > [[ES_Rotinas_Operacionais|Operacionais]] > [[Es_Balanço|Balanço]] > [[ES_Divergências de Balanço|Divergências de Balanço]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftDivergenciaBalancoCIGAM.png|750px|center|Integração CIGAM vs WMS Fullsoft - Divergência de Balanço - CIGAM]]


É importante utilizar tipos de operações exclusivos para entradas e saídas a fins de ter histórico das informações de movimentações de estoque e entender a razão das divergências de estoque.

=Requisição de Materiais=
==Como Fazer Requisição de Materiais==

Avaliação do Estoque antes de separar a Requisição pelo WMS:

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoPesquisaEstoque.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição - Pesquisa de Materiais]]


'''Requisição de Materiais:''' Na Requisição ao WMS está sendo solicitado para que sejam transferidas 50 Unidades para o CA 999. A requisição já está no Controle "'''Liberado WM'''".

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoMaterial.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição de Materiais]]

 
[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftFluxoRequisicaoMaterial.png|850px|center|Integração CIGAM vs WMS Fullsoft - Requisição de Materiais]]

==Serviços==
===ListarItensRequisicoesSeparacao===

Para conseguir identificar o XML enviado ao WMS, deve ser executado via CGWebserviceInvoker este serviço: ListarItensRequisicoesSeparacao

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftServicosListarItens.png|550px|center|Integração CIGAM vs WMS Fullsoft - Serviços - ListarItensRequisicoesSeparacao]]

===ApontamentoSeparacaoItemRequisicao===

Para realizar a separação da Requisição deve-se utilizar do método "ApontamentoSeparacaoItemRequisicao" onde conforme os parâmetros irá receber os dados de retorno, com base nos dados de envio. Desta forma, gerando assim as movimentações.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftServicosApontamentoSeparacaoItemRequisicao.png|550px|center|Integração CIGAM vs WMS Fullsoft - Serviços - ApontamentoSeparacaoItemRequisicao]]


Gerando assim as movimentações corretamente conforme a Requisição de Materiais.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftServicosApontamentoSeparacaoItemRequisicao2.png|750px|center|Integração CIGAM vs WMS Fullsoft - Serviços - ApontamentoSeparacaoItemRequisicao]]


Desta forma, a Requisição troca o Controle para Separada e o item ficará como Atendido:

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoAtendida.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição Atendida]]


Mantendo os Estoque conforme necessidade.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoAtendidaEstoque.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição Atendida - Estoque]]

=Integração e Comunicação Webservice=
<center><youtube>V_00MkY78yI</youtube></center>

=Como avaliar se os materiais estão sendo integrados?=
<center><youtube>8vfIdsT6oAo</youtube></center>

=Envio e Retorno da Nota Fiscal de Entrada=
<center><youtube>uDUFe7--s2I</youtube></center>

=Início, separação e cancelamento de pedidos=
<center><youtube>cchyZy2oFGU</youtube></center>



=FAQs Relacionadas=
* [[IN Integrador CIGAM Fullsoft]]
*[[Como devo acionar quando existir ocorrências de informações incoerentes na integração com WMS?]]
*[[Como identificar o porquê não houve troca de controle no CIGAM após cancelamento no WMS?]]
*[[Como proceder ao identificar um erro de saída sem saldo?]]
*[[Como proceder a leitura de uma Ordem de Produção que está tendo lentidão a ser passada para o Coletor?]]
*[[Como proceder quando o Cigam não está fazendo movimentação de saldo quando uma requisição é separada no WMS?]]
*[[Como proceder quando o material novo não aparece para o WMS?]]
*[[Nota/Pedido não está aparecendo, o que fazer?]]
*[[Ordem de Produção (OP) não está aparecendo, o que fazer?]]
*[[XML está com erro de retorno, o que avaliar?]]
*[[Como realizar contagem de Estoque pelo WMS?]]
*[[Como ativar o log no WMS?]]
*[[Como cancelar o Pedido pelo WMS?]]
*[[Pedido cancelado, não é possível realizar a separação?]]
*[[Divergência na Nota Fiscal de Entrada, o que fazer?]]

GE Relatórios Específicos

2026-01-27T11:31:08Z

Alessandro.voto:

{{VoltarPagina}}

[[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Relatórios|Relatórios]] > [[GE_Relatórios_Cadastros|Cadastros]] >
[[GE_Relatórios_Específicos|Específicos]]
 

*[[GE_Agências/Empresa|Agências/Empresa]]

GE Relatórios Específicos

2026-01-27T11:29:00Z

Alessandro.voto: Criou página com 'Agências/Empresa'

[[GE_Agências/Empresa|Agências/Empresa]]

GE Relatórios Empresas/Pessoas

2026-01-27T11:27:54Z

Alessandro.voto:

[[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] >
[[GE_Relatórios|Relatórios]] >
[[GE_Relatórios_Cadastros|Cadastros]] >
[[GE_Relatórios_Empresas/Pessoas|Empresas/Pessoas]]
 
 
[[GE_* Empresas Gerais|* Empresas Gerais]]
 
[[GE_Listagem de Empresa|Listagem de Empresa]]
 
[[GE_Empresas com Observação|Empresas com Observação]]
 
[[GE_Atividade da Empresa|Atividade da Empresa]]
 
[[GE_Etiquetas|Etiquetas]]
 
[[GE_Relatórios_Tipos de Empresa|Tipos de Empresa]]
 
[[GE_Etiqueta de Clientes C. Barra|Etiqueta de Clientes C. Barra]]
 
[[GE_Validador de Empresa|Validador de Empresa]]
 
[[GE_Empresas/Contatos|Empresas/Contatos]]
 
[[GE_Empresas com CNPJ repetido|Empresas com CNPJ repetido]]
 
[[GE_Empresas Sem Movimentos|Empresas Sem Movimentos]]
 
[[GE_Clientes por UF e Cidade|Clientes por UF e Cidade]]
 
[[GE_Etiquetas empresas|Etiquetas empresas]]

GE Relatórios Cadastros

2026-01-27T11:21:47Z

Alessandro.voto:

GE Relatórios Cadastros

2026-01-27T11:18:59Z

Alessandro.voto:

GE Agências/Empresa

2026-01-27T11:13:21Z

Alessandro.voto:

{{VoltarPagina}}

[[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] >
[[GE_Relatórios|Relatórios]] >
[[GE_Relatórios_Cadastros|Cadastros]] >
[[GM_Relatórios_Específicos|Específicos]] >
[[GE_Agências/Empresa|Agências/Empresa]]

Esta opção apresenta um relatório caractere contendo a relação de todas as agências de empresas cadastradas no sistema. 
 
[[Image:AgenciasEmpresa.png|semmoldura|center|450px|AgenciasEmpresa]]

GE - Como Fazer - CIGAM Report

2025-10-23T19:45:18Z

Alessandro.voto: /* O que parametrizar no ambiente Windows, quanto ao CIGAM Report? */

{{VoltarPagina}}
 
[[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 - CIGAM Report|CIGAM Report]]

=CIGAM Report=
&emsp; Uma ferramenta originária do Fast Report, que adquirido o código fonte, foi adaptado as necessidade do ERP CIGAM em criação de relatórios customizados. Extraindo do CIGAM as informações necessárias através da utilização de comandos SQL’S. A ferramenta pode ser utilizada por clientes que usam o banco de dados Oracle ou MS-SQL, e a versão do CIGAM e10. 

&emsp; O documento irá descrever/apresentar como parametrizar as plataformas Windows 32 e 64 bits, para o correto funcionamento do CIGAM Report. Descreve como integrar os relatórios criados ao sistema CIGAM. E de forma básica descreve a criação dos relatórios, mas verifique o [[Arquivo:Como Fazer - CIGAM Report Avançado.pdf]] para informações mais detalhadas.

=O que parametrizar no ambiente Windows, quanto ao CIGAM Report?=

&emsp; Antes de considerar a necessidade de parametrizar o ambiente Windows, certifique-se de estar executando o CIGAM Report a partir do menu Utilidades - Report, ou através do arquivo executável CGReport.exe localizado na pasta de instalação do ERP CIGAM. 

&emsp; Em caso de erros, verificar a correta instalação do .Net framework e suas permissões. Para maiores detalhes, consulte o documento [[GE_-_Como_Fazer_-_Instalação_do_.Net|‘COMO FAZER - Instalação do .Net nos clientes’.]]

=Quais os fundamentos do CIGAM Report?=

&emsp; O CIGAM REPORT, e um gerador de relatórios direto a banco sem a necessidade de programação e ou desenvolvimento de novos programas no CIGAM via Magic. Suas principais funcionalidades são: 

* Possibilitar a criação de relatórios sem que seja necessário passar pelo desenvolvimento do CIGAM; 
* Todo o desenvolvimento bem como a implantação será feita no cliente de maneira rápida e simples, e; 
* Pode se definir o modelo do relatório diretamente sem que seja necessário disponibilizar variáveis para uma futura implementação ou adição de informações. 

&emsp; Informações detalhadas sobre as funcionalidades do Cigam Report, relevantes para a criação de relatórios verificar o [[Arquivo:Como Fazer - CIGAM Report Avançado.pdf]]

=Como criar o relatório de consulta direta a banco via CIGAM Report?=

&emsp; Ao abrir o CIGAM Report pela primeira vez, caso o idioma esteja em inglês ou outro qualquer que não o português, você pode alterá-lo fazendo o seguinte procedimento: 
&emsp; Clicar em File – Select Language conforme a imagem abaixo: 

[[Arquivo:Imagem100.png|750x500px|centro]]

&emsp; Na janela que irá abrir, clique em portuguese-brasil e em seguida em OK. 

[[Arquivo:Imagem101.png|750x500px|centro]]

&emsp; Ao abrir o Cigam Report devemos selecionar a opção: Arquivo – Novo, irá aparecer a seguinte tela abaixo. 

[[Arquivo:Imagem102.png|750x500px|centro]]

&emsp; A opção relatório em branco deve ser selecionada e clique em adicionar. Com isso será aberto um formulário de relatório padrão conforme imagem abaixo. 

[[Arquivo:Imagem103.png|750x500px|centro]]

&emsp; Agora é necessário informar qual será a fonte de dados do relatório. Isto pode ser feito de duas maneiras: 

* Escolher uma das fontes de dados que foram registradas no relatório através de um método de programação. Isto pode ser feito no menu Dados > Escolher Dados do Relatório, e marcando as fontes de dados necessárias. 
*Uma nova fonte de dados pode ser criada no menu Dados > Adicionar Fonte de Dados. 

&emsp; Após a inclusão da fonte de dados, esta irá aparecer na janela Dados. Agora a mesma pode ser utilizada no relatório. Não é obrigatório que o relatório se conecte somente a uma fonte de dados, permitindo que mais destas sejam adicionadas em um mesmo relatório. 
&emsp; No exemplo para demonstração será a opção Dados – Adicionar Fonte de Dados, conforme apresenta a imagem a seguir. 

[[Arquivo:Imagem104.png|750x500px|centro]]

&emsp; A primeira vez que for conectar com o Banco de Dados será necessário criar uma Nova Ligação. 

[[Arquivo:Imagem105.png|750x500px|centro]]

&emsp; O tipo de ligação deve ficar como Ligação OLE DB. Depois de alterar clicar em Gerar. 

[[Arquivo:Img106.png|750x500px|centro]]

&emsp; Ao clicar em gerar, aparecerá a tela abaixo, onde temos algumas informações importantes a serem observadas. 

[[Arquivo:Img107.png|750x500px|centro]]

&emsp; Nessa tela teve se escolha o provedor de acordo com o banco de dados. Para o banco de dados Oracle pode se utilizar o MICROSOFT OLE DB PROVIDER FOR ORACLE ou o recomendado ORACLE PROVIDER FOR OLE DB. 
&emsp; Para o banco de dados SQL Server se utiliza o MICROSOFT OLE PROVIDER FOR SQL SERVER. Após escolher o provedor de dados correto clique em gerar. 

[[Arquivo:Img108.png|750x500px|centro]]

&emsp; Os campos com o nome do servidor, nome de usuário e senha devem ser informados e a opção de permitir salvamento de senha marcada, para não precisar informar a mesma senha todas as vezes que for executar o relatório. Após informar os campos clique em Testar a Conexão. 

[[Arquivo:Img109.png|750x500px|centro]]

&emsp; Se o teste de conexão for concluído com êxito, clique em OK para continuar a configuração. Caso não tenha tido sucesso no teste de conexão, confira os dados de servidor, usuário e senha e tente novamente. 
&emsp; Problemas de não encontrar o provider do Oracle padrão, revise o capítulo 1 do presente manual para que possas seguir com o padrão solicitado. 
&emsp;Na tela de assistente de dados conforme imagem abaixo clique no botão seguinte. 

[[Arquivo:Img110.png|750x500px|centro]]

=Como acessar uma Tabela no CIGAM Report?=

&emsp; Na próxima tela, há duas opções, onde se pode escolher uma tabela do banco de dados para buscar depois os campos desejados, ou podemos escolher inserir uma consulta em SQL diretamente através do botão Adicionar consulta SQL. 

[[Arquivo:Img111.png|750x500px|centro]]

&emsp; Nesse exemplo, será escolhida a opção de selecionar uma tabela inteira, no caso, a tabela de cadastro de empresas. Após selecionada a tabela, é só clicar no botão terminar. Ao fazer isso, o programa voltará para a tela inicial, mas no canto superior direito aparecerá a nova fonte de dados. Nesse caso aparece a tabela de cadastro de empresas, GEEMPRES, e abaixo dela todos os seus campos, conforme figura abaixo. 

[[Arquivo:Img112.jpg|750x500px|centro]]

&emsp; Clicando nos campos da tabela GEEMPRES que aparecem a direita e arrastando podemos colocá-los no layout do relatório. Os campos devem ser colocados na parte de dados do relatório, conforme exemplo abaixo. 

[[Arquivo:113.png|750x500px|centro]]

&emsp; Ao soltar os campos nos dados, o Cigam Report insere automaticamente o nome do campo no cabeçalho de página. Esse nome é o próprio nome do campo na tabela. Ele pode ser alterado de acordo com a necessidade do relatório. Existem duas formas de se fazer isso: 
&emsp; Dando um duplo clique em cima do mesmo. Assim abrirá uma janela de editar texto onde basta alterar o texto. 
&emsp; Pode-se também alterar o TEXT de dados que aparece ao lado direito da tela, conforme a figura abaixo. 

[[Arquivo:115.jpg|750x500px|centro]]

&emsp; Após de alterado pode se ver um preview de como ficará o relatório. Para isso basta clicar no botão de visualizar que aparece no canto superior esquerdo da tela conforme a figura abaixo. 

[[Arquivo:116.jpg|750x500px|centro]]

&emsp; Ao clicar na opção, a consulta será gerada na base de dados e retornará a tela conforme a figura a seguir, mostrando como os dados estão formatados para apresentação. 

[[Arquivo:117.png|750x500px|centro|177]]

&emsp; Para fechar a visualização do preview basta clicar em fechar. Com isso volta a tela inicial de configuração do layout do relatório. 

=Como acessar Múltiplas Tabelas do CIGAM Report?=

&emsp; Para fazer uma consulta no Cigam Report utilizando um relacionamento entre 2 ou mais tabelas deve ser feito seguindo os seguintes passos: 
&emsp; Selecionar um novo relatório em branco, e clicar em adicionar fonte de dados. 

[[Arquivo:118.png|750x500px|centro]]

&emsp; Na tela que aparece é onde deve ser configurada a conexão com o banco de dados, conforme demonstrado na seção anterior do presente documento, tendo o banco já configurado, basta clicar no botão seguinte, como apresenta a imagem abaixo. 

[[Arquivo:119.png|750x500px|centro]]

&emsp; Nesse exemplo, será selecionado duas tabelas relacionadas. A ESMATERI que tem o Cadastro de Materiais e a PEENGENH que é a da Engenharia. Na tela que abre, selecione as duas tabelas e clique em terminar. 

[[Arquivo:120.png|750x500px|centro]]

&emsp; '''Nas fontes de dados a direita da tela será apresentada as duas tabelas selecionadas.'''

[[Arquivo:121.png|750x500px|centro]]

&emsp; Agora é necessário criar o relacionamento entre as duas tabelas. Para isso deve-se clicar em: Ações / Nova Relação 

[[Arquivo:122.png|750x500px|centro]]

&emsp; Na tela que se abre deverá ser informado a tabela mãe e a tabela filha, e por qual campo elas se relacionam, conforme a imagem abaixo exemplifica. 

[[Arquivo:123.png|750x500px|centro]]

&emsp; Após de realizar o relacionamento clicar em OK. Agora a direita na fonte de dados já aparecem as duas tabelas e com o relacionamento entre elas. No exemplo abaixo está se buscando o código do material da tabela da Engenharia e a descrição do cadastro de materiais. 

[[Arquivo:124.png|750x500px|centro]]

&emsp; Ao gerar o relatório é possível ver a informação de código de material e descrição. 

[[Arquivo:125.png|750x500px|centro]]

=Como acessar múltiplas tabelas via comandos SQL?=
&emsp; Além de fazer a consulta relacionando tabelas da forma como descrito na seção anterior, também é possível acessar múltiplas tabelas através de uma instrução SQL (script).Com a instrução SQL é possível adicionar somente os campos que temos interesse e já fazer a relação entre tabelas diretamente nele. 
&emsp; Para criar uma fonte de dados baseado em uma instrução SQL é preciso clicar em Dados / Adicionar Fonte de Dados, como a configuração com o banco de dados já deve estar pronta, basta clicar no botão seguinte na tela que a figura abaixo ilustra. 

[[Arquivo:126.png|750x500px|centro]]

&emsp; O Cigam Report vai carregar as tabelas, mas em vez de selecioná-las na lista, cliquei no botão Adicionar Consulta Sql. 

[[Arquivo:127.png|750x500px|centro]]

&emsp; Será aberta a janela onde podemos dar um nome para essa instrução, ou simplesmente deixar o nome sugerido e clique em Seguinte. 

[[Arquivo:128.png|750x500px|centro]]

&emsp; Na tela seguinte conforme imagem abaixo se coloca a instrução SQL desenvolvida e basta clicar no botão seguinte. 

[[Arquivo:129.png|750x500px|centro]]

&emsp; Por hora, vamos passar direto pela próxima tela, que é a de parâmetros e apenas clique no botão seguinte. 

[[Arquivo:130.png|750x500px|centro]]

&emsp; Na tela seguinte clique no botão terminar, depois se retornará a essa tela para inclusão dos parâmetros. 

[[Arquivo:131.png|750x500px|centro]]

&emsp; No final da tela de tabelas irá aparecer o nome da consulta criada via SQL conforme imagem abaixo e bastar clicar no botão terminar. 

[[Arquivo:132.png|750x500px|centro]]

&emsp; A partir de então, a instrução SQL que foi utilizada já aparece como uma conexão a base de dados. Os campos poderão ser inseridos no relatório como os da tabela. 

[[Arquivo:133.png|750x500px|centro]]

&emsp; '''Os campos podem ser inseridos na tela do relatório conforme imagem abaixo. '''

[[Arquivo:134.png|750x500px|centro]]

&emsp; Outras informações comuns em relatórios como pagina, data, podem ser inseridas. Essas são demonstradas na figura abaixo. 

[[Arquivo:136.jpg|750x500px|centro]]

&emsp; Na banda de título de relatório (1) se pode inserir algumas variáveis de sistema (2) que estão disponíveis ao lado direito da tela, logo abaixo da fonte de dados. Nesse exemplo será inserida a data e o número de página. O processo para inserir as variáveis é o mesmo que com os campos da tabela. Basta clicar em cima da variável e arrastá-la para o local desejado e soltá-la. 

[[Arquivo:137.jpg|750x500px|centro]]

&emsp; Ao clicar no opção de preview do layout, já será visto o relatório com as variáveis adicionadas nele. 

[[Arquivo:138.png|750x500px|centro]]

&emsp; Também é possível inserir uma figura com o logo da empresa para ser o cabeçalho do relatório como mostrado a figura abaixo. 

[[Arquivo:139.jpg|750x500px|centro]]

&emsp; Para incluir deve se clicar no botão figura e arraste a imagem para o local digitado. Após isso, clique com o botão direito sobre a imagem e escolha a opção editar. 

[[Arquivo:140.png|750x500px|centro]]

&emsp; Ao selecionar a opção irá abrir a tela abaixo. Se escolher a opção Imagem / Abrir. 

[[Arquivo:141.png|750x500px|centro]]

&emsp; Após seleciona uma imagem de uma pasta qualquer dentro do computador. 

[[Arquivo:142.png|750x500px|centro]]

&emsp; Após selecionar a imagem, basta clicar em abrir que será apresentada para o layout do relatório. Quando a imagem já estiver no layout, basta ajustá-la com o tamanho desejado. 

[[Arquivo:143.png|750x500px|centro]]

&emsp; Com isso, ao gerar novamente o preview do relatório, a imagem será apresentada em tela. 

[[Arquivo:144.png|750x500px|centro]]

&emsp; Essas são as formas de criar o relatório pelo CIGAM Report, para realizar a integração do mesmo ao Cigam, será preciso criar os parâmetros/filtros e ajustá-los a consulta, no qual o capítulo seguinte irá apresentar. 

=Integração do relatório CIGAM Report ao Cigam=

&emsp; Com o modelo criado pelo CIGAM Report, para ser utilizado como opção de Menu no Cigam deverá seguir algumas configurações que seguem abaixo. 

=Como utilizar e criar parâmetros, através do CIGAM Report?=

&emsp; Para demonstrar a inserção dos parâmetros será utilizado o exemplo do relatório que lista o nome das empresas. No Cigam Report ele está montado da seguinte maneira. 

[[Arquivo:145.jpg|750x500px|centro]]

&emsp; O relatório gerado se apresenta conforme a imagem abaixo 

[[Arquivo:146.jpg|750x500px|centro]]

&emsp; Para a integração será criada uma tela de filtros para esse relatório dentro do Cigam, o filtro será pelo código da empresa. Para isso será necessário criar um parâmetro que receberá o valor digitado na tela e repassará o valor do mesmo para o Cigam Report. Para fazer isso, deve-se clicar em Parâmetros de Filtros no menu Cigam 

[[Arquivo:147.jpg|750x500px|centro]]

&emsp; Ao acessar no menu do Cigam a opção Parâmetros de Filtros, com o ambiente corretamente configurado irá apresentar alguns parâmetros para serem utilizados, porem não impede que seja criado novos de acordo com a necessidade. Para cadastrar um novo filtro devemos pressionar CTRL + I. 

[[Arquivo:148.jpg|750x500px|centro]]

&emsp; No campo do código se insere o código requerido, ou se permanece com a sugestão do sistema. No campo Nome do Parâmetro se coloca um nome que se deseja para o mesmo. Em Tabela, pressione F5 para abrir a lista de tabelas. 

[[Arquivo:149.jpg|750x500px|centro]]

&emsp; No exemplo criado será utilizado tabela EMPRESA. No campo coluna será selecionado o campo da tabela EMPRESA, onde fica o código do cliente que servirá como filtro. 

[[Arquivo:150.jpg|750x500px|centro]]

&emsp; Em tamanho do controle se informa o tamanho do campo na tela para receber os dados que serão digitados nesse parâmetro. Como o campo de empresa tem 8 dígitos, vamos informar o mesmo valor. Em Nome do Parâmetro para Integração vamos informar o nome do parâmetro que será usado dentro de nossa consulta SQL. É bom sempre usar um nome intuitivo para facilitar o entendimento. Nesse caso se usará o parâmetro como P_Empresa. 

[[Arquivo:151.jpg|750x500px|centro]]

&emsp; Os detalhes do parâmetro que aparecem na parte de baixo da tela são preenchidos automaticamente pelo Cigam, e com todos os campos informados, basta salvar o novo parâmetro. 
&emsp; Como apresentado no inicio da apostila a opção de cadastro de tabelas oriundas de customizações, módulos terceiros ou parceiros desenvolvedores, após devidamente cadastrada a mesma já está visível para realizar o cadastro de parâmetros. Segue o mesmo processo como descrito anteriormente, como a ilustração a seguir apresenta: 

[[Arquivo:152.png|750x500px|centro]]

&emsp; '''IMPORTANTE:''' O parâmetro cadastrado aqui pode ser usado inúmeras vezes, para diversos relatórios posteriormente. Não é necessário mais cadastrar o mesmo parâmetro para outro relatório. Apenas fazer a sua associação ao novo relatório, como será apresentado a seguir. 

=Como apontar o modelo criado, trazendo todos os relatórios do CIGAM Report?=

&emsp; O próximo passo é fazer um cadastro desse relatório dentro do Cigam. Para isso é preciso entrar na tela de Cadastro de Relatórios conforme a imagem abaixo. 

[[Arquivo:153.jpg|750x500px|centro]]

&emsp; A tela de cadastro abrirá mostrando todos os relatórios do Cigam Report que já foram cadastrados, pressione CTRL + I para inserir um novo relatório. 
&emsp; O Código deve ser preenchido com o número desejado. No exemplo utilizado já existia o número 1, por isso o relatório terá o código 2. No nome do relatório devemos colocar o nome que irá aparecer quando o relatório for aberto. A dica é sempre usar um nome intuitivo, que seja de rápida assimilação do conteúdo do mesmo. 

[[Arquivo:153img.png|750x500px|centro]]

&emsp; Após preencher o nome do relatório, devemos definir os tamanhos da tela onde os filtros serão solicitados, e a área onde será exibida a descrição dos filtros. Isso é feito nos campos Tamanho do Controle e Tamanho do Label conforme imagem abaixo. 

[[Arquivo:154.png|750x500px|centro]]

&emsp; Arquivo Modelo: É onde está salvo o arquivo FRX que montamos no Cigam Report. 
&emsp; Será esse arquivo modelo que o Cigam irá procurar para gerar o relatório. Ele deve estar salvo em um local da rede que todos usuários que vão usar o relatório tenham acesso. 
&emsp; Arquivo Gerar: É o arquivo que será gerado pelo Cigam Report, com os dados da consulta. Costuma-se usar o mesmo que o do relatório, acrescentando apenas ao fim do mesmo a palavra “Gerado” conforme imagem abaixo. 

[[Arquivo:155.png|750x500px|centro]]

&emsp; '''IMPORTANTE:''' Para que o relatório a gerar possa ser aberto sem problemas, é preciso avaliar se os usuários possuem permissões de modificar o arquivo no caminho onde ele é gerado. Para alguns casos é preciso dar permissões de modificações na rede, caso contrário, o CIGAM Report poderá apresentar erro em tela 

=Como indicar filtros para o modelo indicado?=

&emsp; Após informar o nome do relatório será informado os filtros dele. Clique no botão Filtros conforme mostra a figura abaixo. 

[[Arquivo:156.png|750x500px|centro]]

&emsp; Ao entrar na tela de filtros, pressione CTRL + I para inserir um novo filtro. Com o cursor parado em cima do campo Parâmetro Filtro, pressione F5 para abrir as opções de filtros já cadastrados anteriormente, no cadastro de parâmetros. 

[[Arquivo:157.png|750x500px|centro]]

&emsp; Posicione o cursor sobre o parâmetro Empresa já cadastrado e pressione <ENTER>. 

[[Arquivo:158.png|750x500px|centro]]

&emsp; De volta a tela de cadastro de filtros tem as seguintes opções: 
&emsp; '''Ordem Exibição''' – Mostra a posição do parâmetro na tela. No caso de existirem 2 ou mais filtros, a partir da ordem de exibição se escolhe a ordem que eles aparecerão na tela. 
&emsp; '''Faixa''' - Indica que o filtro será com início e fim (intervalo). Nesse caso o nome do parâmetro de integração será duplo sendo composto da seguinte forma como exemplo: p_empresa_inicial e p_empresa_final. 
&emsp; '''Obrigatório''' – Serve para tornar obrigatório ou não o preenchimento desse campo na tela de parâmetros. Caso esteja marcado, não permitirá gerar o relatório sem informar algum valor no campo. 
&emsp; '''Intervalo''' - Indica se deve disponibilizar o intervalo final no filtro. Caso estiver selecionado “Faixa” e não estiver selecionado o Intervalo, será submetido o dado inicial e final porém somente o inicial é solicitado. Essa opção é útil quando se deseja filtrar um valor específico único (sem faixa) podendo-se também deixar em branco para abranger todos os registros (atual comportamento dos programas de filtros de relatórios). 
&emsp; '''Aleatório''' – utilizado para informar de forma aleatória os dados a serem filtrados. * Vale ressaltar que este tipo de parâmetro será utilizado na query do Report com o uso do comando “in”. Ex.: Select * from geempres e where e.cd_empresa in (@p_aleatorio). 
&emsp; Agora é importante notar que de acordo com o que se seleciona como Faixa e Intervalo, muda o nome do parâmetro de integração que fica visível no final da tela conforme imagem abaixo. 

[[Arquivo:159.png|750x500px|centro]]

&emsp; O parâmetro criado é o p_empresa. Como escolhido um intervalo, o Cigam já cria o parâmetro inicial e o final. O nome nesse caso ficará como p_empresa_inicial e p_empresa_final. É muito importante observar isso. Porque esses parâmetros serão informados dentro do Cigam Report, e informados na consulta SQL que foi montada. 
&emsp; '''IMPORTANTE:''' Ter atenção de como os filtros são criados é extremamente importante, pois o CIGAM Report é Case Sensitive. O parâmetro informado na consulta não estando da mesma maneira que o apresentado na tela de filtros, fará com que o relatório não seja aberto, irá apresentar uma tela que está acessando os dados, porém não abrirá nada em tela. 

=Como indicar os parâmetros do CIGAM Report na consulta SQL?=

&emsp; Para que os parâmetros sejam apontados na consulta, é preciso que o modelo seja aberto no Cigam Report, clique na fonte de dados com o botão direito e escolha a opção editar. 

[[Arquivo:160.jpg|750x500px|centro]]

&emsp; Na tela que abrir clique no botão seguinte. 

[[Arquivo:161.jpg|750x500px|centro]]

&emsp; Na tela seguinte irá aparecer com a consulta SQL, e nessa será incluída os parâmetros. 

[[Arquivo:162.jpg|750x500px|centro]]

&emsp; Agora será necessário alterar essa consulta SQL, inserindo nela os filtros que serão utilizados na tela do Cigam, para gerar o relatório. 

[[Arquivo:163.jpg|750x500px|centro]]

&emsp; Os filtros são cláusulas de restrição. Então é necessário inserir um WHERE na nossa consulta SQL. Como se escolheu informar um Intervalo de dados, no SQL se precisa colocar o comando BETWEEN e o parâmetro inicial e final, sendo :p_empresa_inicial e :p_empresa_final respectivamente. 

&emsp; Uma observação importante: 
* uso dos dois pontos (:) desse exemplo deve-se ao fato de estar usando um banco ORACLE. No caso de bancos MSSQL usa-se @. Dessa forma fica assim:
:: ORACLE :p_empresa_inicial 
:: MSSQL @p_empresa_final 

&emsp; Após a inclusão do comando SQL, clique no botão seguinte. A tela seguinte será preciso cadastrar dentro do Cigam Report os parâmetros. É necessário informar os dados de cada um dos parâmetros. No caso desse exemplo são dois, o inicial e final. 

[[Arquivo:164.jpg|750x500px|centro]]

&emsp; É necessário informar sempre: 
* '''Name:''' É o nome do parâmetro. 
* ''' DataType:''' é o tipo de data do parâmetro. Nesse exemplo é um VarChar. 
* ''' DefaultValue:''' Valor padrão, nesse caso foi informado zero. 
* ''' Size:''' é o tamanho do campo. 
&emsp; Em caso de dúvidas, essas informações aparecem na tela do Cigam quando foi cadastrado o parâmetro. 

[[Arquivo:165.png|750x500px|centro]]

&emsp; Após terminar de cadastrar os parâmetros clique no botão seguinte. Apresentará a tela conforme imagem abaixo, nessa basta clicar no botão terminar. 

[[Arquivo:166.jpg|750x500px|centro]]

&emsp; Retornando a tela do layout o modelo deverá ser salvo para que seja armazenado com os parâmetros incluídos. 
&emsp; Agora, de volta ao Cigam, pode se verificar como ficará a tela de filtros. Para isso, clique no botão Executar. 

[[Arquivo:167.png|750x500px|centro]]

&emsp; Ao clicar no botão executar abrirá uma janela, que será a tela de filtros do relatório. Observe que o nome cadastrado anteriormente aparece na parte superior da tela. O filtro criado, de empresa, aparece com um intervalo, onde deve ser informado valor inicial e final, conforme cadastrado na tela de filtros. 

[[Arquivo:168.png|750x500px|centro]]

&emsp; Com o cursor posicionado em cima do campo empresa tecle F5, para isso o ambiente deverá que estar parametrizado conforme o capitulo inicial do documento. Ao clicar o F5 abre uma tela de zoom, onde é possível fazer o filtro específico, encontrar o cliente/fornecedor desejado para efetuar a pesquisa. Como na definição dos parâmetros foi deixado o campo de empresa não sendo obrigatório, podemos escolher informar ou não o código da empresa para gerar o relatório. 
&emsp; Então agora se pode testar como fica a integração entre o Cigam e o Cigam Report. Cabe ressaltar, que o usuário final, ao rodar o relatório, somente irá enxergar essa tela de filtros e o relatório pronto. Toda a parte de desenvolvimento do relatório será “transparente” para ele. No exemplo abaixo será deixado primeiramente o filtro em branco. 

[[Arquivo:169.jpg|500x250px|centro]]

&emsp; O relatório é gerado com todos os dados disponíveis na base de dados. 

[[Arquivo:170.jpg|750x500px|centro]]

&emsp; Agora será gerado o relatório novamente utilizando o filtro. 

[[Arquivo:171.jpg|500x250px|centro]]

&emsp; Utilizando o filtro dessa forma, o relatório retorna apenas os itens dentro da faixa informada. 

[[Arquivo:172.png|750x500px|centro]]

&emsp; Com o modelo de relatório apontado, filtros criados e parâmetros indicados na consulta SQL, será preciso apontar o relatório ao Menu Cigam para utilização dos usuários finais. 

=Como realizar exportação direta para ferramentas como PDF, EXCEL, WORD pelo CIGAM Report?=

&emsp; A partir das ultimas verões o CIGAM Report.ecf, passa a permitir a exportação dos dados diretamente para as ferramentas de extensão PDF, RTF, HTML, MHT, XML, XLSX, PPTX, ODS, CSV, DBF e JPG. Essa opção não abrirá o preview do report mas sim a ferramenta cuja a extensão que foi informada junto ao campo Arquivo Exportar. 
&emsp; Para utilizar essa opção na tela de cadastro dos relatórios CIGAM Report no campo Exportação selecione a extensão requerida, como apresenta a imagem a abaixo. Ao selecionar a extensão o checkbox e o campo Arquivo Exportar serão habilitados. 

[[Arquivo:173.png|500x250px|centro]]

&emsp; No campo Arquivo Exportar é informado o caminho seguido do nome do arquivo e a extensão, exemplo: C:\Temp\Teste.pdf. Somente com o preenchimento desse campo será criada a exportação e caso marcando o checkbox a abertura do mesmo. 
&emsp; Para a abertura do arquivo na extensão requerida o checkbox Abrir ao Concluir deve ser marcado. Após a exportação a abertura será na respectiva extensão/ferramenta disponível no Windows. Não marcando o checkbox, será somente exportando e não será aberta nenhuma tela de visualização do relatório. 
&emsp; '''IMPORTANTE:''' no campo Arquivo Exportação é obrigatória a informação da extensão, mesmo que essa foi selecionada no campo Exportação. Pois o campo exportação é informativo e como chave de liberação dos campos. Informado o caminho\arquivo.extensão essa validação será feita pelo próprio Windows para a exportação e abertura do arquivo na ferramenta apropriada. 

=Como cadastrar Nomes Logicos e Conexões?=

&emsp; Para auxiliar no desenvolvimento dos relatórios customizados, além de melhorias na performance para apresentar as informações pretendidas, há a opção de cadastrar os Nomes Lógicos a serem utilizadas, no exemplo abaixo, as tabelas que o relatório irá utilizar assim como eventuais customizações que serão utilizadas, conforme apresenta a imagem a seguir. 

[[Arquivo:174.png|750x500px|centro]]

&emsp; Para uso basta clicar no botão Nomes-Lógicos, pressionar CRTL+I, e sobre o campo nome logico pressionar F5, onde irá apresentar todos os Nomes Lógicos inclusive de projetos customizados. Após cadastrado, no relatório basta informar o parâmetro submetido. 
&emsp; O uso do botão Conexões é utilizado para cadastrar as conexões com o banco de dados após o cadastro realizado dentro do relatório customizado em Report. Cada conexão possui um nome, como ilustra a imagem abaixo, e esse nome após é informado no cadastro das conexões e direcionado para outro banco de dados pretendido. 

[[Arquivo:175.png|750x500px|centro]]

&emsp; Para realizar a criação da conexão é preciso preencher o Nome da Conexão conforme é apresentado no relatório, como ilustra a imagem anterior. A Ordem que as conexões serão realizadas, o Tipo da conexão (Automatica ou Especifica) e qual Provider será utilizada essa opção irá variar entre banco de dados Oracle e Mssql. 
&emsp; Os dois tipos de conexão que apresenta significa que Automático irá buscar as conexões do banco já utilizado pelo Cigam e Especifica deverá ser manualmente informado a string de conexão pretendida. Como demonstra a figura seguinte. 

[[Arquivo:176.png|750x500px|centro]]

&emsp; Após criada a conexão há a opção de criar eventos, o opção existe para caso o relatórios customizado precise realizar alguma ação após de gerado. Exemplo, emissão de Nota Fiscal customizado, após de impresso precisa setar o campo como impresso. 
&emsp; Para realizar esse cadastro dentro da telaro de conexão há o botão Evento, clicando sobre o botão será apresenta a tela conforme ilustra a imagem a seguir. No campo Tipo selecionar a opção de executar a ação antes ou depois de gerar o relatório. No campo Ordem a sequencia de execução. No campo Instrução SQL informar o comando a ser executado e caso for uma procedure a ser executado marcar o checkbox Procedure. 

[[Arquivo:177.png|750x500px|centro]]

&emsp; O cadastro do evento não precisa ser acrescentado ao relatório CIGAM Report.

=Como cadastrar Zoom dos campos CIGAM Report?=
&emsp; Ao realizar a preparação do ambiente para atender o CIGAM Report, como descrito nos capítulos iniciais é executado o scripts que os programas de zoom. Essa opção permite na tela de filtros pressionar F5 e selecionar a opção desejada para executar o relatório. 
&emsp; Os scripts carregam os programas de pesquisa para os campos até o momento mapeados, não significa que para todos os campos se tenha o programa de pesquisa criado, visto que o mesmo precisa existir no Cigam para que possa ser linkado. 
&emsp; O mesmo link dos campos com programas pode ser feito manualmente, principalmente de campo ainda não mapeadas e disponibilizados para serem atualizados. Ou de tabelas customizadas, módulos terceiros ou parceiros desenvolvedores. Ou caso se tenha a necessidade de apontar para outro programa fora do padrão disponibilizado. 
&emsp; Para realizar o cadastro basta ter em mãos o números do Programa de pesquisa e informa-lo no campo Nome Publico Programa. Como ilustrado a seguir. 

[[Arquivo:178.png|750x500px|centro]]

&emsp; O campo Posição Retorno por padrão vem apontado como 1 ou seja, após selecionar o dado o retorno para a tela de filtro será o código. Sendo necessário a descrição do dado a opção deve ser alterada para 2. Mas isso deve está ajustado internamente no programa Cigam e não há opção de ajustes. Eventual necessidade de mudança deve ser avaliado via desenvolvimento a possibilidade de ajuste. 
&emsp; Para alguns programas há disponíveis retornos 3, 4 e demais, mas isso não é regra para todos. E somente avaliando para ver o que os demais retornos retornam pois como a definição ocorre no desenvolvimento do programa. Como regra utiliza-se as opção 1 – Codigo e 2 – Descrição. 

=Como cadastrar Zoom para tabelas customizadas CIGAM Report?=

&emsp; Para tabelas customizadas para o cadastro de zoom funcionar deve ser informado no campo Nome Publico do Programa o programa customizado e no campo Componente, o caminho onde se encontra o projeto da customização. A tabela irá apresentar a sua formatação em negrito, se destacando dos demais para diferenciar das tabelas do ERP Cigam, como demonstra a figura abaixo. 

[[Arquivo:179.png|750x500px|centro]]

&emsp; É importante relatar que além do projeto customizado, tabelas, existem os nomes lógicos, conectores necessários para o correto funcionando do projeto customizado e consequentemente o cadastro de zoom também. Na falta de algum dos arquivos citados, o padão é buscar do projeto Cigam (CGGeral). 
&emsp; Outra opção é realizar o cadastro de zoom para uma customização da tabela do ERP Cigam. Para isso basta selecionar a tabela e campos e preencher os campos para buscar o projeto da customização, módulos terceiros ou parceiros desenvolvedores. Da mesma forma que ocorre para a tabela terceira para a tabela do ERP Cigam também irá apresentar em negrito demostrando que essa possui outro projeto linkado, como demonstra a ilustração a seguir. 

[[Arquivo:180.png|750x500px|centro]]

&emsp; Dessa forma há como facilitar ao usuário a seleção dos dados para filtrar as informações se seu relatório customizado. 

=Como disponibilizar o Relatório CIGAM Report no Menu Cigam?=

&emsp; Para cadastrar um atalho do relatório no Menu do CIGAM, basta posicionar no local desejado e executar a “Tecla Fácil CIGAM” (com atalho pelo F10) e na tela clicar em “Nova Opção de Menu, como ilustra a figura abaixo. 

[[Arquivo:181.png|500x250px|centro]]

&emsp; Na tela seguinte selecionar “Relatório CIGAM Report” como tipo de opção de menu. 

[[Arquivo:182.png|500x250px|centro]]

&emsp; Após a seleção, automaticamente os campos com as informações da chamada da aplicação do CIGAM Report e os programas necessários são preenchidos e bloqueados para modificação. Deve-se apenas informar uma descrição para o relatório e a chave do programa que será o número do relatório cadastrado. 

[[Arquivo:183.png|500x250px|centro]]

&emsp; No campo Chave do Programa está disponível o zoom no campo para selecionar o relatório requerido, esse apresenta a tela de cadastro dos relatórios, conforme figura abaixo. 

[[Arquivo:184.png|750x500px|centro]]

&emsp; Após clicar em confirmar será aberta uma tela onde devem ser informados quais usuários devem ter acesso ao relatório. Pode-se escolher entre as opções de apenas o usuário que está cadastrando, escolher um usuário específico da lista que aparece, um grupo de usuários ou todos os usuários. Nesse exemplo foi escolhida a opção Todos os Usuários. 

[[Arquivo:185.jpg|750x500px|centro]]

&emsp; Após o cadastro a opção ficará disponível para execução o relatório por dentro do Menu do Cigam, como ilustra a imagem abaixo. 
[[Arquivo:186.png|500x250px|centro]]

&emsp; Por meio desse ajuste o relatório está integrado ao Menu Cigam dentro do módulo correspondente. 

=Como ativar modo DEBUG no CIGAM Report?=

&emsp; A funcionalidade foi criada para facilitar a visualização dos dados da integração entre o CIGAM e o CIGAM Report. Para ativá-la, basta setar o nome-lógico DEBUG_CIGAM REPORT com “S”. Cabe lembrar que esta opção somente deverá ser ativada quando da necessidade de depuração para procurar e ou verificar erros. 

[[Arquivo:200.png|750x500px|centro]]

&emsp; Ao executar o cadastro do relatório, a atividade da funcionalidade pode ser identificada no título da janela, conforme ilustra a imagem abaixo.

[[Arquivo:201.png|750x500px|centro]]

&emsp; Ao executar o relatório (pelo botão “Executar” ou pela integração com o menu do CIGAM) será exibida uma mensagem, figura abaixo, com a linha de comando que será executada. 

[[Arquivo:202.png|750x500px|centro]]

&emsp; O conteúdo dessa mensagem pode ser obtido em formato texto através de um CTRL+C sob a mensagem em exibição. O resultado será o seguinte: 
--------------------------- 
Atenção 
--------------------------- 
Linha de comando: 
H:\CIGAM10\PROJECTS\CIGAM\CIGAM Report.exe -G: -M:f:\Teste_data.frx -A:f:\Teste_data_xx.frx -P::p_data='08/11/2009' 
--------------------------- 
OK 

&emsp; Após a exibição da linha de comando é possível escolher se deseja submeter (executar a geração do relatório) no executável do CIGAM Report instalado (também aparece o caminho completo do arquivo o qual deverá existir). 

[[Arquivo:203.png|750x500px|centro]]

&emsp; Após realizar as verificações o nome lógico, deve ser alterado para ‘N’, pois senão as telas irão ser apresentadas aos usuários que utilizarão o relatório, cada vez que for utilizando, podendo trazer descontentamento ao cliente por ter tantas telas para confirmar. 
&emsp; Com meio dessas instruções que se realiza a integração do Cigam Report com o Cigam. Podendo criar relatórios conforme necessidade sem o envolvimento do setor de desenvolvimento, agilizando dessa forma a solicitação do cliente. 

'''Mais duvidas consultar'''
[[FAQ GE|FAQ GE|CGReport]]

GE - Como Fazer - CIGAM Report

2025-10-23T19:44:29Z

Alessandro.voto: /* O que parametrizar no ambiente Windows, quanto ao CIGAM Report? */

{{VoltarPagina}}
 
[[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 - CIGAM Report|CIGAM Report]]

=CIGAM Report=
&emsp; Uma ferramenta originária do Fast Report, que adquirido o código fonte, foi adaptado as necessidade do ERP CIGAM em criação de relatórios customizados. Extraindo do CIGAM as informações necessárias através da utilização de comandos SQL’S. A ferramenta pode ser utilizada por clientes que usam o banco de dados Oracle ou MS-SQL, e a versão do CIGAM e10. 

&emsp; O documento irá descrever/apresentar como parametrizar as plataformas Windows 32 e 64 bits, para o correto funcionamento do CIGAM Report. Descreve como integrar os relatórios criados ao sistema CIGAM. E de forma básica descreve a criação dos relatórios, mas verifique o [[Arquivo:Como Fazer - CIGAM Report Avançado.pdf]] para informações mais detalhadas.

=O que parametrizar no ambiente Windows, quanto ao CIGAM Report?=

&emsp; Antes de considerar a necessidade de parametrizar o ambiente Windows, certifique-se de estar executando o CIGAM Report a partir do menu Utilidades - Report, ou através do arquivo executável CGReport.exe localizado na pasta de instalação do ERP CIGAM. 

&emsp; Em caso de erros, verificar a correta instalação do .Net framework e suas permissões. Para maiores detalhes sobre a instalação, consulte o documento [[GE_-_Como_Fazer_-_Instalação_do_.Net|‘COMO FAZER - Instalação do .Net nos clientes’.]]

=Quais os fundamentos do CIGAM Report?=

&emsp; O CIGAM REPORT, e um gerador de relatórios direto a banco sem a necessidade de programação e ou desenvolvimento de novos programas no CIGAM via Magic. Suas principais funcionalidades são: 

* Possibilitar a criação de relatórios sem que seja necessário passar pelo desenvolvimento do CIGAM; 
* Todo o desenvolvimento bem como a implantação será feita no cliente de maneira rápida e simples, e; 
* Pode se definir o modelo do relatório diretamente sem que seja necessário disponibilizar variáveis para uma futura implementação ou adição de informações. 

&emsp; Informações detalhadas sobre as funcionalidades do Cigam Report, relevantes para a criação de relatórios verificar o [[Arquivo:Como Fazer - CIGAM Report Avançado.pdf]]

=Como criar o relatório de consulta direta a banco via CIGAM Report?=

&emsp; Ao abrir o CIGAM Report pela primeira vez, caso o idioma esteja em inglês ou outro qualquer que não o português, você pode alterá-lo fazendo o seguinte procedimento: 
&emsp; Clicar em File – Select Language conforme a imagem abaixo: 

[[Arquivo:Imagem100.png|750x500px|centro]]

&emsp; Na janela que irá abrir, clique em portuguese-brasil e em seguida em OK. 

[[Arquivo:Imagem101.png|750x500px|centro]]

&emsp; Ao abrir o Cigam Report devemos selecionar a opção: Arquivo – Novo, irá aparecer a seguinte tela abaixo. 

[[Arquivo:Imagem102.png|750x500px|centro]]

&emsp; A opção relatório em branco deve ser selecionada e clique em adicionar. Com isso será aberto um formulário de relatório padrão conforme imagem abaixo. 

[[Arquivo:Imagem103.png|750x500px|centro]]

&emsp; Agora é necessário informar qual será a fonte de dados do relatório. Isto pode ser feito de duas maneiras: 

* Escolher uma das fontes de dados que foram registradas no relatório através de um método de programação. Isto pode ser feito no menu Dados > Escolher Dados do Relatório, e marcando as fontes de dados necessárias. 
*Uma nova fonte de dados pode ser criada no menu Dados > Adicionar Fonte de Dados. 

&emsp; Após a inclusão da fonte de dados, esta irá aparecer na janela Dados. Agora a mesma pode ser utilizada no relatório. Não é obrigatório que o relatório se conecte somente a uma fonte de dados, permitindo que mais destas sejam adicionadas em um mesmo relatório. 
&emsp; No exemplo para demonstração será a opção Dados – Adicionar Fonte de Dados, conforme apresenta a imagem a seguir. 

[[Arquivo:Imagem104.png|750x500px|centro]]

&emsp; A primeira vez que for conectar com o Banco de Dados será necessário criar uma Nova Ligação. 

[[Arquivo:Imagem105.png|750x500px|centro]]

&emsp; O tipo de ligação deve ficar como Ligação OLE DB. Depois de alterar clicar em Gerar. 

[[Arquivo:Img106.png|750x500px|centro]]

&emsp; Ao clicar em gerar, aparecerá a tela abaixo, onde temos algumas informações importantes a serem observadas. 

[[Arquivo:Img107.png|750x500px|centro]]

&emsp; Nessa tela teve se escolha o provedor de acordo com o banco de dados. Para o banco de dados Oracle pode se utilizar o MICROSOFT OLE DB PROVIDER FOR ORACLE ou o recomendado ORACLE PROVIDER FOR OLE DB. 
&emsp; Para o banco de dados SQL Server se utiliza o MICROSOFT OLE PROVIDER FOR SQL SERVER. Após escolher o provedor de dados correto clique em gerar. 

[[Arquivo:Img108.png|750x500px|centro]]

&emsp; Os campos com o nome do servidor, nome de usuário e senha devem ser informados e a opção de permitir salvamento de senha marcada, para não precisar informar a mesma senha todas as vezes que for executar o relatório. Após informar os campos clique em Testar a Conexão. 

[[Arquivo:Img109.png|750x500px|centro]]

&emsp; Se o teste de conexão for concluído com êxito, clique em OK para continuar a configuração. Caso não tenha tido sucesso no teste de conexão, confira os dados de servidor, usuário e senha e tente novamente. 
&emsp; Problemas de não encontrar o provider do Oracle padrão, revise o capítulo 1 do presente manual para que possas seguir com o padrão solicitado. 
&emsp;Na tela de assistente de dados conforme imagem abaixo clique no botão seguinte. 

[[Arquivo:Img110.png|750x500px|centro]]

=Como acessar uma Tabela no CIGAM Report?=

&emsp; Na próxima tela, há duas opções, onde se pode escolher uma tabela do banco de dados para buscar depois os campos desejados, ou podemos escolher inserir uma consulta em SQL diretamente através do botão Adicionar consulta SQL. 

[[Arquivo:Img111.png|750x500px|centro]]

&emsp; Nesse exemplo, será escolhida a opção de selecionar uma tabela inteira, no caso, a tabela de cadastro de empresas. Após selecionada a tabela, é só clicar no botão terminar. Ao fazer isso, o programa voltará para a tela inicial, mas no canto superior direito aparecerá a nova fonte de dados. Nesse caso aparece a tabela de cadastro de empresas, GEEMPRES, e abaixo dela todos os seus campos, conforme figura abaixo. 

[[Arquivo:Img112.jpg|750x500px|centro]]

&emsp; Clicando nos campos da tabela GEEMPRES que aparecem a direita e arrastando podemos colocá-los no layout do relatório. Os campos devem ser colocados na parte de dados do relatório, conforme exemplo abaixo. 

[[Arquivo:113.png|750x500px|centro]]

&emsp; Ao soltar os campos nos dados, o Cigam Report insere automaticamente o nome do campo no cabeçalho de página. Esse nome é o próprio nome do campo na tabela. Ele pode ser alterado de acordo com a necessidade do relatório. Existem duas formas de se fazer isso: 
&emsp; Dando um duplo clique em cima do mesmo. Assim abrirá uma janela de editar texto onde basta alterar o texto. 
&emsp; Pode-se também alterar o TEXT de dados que aparece ao lado direito da tela, conforme a figura abaixo. 

[[Arquivo:115.jpg|750x500px|centro]]

&emsp; Após de alterado pode se ver um preview de como ficará o relatório. Para isso basta clicar no botão de visualizar que aparece no canto superior esquerdo da tela conforme a figura abaixo. 

[[Arquivo:116.jpg|750x500px|centro]]

&emsp; Ao clicar na opção, a consulta será gerada na base de dados e retornará a tela conforme a figura a seguir, mostrando como os dados estão formatados para apresentação. 

[[Arquivo:117.png|750x500px|centro|177]]

&emsp; Para fechar a visualização do preview basta clicar em fechar. Com isso volta a tela inicial de configuração do layout do relatório. 

=Como acessar Múltiplas Tabelas do CIGAM Report?=

&emsp; Para fazer uma consulta no Cigam Report utilizando um relacionamento entre 2 ou mais tabelas deve ser feito seguindo os seguintes passos: 
&emsp; Selecionar um novo relatório em branco, e clicar em adicionar fonte de dados. 

[[Arquivo:118.png|750x500px|centro]]

&emsp; Na tela que aparece é onde deve ser configurada a conexão com o banco de dados, conforme demonstrado na seção anterior do presente documento, tendo o banco já configurado, basta clicar no botão seguinte, como apresenta a imagem abaixo. 

[[Arquivo:119.png|750x500px|centro]]

&emsp; Nesse exemplo, será selecionado duas tabelas relacionadas. A ESMATERI que tem o Cadastro de Materiais e a PEENGENH que é a da Engenharia. Na tela que abre, selecione as duas tabelas e clique em terminar. 

[[Arquivo:120.png|750x500px|centro]]

&emsp; '''Nas fontes de dados a direita da tela será apresentada as duas tabelas selecionadas.'''

[[Arquivo:121.png|750x500px|centro]]

&emsp; Agora é necessário criar o relacionamento entre as duas tabelas. Para isso deve-se clicar em: Ações / Nova Relação 

[[Arquivo:122.png|750x500px|centro]]

&emsp; Na tela que se abre deverá ser informado a tabela mãe e a tabela filha, e por qual campo elas se relacionam, conforme a imagem abaixo exemplifica. 

[[Arquivo:123.png|750x500px|centro]]

&emsp; Após de realizar o relacionamento clicar em OK. Agora a direita na fonte de dados já aparecem as duas tabelas e com o relacionamento entre elas. No exemplo abaixo está se buscando o código do material da tabela da Engenharia e a descrição do cadastro de materiais. 

[[Arquivo:124.png|750x500px|centro]]

&emsp; Ao gerar o relatório é possível ver a informação de código de material e descrição. 

[[Arquivo:125.png|750x500px|centro]]

=Como acessar múltiplas tabelas via comandos SQL?=
&emsp; Além de fazer a consulta relacionando tabelas da forma como descrito na seção anterior, também é possível acessar múltiplas tabelas através de uma instrução SQL (script).Com a instrução SQL é possível adicionar somente os campos que temos interesse e já fazer a relação entre tabelas diretamente nele. 
&emsp; Para criar uma fonte de dados baseado em uma instrução SQL é preciso clicar em Dados / Adicionar Fonte de Dados, como a configuração com o banco de dados já deve estar pronta, basta clicar no botão seguinte na tela que a figura abaixo ilustra. 

[[Arquivo:126.png|750x500px|centro]]

&emsp; O Cigam Report vai carregar as tabelas, mas em vez de selecioná-las na lista, cliquei no botão Adicionar Consulta Sql. 

[[Arquivo:127.png|750x500px|centro]]

&emsp; Será aberta a janela onde podemos dar um nome para essa instrução, ou simplesmente deixar o nome sugerido e clique em Seguinte. 

[[Arquivo:128.png|750x500px|centro]]

&emsp; Na tela seguinte conforme imagem abaixo se coloca a instrução SQL desenvolvida e basta clicar no botão seguinte. 

[[Arquivo:129.png|750x500px|centro]]

&emsp; Por hora, vamos passar direto pela próxima tela, que é a de parâmetros e apenas clique no botão seguinte. 

[[Arquivo:130.png|750x500px|centro]]

&emsp; Na tela seguinte clique no botão terminar, depois se retornará a essa tela para inclusão dos parâmetros. 

[[Arquivo:131.png|750x500px|centro]]

&emsp; No final da tela de tabelas irá aparecer o nome da consulta criada via SQL conforme imagem abaixo e bastar clicar no botão terminar. 

[[Arquivo:132.png|750x500px|centro]]

&emsp; A partir de então, a instrução SQL que foi utilizada já aparece como uma conexão a base de dados. Os campos poderão ser inseridos no relatório como os da tabela. 

[[Arquivo:133.png|750x500px|centro]]

&emsp; '''Os campos podem ser inseridos na tela do relatório conforme imagem abaixo. '''

[[Arquivo:134.png|750x500px|centro]]

&emsp; Outras informações comuns em relatórios como pagina, data, podem ser inseridas. Essas são demonstradas na figura abaixo. 

[[Arquivo:136.jpg|750x500px|centro]]

&emsp; Na banda de título de relatório (1) se pode inserir algumas variáveis de sistema (2) que estão disponíveis ao lado direito da tela, logo abaixo da fonte de dados. Nesse exemplo será inserida a data e o número de página. O processo para inserir as variáveis é o mesmo que com os campos da tabela. Basta clicar em cima da variável e arrastá-la para o local desejado e soltá-la. 

[[Arquivo:137.jpg|750x500px|centro]]

&emsp; Ao clicar no opção de preview do layout, já será visto o relatório com as variáveis adicionadas nele. 

[[Arquivo:138.png|750x500px|centro]]

&emsp; Também é possível inserir uma figura com o logo da empresa para ser o cabeçalho do relatório como mostrado a figura abaixo. 

[[Arquivo:139.jpg|750x500px|centro]]

&emsp; Para incluir deve se clicar no botão figura e arraste a imagem para o local digitado. Após isso, clique com o botão direito sobre a imagem e escolha a opção editar. 

[[Arquivo:140.png|750x500px|centro]]

&emsp; Ao selecionar a opção irá abrir a tela abaixo. Se escolher a opção Imagem / Abrir. 

[[Arquivo:141.png|750x500px|centro]]

&emsp; Após seleciona uma imagem de uma pasta qualquer dentro do computador. 

[[Arquivo:142.png|750x500px|centro]]

&emsp; Após selecionar a imagem, basta clicar em abrir que será apresentada para o layout do relatório. Quando a imagem já estiver no layout, basta ajustá-la com o tamanho desejado. 

[[Arquivo:143.png|750x500px|centro]]

&emsp; Com isso, ao gerar novamente o preview do relatório, a imagem será apresentada em tela. 

[[Arquivo:144.png|750x500px|centro]]

&emsp; Essas são as formas de criar o relatório pelo CIGAM Report, para realizar a integração do mesmo ao Cigam, será preciso criar os parâmetros/filtros e ajustá-los a consulta, no qual o capítulo seguinte irá apresentar. 

=Integração do relatório CIGAM Report ao Cigam=

&emsp; Com o modelo criado pelo CIGAM Report, para ser utilizado como opção de Menu no Cigam deverá seguir algumas configurações que seguem abaixo. 

=Como utilizar e criar parâmetros, através do CIGAM Report?=

&emsp; Para demonstrar a inserção dos parâmetros será utilizado o exemplo do relatório que lista o nome das empresas. No Cigam Report ele está montado da seguinte maneira. 

[[Arquivo:145.jpg|750x500px|centro]]

&emsp; O relatório gerado se apresenta conforme a imagem abaixo 

[[Arquivo:146.jpg|750x500px|centro]]

&emsp; Para a integração será criada uma tela de filtros para esse relatório dentro do Cigam, o filtro será pelo código da empresa. Para isso será necessário criar um parâmetro que receberá o valor digitado na tela e repassará o valor do mesmo para o Cigam Report. Para fazer isso, deve-se clicar em Parâmetros de Filtros no menu Cigam 

[[Arquivo:147.jpg|750x500px|centro]]

&emsp; Ao acessar no menu do Cigam a opção Parâmetros de Filtros, com o ambiente corretamente configurado irá apresentar alguns parâmetros para serem utilizados, porem não impede que seja criado novos de acordo com a necessidade. Para cadastrar um novo filtro devemos pressionar CTRL + I. 

[[Arquivo:148.jpg|750x500px|centro]]

&emsp; No campo do código se insere o código requerido, ou se permanece com a sugestão do sistema. No campo Nome do Parâmetro se coloca um nome que se deseja para o mesmo. Em Tabela, pressione F5 para abrir a lista de tabelas. 

[[Arquivo:149.jpg|750x500px|centro]]

&emsp; No exemplo criado será utilizado tabela EMPRESA. No campo coluna será selecionado o campo da tabela EMPRESA, onde fica o código do cliente que servirá como filtro. 

[[Arquivo:150.jpg|750x500px|centro]]

&emsp; Em tamanho do controle se informa o tamanho do campo na tela para receber os dados que serão digitados nesse parâmetro. Como o campo de empresa tem 8 dígitos, vamos informar o mesmo valor. Em Nome do Parâmetro para Integração vamos informar o nome do parâmetro que será usado dentro de nossa consulta SQL. É bom sempre usar um nome intuitivo para facilitar o entendimento. Nesse caso se usará o parâmetro como P_Empresa. 

[[Arquivo:151.jpg|750x500px|centro]]

&emsp; Os detalhes do parâmetro que aparecem na parte de baixo da tela são preenchidos automaticamente pelo Cigam, e com todos os campos informados, basta salvar o novo parâmetro. 
&emsp; Como apresentado no inicio da apostila a opção de cadastro de tabelas oriundas de customizações, módulos terceiros ou parceiros desenvolvedores, após devidamente cadastrada a mesma já está visível para realizar o cadastro de parâmetros. Segue o mesmo processo como descrito anteriormente, como a ilustração a seguir apresenta: 

[[Arquivo:152.png|750x500px|centro]]

&emsp; '''IMPORTANTE:''' O parâmetro cadastrado aqui pode ser usado inúmeras vezes, para diversos relatórios posteriormente. Não é necessário mais cadastrar o mesmo parâmetro para outro relatório. Apenas fazer a sua associação ao novo relatório, como será apresentado a seguir. 

=Como apontar o modelo criado, trazendo todos os relatórios do CIGAM Report?=

&emsp; O próximo passo é fazer um cadastro desse relatório dentro do Cigam. Para isso é preciso entrar na tela de Cadastro de Relatórios conforme a imagem abaixo. 

[[Arquivo:153.jpg|750x500px|centro]]

&emsp; A tela de cadastro abrirá mostrando todos os relatórios do Cigam Report que já foram cadastrados, pressione CTRL + I para inserir um novo relatório. 
&emsp; O Código deve ser preenchido com o número desejado. No exemplo utilizado já existia o número 1, por isso o relatório terá o código 2. No nome do relatório devemos colocar o nome que irá aparecer quando o relatório for aberto. A dica é sempre usar um nome intuitivo, que seja de rápida assimilação do conteúdo do mesmo. 

[[Arquivo:153img.png|750x500px|centro]]

&emsp; Após preencher o nome do relatório, devemos definir os tamanhos da tela onde os filtros serão solicitados, e a área onde será exibida a descrição dos filtros. Isso é feito nos campos Tamanho do Controle e Tamanho do Label conforme imagem abaixo. 

[[Arquivo:154.png|750x500px|centro]]

&emsp; Arquivo Modelo: É onde está salvo o arquivo FRX que montamos no Cigam Report. 
&emsp; Será esse arquivo modelo que o Cigam irá procurar para gerar o relatório. Ele deve estar salvo em um local da rede que todos usuários que vão usar o relatório tenham acesso. 
&emsp; Arquivo Gerar: É o arquivo que será gerado pelo Cigam Report, com os dados da consulta. Costuma-se usar o mesmo que o do relatório, acrescentando apenas ao fim do mesmo a palavra “Gerado” conforme imagem abaixo. 

[[Arquivo:155.png|750x500px|centro]]

&emsp; '''IMPORTANTE:''' Para que o relatório a gerar possa ser aberto sem problemas, é preciso avaliar se os usuários possuem permissões de modificar o arquivo no caminho onde ele é gerado. Para alguns casos é preciso dar permissões de modificações na rede, caso contrário, o CIGAM Report poderá apresentar erro em tela 

=Como indicar filtros para o modelo indicado?=

&emsp; Após informar o nome do relatório será informado os filtros dele. Clique no botão Filtros conforme mostra a figura abaixo. 

[[Arquivo:156.png|750x500px|centro]]

&emsp; Ao entrar na tela de filtros, pressione CTRL + I para inserir um novo filtro. Com o cursor parado em cima do campo Parâmetro Filtro, pressione F5 para abrir as opções de filtros já cadastrados anteriormente, no cadastro de parâmetros. 

[[Arquivo:157.png|750x500px|centro]]

&emsp; Posicione o cursor sobre o parâmetro Empresa já cadastrado e pressione <ENTER>. 

[[Arquivo:158.png|750x500px|centro]]

&emsp; De volta a tela de cadastro de filtros tem as seguintes opções: 
&emsp; '''Ordem Exibição''' – Mostra a posição do parâmetro na tela. No caso de existirem 2 ou mais filtros, a partir da ordem de exibição se escolhe a ordem que eles aparecerão na tela. 
&emsp; '''Faixa''' - Indica que o filtro será com início e fim (intervalo). Nesse caso o nome do parâmetro de integração será duplo sendo composto da seguinte forma como exemplo: p_empresa_inicial e p_empresa_final. 
&emsp; '''Obrigatório''' – Serve para tornar obrigatório ou não o preenchimento desse campo na tela de parâmetros. Caso esteja marcado, não permitirá gerar o relatório sem informar algum valor no campo. 
&emsp; '''Intervalo''' - Indica se deve disponibilizar o intervalo final no filtro. Caso estiver selecionado “Faixa” e não estiver selecionado o Intervalo, será submetido o dado inicial e final porém somente o inicial é solicitado. Essa opção é útil quando se deseja filtrar um valor específico único (sem faixa) podendo-se também deixar em branco para abranger todos os registros (atual comportamento dos programas de filtros de relatórios). 
&emsp; '''Aleatório''' – utilizado para informar de forma aleatória os dados a serem filtrados. * Vale ressaltar que este tipo de parâmetro será utilizado na query do Report com o uso do comando “in”. Ex.: Select * from geempres e where e.cd_empresa in (@p_aleatorio). 
&emsp; Agora é importante notar que de acordo com o que se seleciona como Faixa e Intervalo, muda o nome do parâmetro de integração que fica visível no final da tela conforme imagem abaixo. 

[[Arquivo:159.png|750x500px|centro]]

&emsp; O parâmetro criado é o p_empresa. Como escolhido um intervalo, o Cigam já cria o parâmetro inicial e o final. O nome nesse caso ficará como p_empresa_inicial e p_empresa_final. É muito importante observar isso. Porque esses parâmetros serão informados dentro do Cigam Report, e informados na consulta SQL que foi montada. 
&emsp; '''IMPORTANTE:''' Ter atenção de como os filtros são criados é extremamente importante, pois o CIGAM Report é Case Sensitive. O parâmetro informado na consulta não estando da mesma maneira que o apresentado na tela de filtros, fará com que o relatório não seja aberto, irá apresentar uma tela que está acessando os dados, porém não abrirá nada em tela. 

=Como indicar os parâmetros do CIGAM Report na consulta SQL?=

&emsp; Para que os parâmetros sejam apontados na consulta, é preciso que o modelo seja aberto no Cigam Report, clique na fonte de dados com o botão direito e escolha a opção editar. 

[[Arquivo:160.jpg|750x500px|centro]]

&emsp; Na tela que abrir clique no botão seguinte. 

[[Arquivo:161.jpg|750x500px|centro]]

&emsp; Na tela seguinte irá aparecer com a consulta SQL, e nessa será incluída os parâmetros. 

[[Arquivo:162.jpg|750x500px|centro]]

&emsp; Agora será necessário alterar essa consulta SQL, inserindo nela os filtros que serão utilizados na tela do Cigam, para gerar o relatório. 

[[Arquivo:163.jpg|750x500px|centro]]

&emsp; Os filtros são cláusulas de restrição. Então é necessário inserir um WHERE na nossa consulta SQL. Como se escolheu informar um Intervalo de dados, no SQL se precisa colocar o comando BETWEEN e o parâmetro inicial e final, sendo :p_empresa_inicial e :p_empresa_final respectivamente. 

&emsp; Uma observação importante: 
* uso dos dois pontos (:) desse exemplo deve-se ao fato de estar usando um banco ORACLE. No caso de bancos MSSQL usa-se @. Dessa forma fica assim:
:: ORACLE :p_empresa_inicial 
:: MSSQL @p_empresa_final 

&emsp; Após a inclusão do comando SQL, clique no botão seguinte. A tela seguinte será preciso cadastrar dentro do Cigam Report os parâmetros. É necessário informar os dados de cada um dos parâmetros. No caso desse exemplo são dois, o inicial e final. 

[[Arquivo:164.jpg|750x500px|centro]]

&emsp; É necessário informar sempre: 
* '''Name:''' É o nome do parâmetro. 
* ''' DataType:''' é o tipo de data do parâmetro. Nesse exemplo é um VarChar. 
* ''' DefaultValue:''' Valor padrão, nesse caso foi informado zero. 
* ''' Size:''' é o tamanho do campo. 
&emsp; Em caso de dúvidas, essas informações aparecem na tela do Cigam quando foi cadastrado o parâmetro. 

[[Arquivo:165.png|750x500px|centro]]

&emsp; Após terminar de cadastrar os parâmetros clique no botão seguinte. Apresentará a tela conforme imagem abaixo, nessa basta clicar no botão terminar. 

[[Arquivo:166.jpg|750x500px|centro]]

&emsp; Retornando a tela do layout o modelo deverá ser salvo para que seja armazenado com os parâmetros incluídos. 
&emsp; Agora, de volta ao Cigam, pode se verificar como ficará a tela de filtros. Para isso, clique no botão Executar. 

[[Arquivo:167.png|750x500px|centro]]

&emsp; Ao clicar no botão executar abrirá uma janela, que será a tela de filtros do relatório. Observe que o nome cadastrado anteriormente aparece na parte superior da tela. O filtro criado, de empresa, aparece com um intervalo, onde deve ser informado valor inicial e final, conforme cadastrado na tela de filtros. 

[[Arquivo:168.png|750x500px|centro]]

&emsp; Com o cursor posicionado em cima do campo empresa tecle F5, para isso o ambiente deverá que estar parametrizado conforme o capitulo inicial do documento. Ao clicar o F5 abre uma tela de zoom, onde é possível fazer o filtro específico, encontrar o cliente/fornecedor desejado para efetuar a pesquisa. Como na definição dos parâmetros foi deixado o campo de empresa não sendo obrigatório, podemos escolher informar ou não o código da empresa para gerar o relatório. 
&emsp; Então agora se pode testar como fica a integração entre o Cigam e o Cigam Report. Cabe ressaltar, que o usuário final, ao rodar o relatório, somente irá enxergar essa tela de filtros e o relatório pronto. Toda a parte de desenvolvimento do relatório será “transparente” para ele. No exemplo abaixo será deixado primeiramente o filtro em branco. 

[[Arquivo:169.jpg|500x250px|centro]]

&emsp; O relatório é gerado com todos os dados disponíveis na base de dados. 

[[Arquivo:170.jpg|750x500px|centro]]

&emsp; Agora será gerado o relatório novamente utilizando o filtro. 

[[Arquivo:171.jpg|500x250px|centro]]

&emsp; Utilizando o filtro dessa forma, o relatório retorna apenas os itens dentro da faixa informada. 

[[Arquivo:172.png|750x500px|centro]]

&emsp; Com o modelo de relatório apontado, filtros criados e parâmetros indicados na consulta SQL, será preciso apontar o relatório ao Menu Cigam para utilização dos usuários finais. 

=Como realizar exportação direta para ferramentas como PDF, EXCEL, WORD pelo CIGAM Report?=

&emsp; A partir das ultimas verões o CIGAM Report.ecf, passa a permitir a exportação dos dados diretamente para as ferramentas de extensão PDF, RTF, HTML, MHT, XML, XLSX, PPTX, ODS, CSV, DBF e JPG. Essa opção não abrirá o preview do report mas sim a ferramenta cuja a extensão que foi informada junto ao campo Arquivo Exportar. 
&emsp; Para utilizar essa opção na tela de cadastro dos relatórios CIGAM Report no campo Exportação selecione a extensão requerida, como apresenta a imagem a abaixo. Ao selecionar a extensão o checkbox e o campo Arquivo Exportar serão habilitados. 

[[Arquivo:173.png|500x250px|centro]]

&emsp; No campo Arquivo Exportar é informado o caminho seguido do nome do arquivo e a extensão, exemplo: C:\Temp\Teste.pdf. Somente com o preenchimento desse campo será criada a exportação e caso marcando o checkbox a abertura do mesmo. 
&emsp; Para a abertura do arquivo na extensão requerida o checkbox Abrir ao Concluir deve ser marcado. Após a exportação a abertura será na respectiva extensão/ferramenta disponível no Windows. Não marcando o checkbox, será somente exportando e não será aberta nenhuma tela de visualização do relatório. 
&emsp; '''IMPORTANTE:''' no campo Arquivo Exportação é obrigatória a informação da extensão, mesmo que essa foi selecionada no campo Exportação. Pois o campo exportação é informativo e como chave de liberação dos campos. Informado o caminho\arquivo.extensão essa validação será feita pelo próprio Windows para a exportação e abertura do arquivo na ferramenta apropriada. 

=Como cadastrar Nomes Logicos e Conexões?=

&emsp; Para auxiliar no desenvolvimento dos relatórios customizados, além de melhorias na performance para apresentar as informações pretendidas, há a opção de cadastrar os Nomes Lógicos a serem utilizadas, no exemplo abaixo, as tabelas que o relatório irá utilizar assim como eventuais customizações que serão utilizadas, conforme apresenta a imagem a seguir. 

[[Arquivo:174.png|750x500px|centro]]

&emsp; Para uso basta clicar no botão Nomes-Lógicos, pressionar CRTL+I, e sobre o campo nome logico pressionar F5, onde irá apresentar todos os Nomes Lógicos inclusive de projetos customizados. Após cadastrado, no relatório basta informar o parâmetro submetido. 
&emsp; O uso do botão Conexões é utilizado para cadastrar as conexões com o banco de dados após o cadastro realizado dentro do relatório customizado em Report. Cada conexão possui um nome, como ilustra a imagem abaixo, e esse nome após é informado no cadastro das conexões e direcionado para outro banco de dados pretendido. 

[[Arquivo:175.png|750x500px|centro]]

&emsp; Para realizar a criação da conexão é preciso preencher o Nome da Conexão conforme é apresentado no relatório, como ilustra a imagem anterior. A Ordem que as conexões serão realizadas, o Tipo da conexão (Automatica ou Especifica) e qual Provider será utilizada essa opção irá variar entre banco de dados Oracle e Mssql. 
&emsp; Os dois tipos de conexão que apresenta significa que Automático irá buscar as conexões do banco já utilizado pelo Cigam e Especifica deverá ser manualmente informado a string de conexão pretendida. Como demonstra a figura seguinte. 

[[Arquivo:176.png|750x500px|centro]]

&emsp; Após criada a conexão há a opção de criar eventos, o opção existe para caso o relatórios customizado precise realizar alguma ação após de gerado. Exemplo, emissão de Nota Fiscal customizado, após de impresso precisa setar o campo como impresso. 
&emsp; Para realizar esse cadastro dentro da telaro de conexão há o botão Evento, clicando sobre o botão será apresenta a tela conforme ilustra a imagem a seguir. No campo Tipo selecionar a opção de executar a ação antes ou depois de gerar o relatório. No campo Ordem a sequencia de execução. No campo Instrução SQL informar o comando a ser executado e caso for uma procedure a ser executado marcar o checkbox Procedure. 

[[Arquivo:177.png|750x500px|centro]]

&emsp; O cadastro do evento não precisa ser acrescentado ao relatório CIGAM Report.

=Como cadastrar Zoom dos campos CIGAM Report?=
&emsp; Ao realizar a preparação do ambiente para atender o CIGAM Report, como descrito nos capítulos iniciais é executado o scripts que os programas de zoom. Essa opção permite na tela de filtros pressionar F5 e selecionar a opção desejada para executar o relatório. 
&emsp; Os scripts carregam os programas de pesquisa para os campos até o momento mapeados, não significa que para todos os campos se tenha o programa de pesquisa criado, visto que o mesmo precisa existir no Cigam para que possa ser linkado. 
&emsp; O mesmo link dos campos com programas pode ser feito manualmente, principalmente de campo ainda não mapeadas e disponibilizados para serem atualizados. Ou de tabelas customizadas, módulos terceiros ou parceiros desenvolvedores. Ou caso se tenha a necessidade de apontar para outro programa fora do padrão disponibilizado. 
&emsp; Para realizar o cadastro basta ter em mãos o números do Programa de pesquisa e informa-lo no campo Nome Publico Programa. Como ilustrado a seguir. 

[[Arquivo:178.png|750x500px|centro]]

&emsp; O campo Posição Retorno por padrão vem apontado como 1 ou seja, após selecionar o dado o retorno para a tela de filtro será o código. Sendo necessário a descrição do dado a opção deve ser alterada para 2. Mas isso deve está ajustado internamente no programa Cigam e não há opção de ajustes. Eventual necessidade de mudança deve ser avaliado via desenvolvimento a possibilidade de ajuste. 
&emsp; Para alguns programas há disponíveis retornos 3, 4 e demais, mas isso não é regra para todos. E somente avaliando para ver o que os demais retornos retornam pois como a definição ocorre no desenvolvimento do programa. Como regra utiliza-se as opção 1 – Codigo e 2 – Descrição. 

=Como cadastrar Zoom para tabelas customizadas CIGAM Report?=

&emsp; Para tabelas customizadas para o cadastro de zoom funcionar deve ser informado no campo Nome Publico do Programa o programa customizado e no campo Componente, o caminho onde se encontra o projeto da customização. A tabela irá apresentar a sua formatação em negrito, se destacando dos demais para diferenciar das tabelas do ERP Cigam, como demonstra a figura abaixo. 

[[Arquivo:179.png|750x500px|centro]]

&emsp; É importante relatar que além do projeto customizado, tabelas, existem os nomes lógicos, conectores necessários para o correto funcionando do projeto customizado e consequentemente o cadastro de zoom também. Na falta de algum dos arquivos citados, o padão é buscar do projeto Cigam (CGGeral). 
&emsp; Outra opção é realizar o cadastro de zoom para uma customização da tabela do ERP Cigam. Para isso basta selecionar a tabela e campos e preencher os campos para buscar o projeto da customização, módulos terceiros ou parceiros desenvolvedores. Da mesma forma que ocorre para a tabela terceira para a tabela do ERP Cigam também irá apresentar em negrito demostrando que essa possui outro projeto linkado, como demonstra a ilustração a seguir. 

[[Arquivo:180.png|750x500px|centro]]

&emsp; Dessa forma há como facilitar ao usuário a seleção dos dados para filtrar as informações se seu relatório customizado. 

=Como disponibilizar o Relatório CIGAM Report no Menu Cigam?=

&emsp; Para cadastrar um atalho do relatório no Menu do CIGAM, basta posicionar no local desejado e executar a “Tecla Fácil CIGAM” (com atalho pelo F10) e na tela clicar em “Nova Opção de Menu, como ilustra a figura abaixo. 

[[Arquivo:181.png|500x250px|centro]]

&emsp; Na tela seguinte selecionar “Relatório CIGAM Report” como tipo de opção de menu. 

[[Arquivo:182.png|500x250px|centro]]

&emsp; Após a seleção, automaticamente os campos com as informações da chamada da aplicação do CIGAM Report e os programas necessários são preenchidos e bloqueados para modificação. Deve-se apenas informar uma descrição para o relatório e a chave do programa que será o número do relatório cadastrado. 

[[Arquivo:183.png|500x250px|centro]]

&emsp; No campo Chave do Programa está disponível o zoom no campo para selecionar o relatório requerido, esse apresenta a tela de cadastro dos relatórios, conforme figura abaixo. 

[[Arquivo:184.png|750x500px|centro]]

&emsp; Após clicar em confirmar será aberta uma tela onde devem ser informados quais usuários devem ter acesso ao relatório. Pode-se escolher entre as opções de apenas o usuário que está cadastrando, escolher um usuário específico da lista que aparece, um grupo de usuários ou todos os usuários. Nesse exemplo foi escolhida a opção Todos os Usuários. 

[[Arquivo:185.jpg|750x500px|centro]]

&emsp; Após o cadastro a opção ficará disponível para execução o relatório por dentro do Menu do Cigam, como ilustra a imagem abaixo. 
[[Arquivo:186.png|500x250px|centro]]

&emsp; Por meio desse ajuste o relatório está integrado ao Menu Cigam dentro do módulo correspondente. 

=Como ativar modo DEBUG no CIGAM Report?=

&emsp; A funcionalidade foi criada para facilitar a visualização dos dados da integração entre o CIGAM e o CIGAM Report. Para ativá-la, basta setar o nome-lógico DEBUG_CIGAM REPORT com “S”. Cabe lembrar que esta opção somente deverá ser ativada quando da necessidade de depuração para procurar e ou verificar erros. 

[[Arquivo:200.png|750x500px|centro]]

&emsp; Ao executar o cadastro do relatório, a atividade da funcionalidade pode ser identificada no título da janela, conforme ilustra a imagem abaixo.

[[Arquivo:201.png|750x500px|centro]]

&emsp; Ao executar o relatório (pelo botão “Executar” ou pela integração com o menu do CIGAM) será exibida uma mensagem, figura abaixo, com a linha de comando que será executada. 

[[Arquivo:202.png|750x500px|centro]]

&emsp; O conteúdo dessa mensagem pode ser obtido em formato texto através de um CTRL+C sob a mensagem em exibição. O resultado será o seguinte: 
--------------------------- 
Atenção 
--------------------------- 
Linha de comando: 
H:\CIGAM10\PROJECTS\CIGAM\CIGAM Report.exe -G: -M:f:\Teste_data.frx -A:f:\Teste_data_xx.frx -P::p_data='08/11/2009' 
--------------------------- 
OK 

&emsp; Após a exibição da linha de comando é possível escolher se deseja submeter (executar a geração do relatório) no executável do CIGAM Report instalado (também aparece o caminho completo do arquivo o qual deverá existir). 

[[Arquivo:203.png|750x500px|centro]]

&emsp; Após realizar as verificações o nome lógico, deve ser alterado para ‘N’, pois senão as telas irão ser apresentadas aos usuários que utilizarão o relatório, cada vez que for utilizando, podendo trazer descontentamento ao cliente por ter tantas telas para confirmar. 
&emsp; Com meio dessas instruções que se realiza a integração do Cigam Report com o Cigam. Podendo criar relatórios conforme necessidade sem o envolvimento do setor de desenvolvimento, agilizando dessa forma a solicitação do cliente. 

'''Mais duvidas consultar'''
[[FAQ GE|FAQ GE|CGReport]]

GE - Como Fazer - CIGAM Report

2025-10-23T19:24:25Z

Alessandro.voto: /* O que parametrizar no ambiente Windows, quanto ao CIGAM Report? */

{{VoltarPagina}}
 
[[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 - CIGAM Report|CIGAM Report]]

=CIGAM Report=
&emsp; Uma ferramenta originária do Fast Report, que adquirido o código fonte, foi adaptado as necessidade do ERP CIGAM em criação de relatórios customizados. Extraindo do CIGAM as informações necessárias através da utilização de comandos SQL’S. A ferramenta pode ser utilizada por clientes que usam o banco de dados Oracle ou MS-SQL, e a versão do CIGAM e10. 

&emsp; O documento irá descrever/apresentar como parametrizar as plataformas Windows 32 e 64 bits, para o correto funcionamento do CIGAM Report. Descreve como integrar os relatórios criados ao sistema CIGAM. E de forma básica descreve a criação dos relatórios, mas verifique o [[Arquivo:Como Fazer - CIGAM Report Avançado.pdf]] para informações mais detalhadas.

=O que parametrizar no ambiente Windows, quanto ao CIGAM Report?=

&emsp; Antes de verificar a necessidade de parametrizar o ambiente Windows, certifique-se que o executável do CIGAM Report está abrindo sem erros. 

&emsp; Caso não seja aberta a aplicação, verifique se os seguintes arquivos constam na pasta de instalação do CIGAM: 
&emsp; &emsp; - Cigam.Utils.dll 
&emsp; &emsp; - FastReport.Bars.dll 
&emsp; &emsp; - FastReport.dll 
&emsp; &emsp; - FastReport.Editor.dll 

&emsp; Para executa-lo acesse o %CIGAM_INSTAL%CGReport.exe. Em caso de erros avaliar a instalação do .Net framework e suas permissões, dúvidas sobre a instalação verificar o documento [[GE_-_Como_Fazer_-_Instalação_do_.Net|‘COMO FAZER - Instalação do .Net nos clientes’.]]

=Quais os fundamentos do CIGAM Report?=

&emsp; O CIGAM REPORT, e um gerador de relatórios direto a banco sem a necessidade de programação e ou desenvolvimento de novos programas no CIGAM via Magic. Suas principais funcionalidades são: 

* Possibilitar a criação de relatórios sem que seja necessário passar pelo desenvolvimento do CIGAM; 
* Todo o desenvolvimento bem como a implantação será feita no cliente de maneira rápida e simples, e; 
* Pode se definir o modelo do relatório diretamente sem que seja necessário disponibilizar variáveis para uma futura implementação ou adição de informações. 

&emsp; Informações detalhadas sobre as funcionalidades do Cigam Report, relevantes para a criação de relatórios verificar o [[Arquivo:Como Fazer - CIGAM Report Avançado.pdf]]

=Como criar o relatório de consulta direta a banco via CIGAM Report?=

&emsp; Ao abrir o CIGAM Report pela primeira vez, caso o idioma esteja em inglês ou outro qualquer que não o português, você pode alterá-lo fazendo o seguinte procedimento: 
&emsp; Clicar em File – Select Language conforme a imagem abaixo: 

[[Arquivo:Imagem100.png|750x500px|centro]]

&emsp; Na janela que irá abrir, clique em portuguese-brasil e em seguida em OK. 

[[Arquivo:Imagem101.png|750x500px|centro]]

&emsp; Ao abrir o Cigam Report devemos selecionar a opção: Arquivo – Novo, irá aparecer a seguinte tela abaixo. 

[[Arquivo:Imagem102.png|750x500px|centro]]

&emsp; A opção relatório em branco deve ser selecionada e clique em adicionar. Com isso será aberto um formulário de relatório padrão conforme imagem abaixo. 

[[Arquivo:Imagem103.png|750x500px|centro]]

&emsp; Agora é necessário informar qual será a fonte de dados do relatório. Isto pode ser feito de duas maneiras: 

* Escolher uma das fontes de dados que foram registradas no relatório através de um método de programação. Isto pode ser feito no menu Dados > Escolher Dados do Relatório, e marcando as fontes de dados necessárias. 
*Uma nova fonte de dados pode ser criada no menu Dados > Adicionar Fonte de Dados. 

&emsp; Após a inclusão da fonte de dados, esta irá aparecer na janela Dados. Agora a mesma pode ser utilizada no relatório. Não é obrigatório que o relatório se conecte somente a uma fonte de dados, permitindo que mais destas sejam adicionadas em um mesmo relatório. 
&emsp; No exemplo para demonstração será a opção Dados – Adicionar Fonte de Dados, conforme apresenta a imagem a seguir. 

[[Arquivo:Imagem104.png|750x500px|centro]]

&emsp; A primeira vez que for conectar com o Banco de Dados será necessário criar uma Nova Ligação. 

[[Arquivo:Imagem105.png|750x500px|centro]]

&emsp; O tipo de ligação deve ficar como Ligação OLE DB. Depois de alterar clicar em Gerar. 

[[Arquivo:Img106.png|750x500px|centro]]

&emsp; Ao clicar em gerar, aparecerá a tela abaixo, onde temos algumas informações importantes a serem observadas. 

[[Arquivo:Img107.png|750x500px|centro]]

&emsp; Nessa tela teve se escolha o provedor de acordo com o banco de dados. Para o banco de dados Oracle pode se utilizar o MICROSOFT OLE DB PROVIDER FOR ORACLE ou o recomendado ORACLE PROVIDER FOR OLE DB. 
&emsp; Para o banco de dados SQL Server se utiliza o MICROSOFT OLE PROVIDER FOR SQL SERVER. Após escolher o provedor de dados correto clique em gerar. 

[[Arquivo:Img108.png|750x500px|centro]]

&emsp; Os campos com o nome do servidor, nome de usuário e senha devem ser informados e a opção de permitir salvamento de senha marcada, para não precisar informar a mesma senha todas as vezes que for executar o relatório. Após informar os campos clique em Testar a Conexão. 

[[Arquivo:Img109.png|750x500px|centro]]

&emsp; Se o teste de conexão for concluído com êxito, clique em OK para continuar a configuração. Caso não tenha tido sucesso no teste de conexão, confira os dados de servidor, usuário e senha e tente novamente. 
&emsp; Problemas de não encontrar o provider do Oracle padrão, revise o capítulo 1 do presente manual para que possas seguir com o padrão solicitado. 
&emsp;Na tela de assistente de dados conforme imagem abaixo clique no botão seguinte. 

[[Arquivo:Img110.png|750x500px|centro]]

=Como acessar uma Tabela no CIGAM Report?=

&emsp; Na próxima tela, há duas opções, onde se pode escolher uma tabela do banco de dados para buscar depois os campos desejados, ou podemos escolher inserir uma consulta em SQL diretamente através do botão Adicionar consulta SQL. 

[[Arquivo:Img111.png|750x500px|centro]]

&emsp; Nesse exemplo, será escolhida a opção de selecionar uma tabela inteira, no caso, a tabela de cadastro de empresas. Após selecionada a tabela, é só clicar no botão terminar. Ao fazer isso, o programa voltará para a tela inicial, mas no canto superior direito aparecerá a nova fonte de dados. Nesse caso aparece a tabela de cadastro de empresas, GEEMPRES, e abaixo dela todos os seus campos, conforme figura abaixo. 

[[Arquivo:Img112.jpg|750x500px|centro]]

&emsp; Clicando nos campos da tabela GEEMPRES que aparecem a direita e arrastando podemos colocá-los no layout do relatório. Os campos devem ser colocados na parte de dados do relatório, conforme exemplo abaixo. 

[[Arquivo:113.png|750x500px|centro]]

&emsp; Ao soltar os campos nos dados, o Cigam Report insere automaticamente o nome do campo no cabeçalho de página. Esse nome é o próprio nome do campo na tabela. Ele pode ser alterado de acordo com a necessidade do relatório. Existem duas formas de se fazer isso: 
&emsp; Dando um duplo clique em cima do mesmo. Assim abrirá uma janela de editar texto onde basta alterar o texto. 
&emsp; Pode-se também alterar o TEXT de dados que aparece ao lado direito da tela, conforme a figura abaixo. 

[[Arquivo:115.jpg|750x500px|centro]]

&emsp; Após de alterado pode se ver um preview de como ficará o relatório. Para isso basta clicar no botão de visualizar que aparece no canto superior esquerdo da tela conforme a figura abaixo. 

[[Arquivo:116.jpg|750x500px|centro]]

&emsp; Ao clicar na opção, a consulta será gerada na base de dados e retornará a tela conforme a figura a seguir, mostrando como os dados estão formatados para apresentação. 

[[Arquivo:117.png|750x500px|centro|177]]

&emsp; Para fechar a visualização do preview basta clicar em fechar. Com isso volta a tela inicial de configuração do layout do relatório. 

=Como acessar Múltiplas Tabelas do CIGAM Report?=

&emsp; Para fazer uma consulta no Cigam Report utilizando um relacionamento entre 2 ou mais tabelas deve ser feito seguindo os seguintes passos: 
&emsp; Selecionar um novo relatório em branco, e clicar em adicionar fonte de dados. 

[[Arquivo:118.png|750x500px|centro]]

&emsp; Na tela que aparece é onde deve ser configurada a conexão com o banco de dados, conforme demonstrado na seção anterior do presente documento, tendo o banco já configurado, basta clicar no botão seguinte, como apresenta a imagem abaixo. 

[[Arquivo:119.png|750x500px|centro]]

&emsp; Nesse exemplo, será selecionado duas tabelas relacionadas. A ESMATERI que tem o Cadastro de Materiais e a PEENGENH que é a da Engenharia. Na tela que abre, selecione as duas tabelas e clique em terminar. 

[[Arquivo:120.png|750x500px|centro]]

&emsp; '''Nas fontes de dados a direita da tela será apresentada as duas tabelas selecionadas.'''

[[Arquivo:121.png|750x500px|centro]]

&emsp; Agora é necessário criar o relacionamento entre as duas tabelas. Para isso deve-se clicar em: Ações / Nova Relação 

[[Arquivo:122.png|750x500px|centro]]

&emsp; Na tela que se abre deverá ser informado a tabela mãe e a tabela filha, e por qual campo elas se relacionam, conforme a imagem abaixo exemplifica. 

[[Arquivo:123.png|750x500px|centro]]

&emsp; Após de realizar o relacionamento clicar em OK. Agora a direita na fonte de dados já aparecem as duas tabelas e com o relacionamento entre elas. No exemplo abaixo está se buscando o código do material da tabela da Engenharia e a descrição do cadastro de materiais. 

[[Arquivo:124.png|750x500px|centro]]

&emsp; Ao gerar o relatório é possível ver a informação de código de material e descrição. 

[[Arquivo:125.png|750x500px|centro]]

=Como acessar múltiplas tabelas via comandos SQL?=
&emsp; Além de fazer a consulta relacionando tabelas da forma como descrito na seção anterior, também é possível acessar múltiplas tabelas através de uma instrução SQL (script).Com a instrução SQL é possível adicionar somente os campos que temos interesse e já fazer a relação entre tabelas diretamente nele. 
&emsp; Para criar uma fonte de dados baseado em uma instrução SQL é preciso clicar em Dados / Adicionar Fonte de Dados, como a configuração com o banco de dados já deve estar pronta, basta clicar no botão seguinte na tela que a figura abaixo ilustra. 

[[Arquivo:126.png|750x500px|centro]]

&emsp; O Cigam Report vai carregar as tabelas, mas em vez de selecioná-las na lista, cliquei no botão Adicionar Consulta Sql. 

[[Arquivo:127.png|750x500px|centro]]

&emsp; Será aberta a janela onde podemos dar um nome para essa instrução, ou simplesmente deixar o nome sugerido e clique em Seguinte. 

[[Arquivo:128.png|750x500px|centro]]

&emsp; Na tela seguinte conforme imagem abaixo se coloca a instrução SQL desenvolvida e basta clicar no botão seguinte. 

[[Arquivo:129.png|750x500px|centro]]

&emsp; Por hora, vamos passar direto pela próxima tela, que é a de parâmetros e apenas clique no botão seguinte. 

[[Arquivo:130.png|750x500px|centro]]

&emsp; Na tela seguinte clique no botão terminar, depois se retornará a essa tela para inclusão dos parâmetros. 

[[Arquivo:131.png|750x500px|centro]]

&emsp; No final da tela de tabelas irá aparecer o nome da consulta criada via SQL conforme imagem abaixo e bastar clicar no botão terminar. 

[[Arquivo:132.png|750x500px|centro]]

&emsp; A partir de então, a instrução SQL que foi utilizada já aparece como uma conexão a base de dados. Os campos poderão ser inseridos no relatório como os da tabela. 

[[Arquivo:133.png|750x500px|centro]]

&emsp; '''Os campos podem ser inseridos na tela do relatório conforme imagem abaixo. '''

[[Arquivo:134.png|750x500px|centro]]

&emsp; Outras informações comuns em relatórios como pagina, data, podem ser inseridas. Essas são demonstradas na figura abaixo. 

[[Arquivo:136.jpg|750x500px|centro]]

&emsp; Na banda de título de relatório (1) se pode inserir algumas variáveis de sistema (2) que estão disponíveis ao lado direito da tela, logo abaixo da fonte de dados. Nesse exemplo será inserida a data e o número de página. O processo para inserir as variáveis é o mesmo que com os campos da tabela. Basta clicar em cima da variável e arrastá-la para o local desejado e soltá-la. 

[[Arquivo:137.jpg|750x500px|centro]]

&emsp; Ao clicar no opção de preview do layout, já será visto o relatório com as variáveis adicionadas nele. 

[[Arquivo:138.png|750x500px|centro]]

&emsp; Também é possível inserir uma figura com o logo da empresa para ser o cabeçalho do relatório como mostrado a figura abaixo. 

[[Arquivo:139.jpg|750x500px|centro]]

&emsp; Para incluir deve se clicar no botão figura e arraste a imagem para o local digitado. Após isso, clique com o botão direito sobre a imagem e escolha a opção editar. 

[[Arquivo:140.png|750x500px|centro]]

&emsp; Ao selecionar a opção irá abrir a tela abaixo. Se escolher a opção Imagem / Abrir. 

[[Arquivo:141.png|750x500px|centro]]

&emsp; Após seleciona uma imagem de uma pasta qualquer dentro do computador. 

[[Arquivo:142.png|750x500px|centro]]

&emsp; Após selecionar a imagem, basta clicar em abrir que será apresentada para o layout do relatório. Quando a imagem já estiver no layout, basta ajustá-la com o tamanho desejado. 

[[Arquivo:143.png|750x500px|centro]]

&emsp; Com isso, ao gerar novamente o preview do relatório, a imagem será apresentada em tela. 

[[Arquivo:144.png|750x500px|centro]]

&emsp; Essas são as formas de criar o relatório pelo CIGAM Report, para realizar a integração do mesmo ao Cigam, será preciso criar os parâmetros/filtros e ajustá-los a consulta, no qual o capítulo seguinte irá apresentar. 

=Integração do relatório CIGAM Report ao Cigam=

&emsp; Com o modelo criado pelo CIGAM Report, para ser utilizado como opção de Menu no Cigam deverá seguir algumas configurações que seguem abaixo. 

=Como utilizar e criar parâmetros, através do CIGAM Report?=

&emsp; Para demonstrar a inserção dos parâmetros será utilizado o exemplo do relatório que lista o nome das empresas. No Cigam Report ele está montado da seguinte maneira. 

[[Arquivo:145.jpg|750x500px|centro]]

&emsp; O relatório gerado se apresenta conforme a imagem abaixo 

[[Arquivo:146.jpg|750x500px|centro]]

&emsp; Para a integração será criada uma tela de filtros para esse relatório dentro do Cigam, o filtro será pelo código da empresa. Para isso será necessário criar um parâmetro que receberá o valor digitado na tela e repassará o valor do mesmo para o Cigam Report. Para fazer isso, deve-se clicar em Parâmetros de Filtros no menu Cigam 

[[Arquivo:147.jpg|750x500px|centro]]

&emsp; Ao acessar no menu do Cigam a opção Parâmetros de Filtros, com o ambiente corretamente configurado irá apresentar alguns parâmetros para serem utilizados, porem não impede que seja criado novos de acordo com a necessidade. Para cadastrar um novo filtro devemos pressionar CTRL + I. 

[[Arquivo:148.jpg|750x500px|centro]]

&emsp; No campo do código se insere o código requerido, ou se permanece com a sugestão do sistema. No campo Nome do Parâmetro se coloca um nome que se deseja para o mesmo. Em Tabela, pressione F5 para abrir a lista de tabelas. 

[[Arquivo:149.jpg|750x500px|centro]]

&emsp; No exemplo criado será utilizado tabela EMPRESA. No campo coluna será selecionado o campo da tabela EMPRESA, onde fica o código do cliente que servirá como filtro. 

[[Arquivo:150.jpg|750x500px|centro]]

&emsp; Em tamanho do controle se informa o tamanho do campo na tela para receber os dados que serão digitados nesse parâmetro. Como o campo de empresa tem 8 dígitos, vamos informar o mesmo valor. Em Nome do Parâmetro para Integração vamos informar o nome do parâmetro que será usado dentro de nossa consulta SQL. É bom sempre usar um nome intuitivo para facilitar o entendimento. Nesse caso se usará o parâmetro como P_Empresa. 

[[Arquivo:151.jpg|750x500px|centro]]

&emsp; Os detalhes do parâmetro que aparecem na parte de baixo da tela são preenchidos automaticamente pelo Cigam, e com todos os campos informados, basta salvar o novo parâmetro. 
&emsp; Como apresentado no inicio da apostila a opção de cadastro de tabelas oriundas de customizações, módulos terceiros ou parceiros desenvolvedores, após devidamente cadastrada a mesma já está visível para realizar o cadastro de parâmetros. Segue o mesmo processo como descrito anteriormente, como a ilustração a seguir apresenta: 

[[Arquivo:152.png|750x500px|centro]]

&emsp; '''IMPORTANTE:''' O parâmetro cadastrado aqui pode ser usado inúmeras vezes, para diversos relatórios posteriormente. Não é necessário mais cadastrar o mesmo parâmetro para outro relatório. Apenas fazer a sua associação ao novo relatório, como será apresentado a seguir. 

=Como apontar o modelo criado, trazendo todos os relatórios do CIGAM Report?=

&emsp; O próximo passo é fazer um cadastro desse relatório dentro do Cigam. Para isso é preciso entrar na tela de Cadastro de Relatórios conforme a imagem abaixo. 

[[Arquivo:153.jpg|750x500px|centro]]

&emsp; A tela de cadastro abrirá mostrando todos os relatórios do Cigam Report que já foram cadastrados, pressione CTRL + I para inserir um novo relatório. 
&emsp; O Código deve ser preenchido com o número desejado. No exemplo utilizado já existia o número 1, por isso o relatório terá o código 2. No nome do relatório devemos colocar o nome que irá aparecer quando o relatório for aberto. A dica é sempre usar um nome intuitivo, que seja de rápida assimilação do conteúdo do mesmo. 

[[Arquivo:153img.png|750x500px|centro]]

&emsp; Após preencher o nome do relatório, devemos definir os tamanhos da tela onde os filtros serão solicitados, e a área onde será exibida a descrição dos filtros. Isso é feito nos campos Tamanho do Controle e Tamanho do Label conforme imagem abaixo. 

[[Arquivo:154.png|750x500px|centro]]

&emsp; Arquivo Modelo: É onde está salvo o arquivo FRX que montamos no Cigam Report. 
&emsp; Será esse arquivo modelo que o Cigam irá procurar para gerar o relatório. Ele deve estar salvo em um local da rede que todos usuários que vão usar o relatório tenham acesso. 
&emsp; Arquivo Gerar: É o arquivo que será gerado pelo Cigam Report, com os dados da consulta. Costuma-se usar o mesmo que o do relatório, acrescentando apenas ao fim do mesmo a palavra “Gerado” conforme imagem abaixo. 

[[Arquivo:155.png|750x500px|centro]]

&emsp; '''IMPORTANTE:''' Para que o relatório a gerar possa ser aberto sem problemas, é preciso avaliar se os usuários possuem permissões de modificar o arquivo no caminho onde ele é gerado. Para alguns casos é preciso dar permissões de modificações na rede, caso contrário, o CIGAM Report poderá apresentar erro em tela 

=Como indicar filtros para o modelo indicado?=

&emsp; Após informar o nome do relatório será informado os filtros dele. Clique no botão Filtros conforme mostra a figura abaixo. 

[[Arquivo:156.png|750x500px|centro]]

&emsp; Ao entrar na tela de filtros, pressione CTRL + I para inserir um novo filtro. Com o cursor parado em cima do campo Parâmetro Filtro, pressione F5 para abrir as opções de filtros já cadastrados anteriormente, no cadastro de parâmetros. 

[[Arquivo:157.png|750x500px|centro]]

&emsp; Posicione o cursor sobre o parâmetro Empresa já cadastrado e pressione <ENTER>. 

[[Arquivo:158.png|750x500px|centro]]

&emsp; De volta a tela de cadastro de filtros tem as seguintes opções: 
&emsp; '''Ordem Exibição''' – Mostra a posição do parâmetro na tela. No caso de existirem 2 ou mais filtros, a partir da ordem de exibição se escolhe a ordem que eles aparecerão na tela. 
&emsp; '''Faixa''' - Indica que o filtro será com início e fim (intervalo). Nesse caso o nome do parâmetro de integração será duplo sendo composto da seguinte forma como exemplo: p_empresa_inicial e p_empresa_final. 
&emsp; '''Obrigatório''' – Serve para tornar obrigatório ou não o preenchimento desse campo na tela de parâmetros. Caso esteja marcado, não permitirá gerar o relatório sem informar algum valor no campo. 
&emsp; '''Intervalo''' - Indica se deve disponibilizar o intervalo final no filtro. Caso estiver selecionado “Faixa” e não estiver selecionado o Intervalo, será submetido o dado inicial e final porém somente o inicial é solicitado. Essa opção é útil quando se deseja filtrar um valor específico único (sem faixa) podendo-se também deixar em branco para abranger todos os registros (atual comportamento dos programas de filtros de relatórios). 
&emsp; '''Aleatório''' – utilizado para informar de forma aleatória os dados a serem filtrados. * Vale ressaltar que este tipo de parâmetro será utilizado na query do Report com o uso do comando “in”. Ex.: Select * from geempres e where e.cd_empresa in (@p_aleatorio). 
&emsp; Agora é importante notar que de acordo com o que se seleciona como Faixa e Intervalo, muda o nome do parâmetro de integração que fica visível no final da tela conforme imagem abaixo. 

[[Arquivo:159.png|750x500px|centro]]

&emsp; O parâmetro criado é o p_empresa. Como escolhido um intervalo, o Cigam já cria o parâmetro inicial e o final. O nome nesse caso ficará como p_empresa_inicial e p_empresa_final. É muito importante observar isso. Porque esses parâmetros serão informados dentro do Cigam Report, e informados na consulta SQL que foi montada. 
&emsp; '''IMPORTANTE:''' Ter atenção de como os filtros são criados é extremamente importante, pois o CIGAM Report é Case Sensitive. O parâmetro informado na consulta não estando da mesma maneira que o apresentado na tela de filtros, fará com que o relatório não seja aberto, irá apresentar uma tela que está acessando os dados, porém não abrirá nada em tela. 

=Como indicar os parâmetros do CIGAM Report na consulta SQL?=

&emsp; Para que os parâmetros sejam apontados na consulta, é preciso que o modelo seja aberto no Cigam Report, clique na fonte de dados com o botão direito e escolha a opção editar. 

[[Arquivo:160.jpg|750x500px|centro]]

&emsp; Na tela que abrir clique no botão seguinte. 

[[Arquivo:161.jpg|750x500px|centro]]

&emsp; Na tela seguinte irá aparecer com a consulta SQL, e nessa será incluída os parâmetros. 

[[Arquivo:162.jpg|750x500px|centro]]

&emsp; Agora será necessário alterar essa consulta SQL, inserindo nela os filtros que serão utilizados na tela do Cigam, para gerar o relatório. 

[[Arquivo:163.jpg|750x500px|centro]]

&emsp; Os filtros são cláusulas de restrição. Então é necessário inserir um WHERE na nossa consulta SQL. Como se escolheu informar um Intervalo de dados, no SQL se precisa colocar o comando BETWEEN e o parâmetro inicial e final, sendo :p_empresa_inicial e :p_empresa_final respectivamente. 

&emsp; Uma observação importante: 
* uso dos dois pontos (:) desse exemplo deve-se ao fato de estar usando um banco ORACLE. No caso de bancos MSSQL usa-se @. Dessa forma fica assim:
:: ORACLE :p_empresa_inicial 
:: MSSQL @p_empresa_final 

&emsp; Após a inclusão do comando SQL, clique no botão seguinte. A tela seguinte será preciso cadastrar dentro do Cigam Report os parâmetros. É necessário informar os dados de cada um dos parâmetros. No caso desse exemplo são dois, o inicial e final. 

[[Arquivo:164.jpg|750x500px|centro]]

&emsp; É necessário informar sempre: 
* '''Name:''' É o nome do parâmetro. 
* ''' DataType:''' é o tipo de data do parâmetro. Nesse exemplo é um VarChar. 
* ''' DefaultValue:''' Valor padrão, nesse caso foi informado zero. 
* ''' Size:''' é o tamanho do campo. 
&emsp; Em caso de dúvidas, essas informações aparecem na tela do Cigam quando foi cadastrado o parâmetro. 

[[Arquivo:165.png|750x500px|centro]]

&emsp; Após terminar de cadastrar os parâmetros clique no botão seguinte. Apresentará a tela conforme imagem abaixo, nessa basta clicar no botão terminar. 

[[Arquivo:166.jpg|750x500px|centro]]

&emsp; Retornando a tela do layout o modelo deverá ser salvo para que seja armazenado com os parâmetros incluídos. 
&emsp; Agora, de volta ao Cigam, pode se verificar como ficará a tela de filtros. Para isso, clique no botão Executar. 

[[Arquivo:167.png|750x500px|centro]]

&emsp; Ao clicar no botão executar abrirá uma janela, que será a tela de filtros do relatório. Observe que o nome cadastrado anteriormente aparece na parte superior da tela. O filtro criado, de empresa, aparece com um intervalo, onde deve ser informado valor inicial e final, conforme cadastrado na tela de filtros. 

[[Arquivo:168.png|750x500px|centro]]

&emsp; Com o cursor posicionado em cima do campo empresa tecle F5, para isso o ambiente deverá que estar parametrizado conforme o capitulo inicial do documento. Ao clicar o F5 abre uma tela de zoom, onde é possível fazer o filtro específico, encontrar o cliente/fornecedor desejado para efetuar a pesquisa. Como na definição dos parâmetros foi deixado o campo de empresa não sendo obrigatório, podemos escolher informar ou não o código da empresa para gerar o relatório. 
&emsp; Então agora se pode testar como fica a integração entre o Cigam e o Cigam Report. Cabe ressaltar, que o usuário final, ao rodar o relatório, somente irá enxergar essa tela de filtros e o relatório pronto. Toda a parte de desenvolvimento do relatório será “transparente” para ele. No exemplo abaixo será deixado primeiramente o filtro em branco. 

[[Arquivo:169.jpg|500x250px|centro]]

&emsp; O relatório é gerado com todos os dados disponíveis na base de dados. 

[[Arquivo:170.jpg|750x500px|centro]]

&emsp; Agora será gerado o relatório novamente utilizando o filtro. 

[[Arquivo:171.jpg|500x250px|centro]]

&emsp; Utilizando o filtro dessa forma, o relatório retorna apenas os itens dentro da faixa informada. 

[[Arquivo:172.png|750x500px|centro]]

&emsp; Com o modelo de relatório apontado, filtros criados e parâmetros indicados na consulta SQL, será preciso apontar o relatório ao Menu Cigam para utilização dos usuários finais. 

=Como realizar exportação direta para ferramentas como PDF, EXCEL, WORD pelo CIGAM Report?=

&emsp; A partir das ultimas verões o CIGAM Report.ecf, passa a permitir a exportação dos dados diretamente para as ferramentas de extensão PDF, RTF, HTML, MHT, XML, XLSX, PPTX, ODS, CSV, DBF e JPG. Essa opção não abrirá o preview do report mas sim a ferramenta cuja a extensão que foi informada junto ao campo Arquivo Exportar. 
&emsp; Para utilizar essa opção na tela de cadastro dos relatórios CIGAM Report no campo Exportação selecione a extensão requerida, como apresenta a imagem a abaixo. Ao selecionar a extensão o checkbox e o campo Arquivo Exportar serão habilitados. 

[[Arquivo:173.png|500x250px|centro]]

&emsp; No campo Arquivo Exportar é informado o caminho seguido do nome do arquivo e a extensão, exemplo: C:\Temp\Teste.pdf. Somente com o preenchimento desse campo será criada a exportação e caso marcando o checkbox a abertura do mesmo. 
&emsp; Para a abertura do arquivo na extensão requerida o checkbox Abrir ao Concluir deve ser marcado. Após a exportação a abertura será na respectiva extensão/ferramenta disponível no Windows. Não marcando o checkbox, será somente exportando e não será aberta nenhuma tela de visualização do relatório. 
&emsp; '''IMPORTANTE:''' no campo Arquivo Exportação é obrigatória a informação da extensão, mesmo que essa foi selecionada no campo Exportação. Pois o campo exportação é informativo e como chave de liberação dos campos. Informado o caminho\arquivo.extensão essa validação será feita pelo próprio Windows para a exportação e abertura do arquivo na ferramenta apropriada. 

=Como cadastrar Nomes Logicos e Conexões?=

&emsp; Para auxiliar no desenvolvimento dos relatórios customizados, além de melhorias na performance para apresentar as informações pretendidas, há a opção de cadastrar os Nomes Lógicos a serem utilizadas, no exemplo abaixo, as tabelas que o relatório irá utilizar assim como eventuais customizações que serão utilizadas, conforme apresenta a imagem a seguir. 

[[Arquivo:174.png|750x500px|centro]]

&emsp; Para uso basta clicar no botão Nomes-Lógicos, pressionar CRTL+I, e sobre o campo nome logico pressionar F5, onde irá apresentar todos os Nomes Lógicos inclusive de projetos customizados. Após cadastrado, no relatório basta informar o parâmetro submetido. 
&emsp; O uso do botão Conexões é utilizado para cadastrar as conexões com o banco de dados após o cadastro realizado dentro do relatório customizado em Report. Cada conexão possui um nome, como ilustra a imagem abaixo, e esse nome após é informado no cadastro das conexões e direcionado para outro banco de dados pretendido. 

[[Arquivo:175.png|750x500px|centro]]

&emsp; Para realizar a criação da conexão é preciso preencher o Nome da Conexão conforme é apresentado no relatório, como ilustra a imagem anterior. A Ordem que as conexões serão realizadas, o Tipo da conexão (Automatica ou Especifica) e qual Provider será utilizada essa opção irá variar entre banco de dados Oracle e Mssql. 
&emsp; Os dois tipos de conexão que apresenta significa que Automático irá buscar as conexões do banco já utilizado pelo Cigam e Especifica deverá ser manualmente informado a string de conexão pretendida. Como demonstra a figura seguinte. 

[[Arquivo:176.png|750x500px|centro]]

&emsp; Após criada a conexão há a opção de criar eventos, o opção existe para caso o relatórios customizado precise realizar alguma ação após de gerado. Exemplo, emissão de Nota Fiscal customizado, após de impresso precisa setar o campo como impresso. 
&emsp; Para realizar esse cadastro dentro da telaro de conexão há o botão Evento, clicando sobre o botão será apresenta a tela conforme ilustra a imagem a seguir. No campo Tipo selecionar a opção de executar a ação antes ou depois de gerar o relatório. No campo Ordem a sequencia de execução. No campo Instrução SQL informar o comando a ser executado e caso for uma procedure a ser executado marcar o checkbox Procedure. 

[[Arquivo:177.png|750x500px|centro]]

&emsp; O cadastro do evento não precisa ser acrescentado ao relatório CIGAM Report.

=Como cadastrar Zoom dos campos CIGAM Report?=
&emsp; Ao realizar a preparação do ambiente para atender o CIGAM Report, como descrito nos capítulos iniciais é executado o scripts que os programas de zoom. Essa opção permite na tela de filtros pressionar F5 e selecionar a opção desejada para executar o relatório. 
&emsp; Os scripts carregam os programas de pesquisa para os campos até o momento mapeados, não significa que para todos os campos se tenha o programa de pesquisa criado, visto que o mesmo precisa existir no Cigam para que possa ser linkado. 
&emsp; O mesmo link dos campos com programas pode ser feito manualmente, principalmente de campo ainda não mapeadas e disponibilizados para serem atualizados. Ou de tabelas customizadas, módulos terceiros ou parceiros desenvolvedores. Ou caso se tenha a necessidade de apontar para outro programa fora do padrão disponibilizado. 
&emsp; Para realizar o cadastro basta ter em mãos o números do Programa de pesquisa e informa-lo no campo Nome Publico Programa. Como ilustrado a seguir. 

[[Arquivo:178.png|750x500px|centro]]

&emsp; O campo Posição Retorno por padrão vem apontado como 1 ou seja, após selecionar o dado o retorno para a tela de filtro será o código. Sendo necessário a descrição do dado a opção deve ser alterada para 2. Mas isso deve está ajustado internamente no programa Cigam e não há opção de ajustes. Eventual necessidade de mudança deve ser avaliado via desenvolvimento a possibilidade de ajuste. 
&emsp; Para alguns programas há disponíveis retornos 3, 4 e demais, mas isso não é regra para todos. E somente avaliando para ver o que os demais retornos retornam pois como a definição ocorre no desenvolvimento do programa. Como regra utiliza-se as opção 1 – Codigo e 2 – Descrição. 

=Como cadastrar Zoom para tabelas customizadas CIGAM Report?=

&emsp; Para tabelas customizadas para o cadastro de zoom funcionar deve ser informado no campo Nome Publico do Programa o programa customizado e no campo Componente, o caminho onde se encontra o projeto da customização. A tabela irá apresentar a sua formatação em negrito, se destacando dos demais para diferenciar das tabelas do ERP Cigam, como demonstra a figura abaixo. 

[[Arquivo:179.png|750x500px|centro]]

&emsp; É importante relatar que além do projeto customizado, tabelas, existem os nomes lógicos, conectores necessários para o correto funcionando do projeto customizado e consequentemente o cadastro de zoom também. Na falta de algum dos arquivos citados, o padão é buscar do projeto Cigam (CGGeral). 
&emsp; Outra opção é realizar o cadastro de zoom para uma customização da tabela do ERP Cigam. Para isso basta selecionar a tabela e campos e preencher os campos para buscar o projeto da customização, módulos terceiros ou parceiros desenvolvedores. Da mesma forma que ocorre para a tabela terceira para a tabela do ERP Cigam também irá apresentar em negrito demostrando que essa possui outro projeto linkado, como demonstra a ilustração a seguir. 

[[Arquivo:180.png|750x500px|centro]]

&emsp; Dessa forma há como facilitar ao usuário a seleção dos dados para filtrar as informações se seu relatório customizado. 

=Como disponibilizar o Relatório CIGAM Report no Menu Cigam?=

&emsp; Para cadastrar um atalho do relatório no Menu do CIGAM, basta posicionar no local desejado e executar a “Tecla Fácil CIGAM” (com atalho pelo F10) e na tela clicar em “Nova Opção de Menu, como ilustra a figura abaixo. 

[[Arquivo:181.png|500x250px|centro]]

&emsp; Na tela seguinte selecionar “Relatório CIGAM Report” como tipo de opção de menu. 

[[Arquivo:182.png|500x250px|centro]]

&emsp; Após a seleção, automaticamente os campos com as informações da chamada da aplicação do CIGAM Report e os programas necessários são preenchidos e bloqueados para modificação. Deve-se apenas informar uma descrição para o relatório e a chave do programa que será o número do relatório cadastrado. 

[[Arquivo:183.png|500x250px|centro]]

&emsp; No campo Chave do Programa está disponível o zoom no campo para selecionar o relatório requerido, esse apresenta a tela de cadastro dos relatórios, conforme figura abaixo. 

[[Arquivo:184.png|750x500px|centro]]

&emsp; Após clicar em confirmar será aberta uma tela onde devem ser informados quais usuários devem ter acesso ao relatório. Pode-se escolher entre as opções de apenas o usuário que está cadastrando, escolher um usuário específico da lista que aparece, um grupo de usuários ou todos os usuários. Nesse exemplo foi escolhida a opção Todos os Usuários. 

[[Arquivo:185.jpg|750x500px|centro]]

&emsp; Após o cadastro a opção ficará disponível para execução o relatório por dentro do Menu do Cigam, como ilustra a imagem abaixo. 
[[Arquivo:186.png|500x250px|centro]]

&emsp; Por meio desse ajuste o relatório está integrado ao Menu Cigam dentro do módulo correspondente. 

=Como ativar modo DEBUG no CIGAM Report?=

&emsp; A funcionalidade foi criada para facilitar a visualização dos dados da integração entre o CIGAM e o CIGAM Report. Para ativá-la, basta setar o nome-lógico DEBUG_CIGAM REPORT com “S”. Cabe lembrar que esta opção somente deverá ser ativada quando da necessidade de depuração para procurar e ou verificar erros. 

[[Arquivo:200.png|750x500px|centro]]

&emsp; Ao executar o cadastro do relatório, a atividade da funcionalidade pode ser identificada no título da janela, conforme ilustra a imagem abaixo.

[[Arquivo:201.png|750x500px|centro]]

&emsp; Ao executar o relatório (pelo botão “Executar” ou pela integração com o menu do CIGAM) será exibida uma mensagem, figura abaixo, com a linha de comando que será executada. 

[[Arquivo:202.png|750x500px|centro]]

&emsp; O conteúdo dessa mensagem pode ser obtido em formato texto através de um CTRL+C sob a mensagem em exibição. O resultado será o seguinte: 
--------------------------- 
Atenção 
--------------------------- 
Linha de comando: 
H:\CIGAM10\PROJECTS\CIGAM\CIGAM Report.exe -G: -M:f:\Teste_data.frx -A:f:\Teste_data_xx.frx -P::p_data='08/11/2009' 
--------------------------- 
OK 

&emsp; Após a exibição da linha de comando é possível escolher se deseja submeter (executar a geração do relatório) no executável do CIGAM Report instalado (também aparece o caminho completo do arquivo o qual deverá existir). 

[[Arquivo:203.png|750x500px|centro]]

&emsp; Após realizar as verificações o nome lógico, deve ser alterado para ‘N’, pois senão as telas irão ser apresentadas aos usuários que utilizarão o relatório, cada vez que for utilizando, podendo trazer descontentamento ao cliente por ter tantas telas para confirmar. 
&emsp; Com meio dessas instruções que se realiza a integração do Cigam Report com o Cigam. Podendo criar relatórios conforme necessidade sem o envolvimento do setor de desenvolvimento, agilizando dessa forma a solicitação do cliente. 

'''Mais duvidas consultar'''
[[FAQ GE|FAQ GE|CGReport]]

GE - Como Fazer - CIGAM Report

2025-10-23T19:20:50Z

Alessandro.voto: /* O que parametrizar no ambiente Windows, quanto ao CIGAM Report? */

{{VoltarPagina}}
 
[[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 - CIGAM Report|CIGAM Report]]

=CIGAM Report=
&emsp; Uma ferramenta originária do Fast Report, que adquirido o código fonte, foi adaptado as necessidade do ERP CIGAM em criação de relatórios customizados. Extraindo do CIGAM as informações necessárias através da utilização de comandos SQL’S. A ferramenta pode ser utilizada por clientes que usam o banco de dados Oracle ou MS-SQL, e a versão do CIGAM e10. 

&emsp; O documento irá descrever/apresentar como parametrizar as plataformas Windows 32 e 64 bits, para o correto funcionamento do CIGAM Report. Descreve como integrar os relatórios criados ao sistema CIGAM. E de forma básica descreve a criação dos relatórios, mas verifique o [[Arquivo:Como Fazer - CIGAM Report Avançado.pdf]] para informações mais detalhadas.

=O que parametrizar no ambiente Windows, quanto ao CIGAM Report?=

&emsp; Para se certificar quais instalações serão precisas a primeira coisa a fazer é se certificar que o executável do CIGAM Report está abrindo corretamente sem apresentar erros. 

&emsp; Caso não seja aberta a aplicação, verifique se os seguintes arquivos constam na pasta de instalação do CIGAM: 
Cigam.Utils.dll 
FastReport.Bars.dll 
FastReport.dll 
FastReport.Editor.dll 

&emsp; Para executa-lo acesse o %CIGAM_INSTAL%CGReport.exe. Em caso de erros avaliar a instalação do .Net framework e suas permissões, dúvidas sobre a instalação verificar o documento [[GE_-_Como_Fazer_-_Instalação_do_.Net|‘COMO FAZER - Instalação do .Net nos clientes’.]]

=Quais os fundamentos do CIGAM Report?=

&emsp; O CIGAM REPORT, e um gerador de relatórios direto a banco sem a necessidade de programação e ou desenvolvimento de novos programas no CIGAM via Magic. Suas principais funcionalidades são: 

* Possibilitar a criação de relatórios sem que seja necessário passar pelo desenvolvimento do CIGAM; 
* Todo o desenvolvimento bem como a implantação será feita no cliente de maneira rápida e simples, e; 
* Pode se definir o modelo do relatório diretamente sem que seja necessário disponibilizar variáveis para uma futura implementação ou adição de informações. 

&emsp; Informações detalhadas sobre as funcionalidades do Cigam Report, relevantes para a criação de relatórios verificar o [[Arquivo:Como Fazer - CIGAM Report Avançado.pdf]]

=Como criar o relatório de consulta direta a banco via CIGAM Report?=

&emsp; Ao abrir o CIGAM Report pela primeira vez, caso o idioma esteja em inglês ou outro qualquer que não o português, você pode alterá-lo fazendo o seguinte procedimento: 
&emsp; Clicar em File – Select Language conforme a imagem abaixo: 

[[Arquivo:Imagem100.png|750x500px|centro]]

&emsp; Na janela que irá abrir, clique em portuguese-brasil e em seguida em OK. 

[[Arquivo:Imagem101.png|750x500px|centro]]

&emsp; Ao abrir o Cigam Report devemos selecionar a opção: Arquivo – Novo, irá aparecer a seguinte tela abaixo. 

[[Arquivo:Imagem102.png|750x500px|centro]]

&emsp; A opção relatório em branco deve ser selecionada e clique em adicionar. Com isso será aberto um formulário de relatório padrão conforme imagem abaixo. 

[[Arquivo:Imagem103.png|750x500px|centro]]

&emsp; Agora é necessário informar qual será a fonte de dados do relatório. Isto pode ser feito de duas maneiras: 

* Escolher uma das fontes de dados que foram registradas no relatório através de um método de programação. Isto pode ser feito no menu Dados > Escolher Dados do Relatório, e marcando as fontes de dados necessárias. 
*Uma nova fonte de dados pode ser criada no menu Dados > Adicionar Fonte de Dados. 

&emsp; Após a inclusão da fonte de dados, esta irá aparecer na janela Dados. Agora a mesma pode ser utilizada no relatório. Não é obrigatório que o relatório se conecte somente a uma fonte de dados, permitindo que mais destas sejam adicionadas em um mesmo relatório. 
&emsp; No exemplo para demonstração será a opção Dados – Adicionar Fonte de Dados, conforme apresenta a imagem a seguir. 

[[Arquivo:Imagem104.png|750x500px|centro]]

&emsp; A primeira vez que for conectar com o Banco de Dados será necessário criar uma Nova Ligação. 

[[Arquivo:Imagem105.png|750x500px|centro]]

&emsp; O tipo de ligação deve ficar como Ligação OLE DB. Depois de alterar clicar em Gerar. 

[[Arquivo:Img106.png|750x500px|centro]]

&emsp; Ao clicar em gerar, aparecerá a tela abaixo, onde temos algumas informações importantes a serem observadas. 

[[Arquivo:Img107.png|750x500px|centro]]

&emsp; Nessa tela teve se escolha o provedor de acordo com o banco de dados. Para o banco de dados Oracle pode se utilizar o MICROSOFT OLE DB PROVIDER FOR ORACLE ou o recomendado ORACLE PROVIDER FOR OLE DB. 
&emsp; Para o banco de dados SQL Server se utiliza o MICROSOFT OLE PROVIDER FOR SQL SERVER. Após escolher o provedor de dados correto clique em gerar. 

[[Arquivo:Img108.png|750x500px|centro]]

&emsp; Os campos com o nome do servidor, nome de usuário e senha devem ser informados e a opção de permitir salvamento de senha marcada, para não precisar informar a mesma senha todas as vezes que for executar o relatório. Após informar os campos clique em Testar a Conexão. 

[[Arquivo:Img109.png|750x500px|centro]]

&emsp; Se o teste de conexão for concluído com êxito, clique em OK para continuar a configuração. Caso não tenha tido sucesso no teste de conexão, confira os dados de servidor, usuário e senha e tente novamente. 
&emsp; Problemas de não encontrar o provider do Oracle padrão, revise o capítulo 1 do presente manual para que possas seguir com o padrão solicitado. 
&emsp;Na tela de assistente de dados conforme imagem abaixo clique no botão seguinte. 

[[Arquivo:Img110.png|750x500px|centro]]

=Como acessar uma Tabela no CIGAM Report?=

&emsp; Na próxima tela, há duas opções, onde se pode escolher uma tabela do banco de dados para buscar depois os campos desejados, ou podemos escolher inserir uma consulta em SQL diretamente através do botão Adicionar consulta SQL. 

[[Arquivo:Img111.png|750x500px|centro]]

&emsp; Nesse exemplo, será escolhida a opção de selecionar uma tabela inteira, no caso, a tabela de cadastro de empresas. Após selecionada a tabela, é só clicar no botão terminar. Ao fazer isso, o programa voltará para a tela inicial, mas no canto superior direito aparecerá a nova fonte de dados. Nesse caso aparece a tabela de cadastro de empresas, GEEMPRES, e abaixo dela todos os seus campos, conforme figura abaixo. 

[[Arquivo:Img112.jpg|750x500px|centro]]

&emsp; Clicando nos campos da tabela GEEMPRES que aparecem a direita e arrastando podemos colocá-los no layout do relatório. Os campos devem ser colocados na parte de dados do relatório, conforme exemplo abaixo. 

[[Arquivo:113.png|750x500px|centro]]

&emsp; Ao soltar os campos nos dados, o Cigam Report insere automaticamente o nome do campo no cabeçalho de página. Esse nome é o próprio nome do campo na tabela. Ele pode ser alterado de acordo com a necessidade do relatório. Existem duas formas de se fazer isso: 
&emsp; Dando um duplo clique em cima do mesmo. Assim abrirá uma janela de editar texto onde basta alterar o texto. 
&emsp; Pode-se também alterar o TEXT de dados que aparece ao lado direito da tela, conforme a figura abaixo. 

[[Arquivo:115.jpg|750x500px|centro]]

&emsp; Após de alterado pode se ver um preview de como ficará o relatório. Para isso basta clicar no botão de visualizar que aparece no canto superior esquerdo da tela conforme a figura abaixo. 

[[Arquivo:116.jpg|750x500px|centro]]

&emsp; Ao clicar na opção, a consulta será gerada na base de dados e retornará a tela conforme a figura a seguir, mostrando como os dados estão formatados para apresentação. 

[[Arquivo:117.png|750x500px|centro|177]]

&emsp; Para fechar a visualização do preview basta clicar em fechar. Com isso volta a tela inicial de configuração do layout do relatório. 

=Como acessar Múltiplas Tabelas do CIGAM Report?=

&emsp; Para fazer uma consulta no Cigam Report utilizando um relacionamento entre 2 ou mais tabelas deve ser feito seguindo os seguintes passos: 
&emsp; Selecionar um novo relatório em branco, e clicar em adicionar fonte de dados. 

[[Arquivo:118.png|750x500px|centro]]

&emsp; Na tela que aparece é onde deve ser configurada a conexão com o banco de dados, conforme demonstrado na seção anterior do presente documento, tendo o banco já configurado, basta clicar no botão seguinte, como apresenta a imagem abaixo. 

[[Arquivo:119.png|750x500px|centro]]

&emsp; Nesse exemplo, será selecionado duas tabelas relacionadas. A ESMATERI que tem o Cadastro de Materiais e a PEENGENH que é a da Engenharia. Na tela que abre, selecione as duas tabelas e clique em terminar. 

[[Arquivo:120.png|750x500px|centro]]

&emsp; '''Nas fontes de dados a direita da tela será apresentada as duas tabelas selecionadas.'''

[[Arquivo:121.png|750x500px|centro]]

&emsp; Agora é necessário criar o relacionamento entre as duas tabelas. Para isso deve-se clicar em: Ações / Nova Relação 

[[Arquivo:122.png|750x500px|centro]]

&emsp; Na tela que se abre deverá ser informado a tabela mãe e a tabela filha, e por qual campo elas se relacionam, conforme a imagem abaixo exemplifica. 

[[Arquivo:123.png|750x500px|centro]]

&emsp; Após de realizar o relacionamento clicar em OK. Agora a direita na fonte de dados já aparecem as duas tabelas e com o relacionamento entre elas. No exemplo abaixo está se buscando o código do material da tabela da Engenharia e a descrição do cadastro de materiais. 

[[Arquivo:124.png|750x500px|centro]]

&emsp; Ao gerar o relatório é possível ver a informação de código de material e descrição. 

[[Arquivo:125.png|750x500px|centro]]

=Como acessar múltiplas tabelas via comandos SQL?=
&emsp; Além de fazer a consulta relacionando tabelas da forma como descrito na seção anterior, também é possível acessar múltiplas tabelas através de uma instrução SQL (script).Com a instrução SQL é possível adicionar somente os campos que temos interesse e já fazer a relação entre tabelas diretamente nele. 
&emsp; Para criar uma fonte de dados baseado em uma instrução SQL é preciso clicar em Dados / Adicionar Fonte de Dados, como a configuração com o banco de dados já deve estar pronta, basta clicar no botão seguinte na tela que a figura abaixo ilustra. 

[[Arquivo:126.png|750x500px|centro]]

&emsp; O Cigam Report vai carregar as tabelas, mas em vez de selecioná-las na lista, cliquei no botão Adicionar Consulta Sql. 

[[Arquivo:127.png|750x500px|centro]]

&emsp; Será aberta a janela onde podemos dar um nome para essa instrução, ou simplesmente deixar o nome sugerido e clique em Seguinte. 

[[Arquivo:128.png|750x500px|centro]]

&emsp; Na tela seguinte conforme imagem abaixo se coloca a instrução SQL desenvolvida e basta clicar no botão seguinte. 

[[Arquivo:129.png|750x500px|centro]]

&emsp; Por hora, vamos passar direto pela próxima tela, que é a de parâmetros e apenas clique no botão seguinte. 

[[Arquivo:130.png|750x500px|centro]]

&emsp; Na tela seguinte clique no botão terminar, depois se retornará a essa tela para inclusão dos parâmetros. 

[[Arquivo:131.png|750x500px|centro]]

&emsp; No final da tela de tabelas irá aparecer o nome da consulta criada via SQL conforme imagem abaixo e bastar clicar no botão terminar. 

[[Arquivo:132.png|750x500px|centro]]

&emsp; A partir de então, a instrução SQL que foi utilizada já aparece como uma conexão a base de dados. Os campos poderão ser inseridos no relatório como os da tabela. 

[[Arquivo:133.png|750x500px|centro]]

&emsp; '''Os campos podem ser inseridos na tela do relatório conforme imagem abaixo. '''

[[Arquivo:134.png|750x500px|centro]]

&emsp; Outras informações comuns em relatórios como pagina, data, podem ser inseridas. Essas são demonstradas na figura abaixo. 

[[Arquivo:136.jpg|750x500px|centro]]

&emsp; Na banda de título de relatório (1) se pode inserir algumas variáveis de sistema (2) que estão disponíveis ao lado direito da tela, logo abaixo da fonte de dados. Nesse exemplo será inserida a data e o número de página. O processo para inserir as variáveis é o mesmo que com os campos da tabela. Basta clicar em cima da variável e arrastá-la para o local desejado e soltá-la. 

[[Arquivo:137.jpg|750x500px|centro]]

&emsp; Ao clicar no opção de preview do layout, já será visto o relatório com as variáveis adicionadas nele. 

[[Arquivo:138.png|750x500px|centro]]

&emsp; Também é possível inserir uma figura com o logo da empresa para ser o cabeçalho do relatório como mostrado a figura abaixo. 

[[Arquivo:139.jpg|750x500px|centro]]

&emsp; Para incluir deve se clicar no botão figura e arraste a imagem para o local digitado. Após isso, clique com o botão direito sobre a imagem e escolha a opção editar. 

[[Arquivo:140.png|750x500px|centro]]

&emsp; Ao selecionar a opção irá abrir a tela abaixo. Se escolher a opção Imagem / Abrir. 

[[Arquivo:141.png|750x500px|centro]]

&emsp; Após seleciona uma imagem de uma pasta qualquer dentro do computador. 

[[Arquivo:142.png|750x500px|centro]]

&emsp; Após selecionar a imagem, basta clicar em abrir que será apresentada para o layout do relatório. Quando a imagem já estiver no layout, basta ajustá-la com o tamanho desejado. 

[[Arquivo:143.png|750x500px|centro]]

&emsp; Com isso, ao gerar novamente o preview do relatório, a imagem será apresentada em tela. 

[[Arquivo:144.png|750x500px|centro]]

&emsp; Essas são as formas de criar o relatório pelo CIGAM Report, para realizar a integração do mesmo ao Cigam, será preciso criar os parâmetros/filtros e ajustá-los a consulta, no qual o capítulo seguinte irá apresentar. 

=Integração do relatório CIGAM Report ao Cigam=

&emsp; Com o modelo criado pelo CIGAM Report, para ser utilizado como opção de Menu no Cigam deverá seguir algumas configurações que seguem abaixo. 

=Como utilizar e criar parâmetros, através do CIGAM Report?=

&emsp; Para demonstrar a inserção dos parâmetros será utilizado o exemplo do relatório que lista o nome das empresas. No Cigam Report ele está montado da seguinte maneira. 

[[Arquivo:145.jpg|750x500px|centro]]

&emsp; O relatório gerado se apresenta conforme a imagem abaixo 

[[Arquivo:146.jpg|750x500px|centro]]

&emsp; Para a integração será criada uma tela de filtros para esse relatório dentro do Cigam, o filtro será pelo código da empresa. Para isso será necessário criar um parâmetro que receberá o valor digitado na tela e repassará o valor do mesmo para o Cigam Report. Para fazer isso, deve-se clicar em Parâmetros de Filtros no menu Cigam 

[[Arquivo:147.jpg|750x500px|centro]]

&emsp; Ao acessar no menu do Cigam a opção Parâmetros de Filtros, com o ambiente corretamente configurado irá apresentar alguns parâmetros para serem utilizados, porem não impede que seja criado novos de acordo com a necessidade. Para cadastrar um novo filtro devemos pressionar CTRL + I. 

[[Arquivo:148.jpg|750x500px|centro]]

&emsp; No campo do código se insere o código requerido, ou se permanece com a sugestão do sistema. No campo Nome do Parâmetro se coloca um nome que se deseja para o mesmo. Em Tabela, pressione F5 para abrir a lista de tabelas. 

[[Arquivo:149.jpg|750x500px|centro]]

&emsp; No exemplo criado será utilizado tabela EMPRESA. No campo coluna será selecionado o campo da tabela EMPRESA, onde fica o código do cliente que servirá como filtro. 

[[Arquivo:150.jpg|750x500px|centro]]

&emsp; Em tamanho do controle se informa o tamanho do campo na tela para receber os dados que serão digitados nesse parâmetro. Como o campo de empresa tem 8 dígitos, vamos informar o mesmo valor. Em Nome do Parâmetro para Integração vamos informar o nome do parâmetro que será usado dentro de nossa consulta SQL. É bom sempre usar um nome intuitivo para facilitar o entendimento. Nesse caso se usará o parâmetro como P_Empresa. 

[[Arquivo:151.jpg|750x500px|centro]]

&emsp; Os detalhes do parâmetro que aparecem na parte de baixo da tela são preenchidos automaticamente pelo Cigam, e com todos os campos informados, basta salvar o novo parâmetro. 
&emsp; Como apresentado no inicio da apostila a opção de cadastro de tabelas oriundas de customizações, módulos terceiros ou parceiros desenvolvedores, após devidamente cadastrada a mesma já está visível para realizar o cadastro de parâmetros. Segue o mesmo processo como descrito anteriormente, como a ilustração a seguir apresenta: 

[[Arquivo:152.png|750x500px|centro]]

&emsp; '''IMPORTANTE:''' O parâmetro cadastrado aqui pode ser usado inúmeras vezes, para diversos relatórios posteriormente. Não é necessário mais cadastrar o mesmo parâmetro para outro relatório. Apenas fazer a sua associação ao novo relatório, como será apresentado a seguir. 

=Como apontar o modelo criado, trazendo todos os relatórios do CIGAM Report?=

&emsp; O próximo passo é fazer um cadastro desse relatório dentro do Cigam. Para isso é preciso entrar na tela de Cadastro de Relatórios conforme a imagem abaixo. 

[[Arquivo:153.jpg|750x500px|centro]]

&emsp; A tela de cadastro abrirá mostrando todos os relatórios do Cigam Report que já foram cadastrados, pressione CTRL + I para inserir um novo relatório. 
&emsp; O Código deve ser preenchido com o número desejado. No exemplo utilizado já existia o número 1, por isso o relatório terá o código 2. No nome do relatório devemos colocar o nome que irá aparecer quando o relatório for aberto. A dica é sempre usar um nome intuitivo, que seja de rápida assimilação do conteúdo do mesmo. 

[[Arquivo:153img.png|750x500px|centro]]

&emsp; Após preencher o nome do relatório, devemos definir os tamanhos da tela onde os filtros serão solicitados, e a área onde será exibida a descrição dos filtros. Isso é feito nos campos Tamanho do Controle e Tamanho do Label conforme imagem abaixo. 

[[Arquivo:154.png|750x500px|centro]]

&emsp; Arquivo Modelo: É onde está salvo o arquivo FRX que montamos no Cigam Report. 
&emsp; Será esse arquivo modelo que o Cigam irá procurar para gerar o relatório. Ele deve estar salvo em um local da rede que todos usuários que vão usar o relatório tenham acesso. 
&emsp; Arquivo Gerar: É o arquivo que será gerado pelo Cigam Report, com os dados da consulta. Costuma-se usar o mesmo que o do relatório, acrescentando apenas ao fim do mesmo a palavra “Gerado” conforme imagem abaixo. 

[[Arquivo:155.png|750x500px|centro]]

&emsp; '''IMPORTANTE:''' Para que o relatório a gerar possa ser aberto sem problemas, é preciso avaliar se os usuários possuem permissões de modificar o arquivo no caminho onde ele é gerado. Para alguns casos é preciso dar permissões de modificações na rede, caso contrário, o CIGAM Report poderá apresentar erro em tela 

=Como indicar filtros para o modelo indicado?=

&emsp; Após informar o nome do relatório será informado os filtros dele. Clique no botão Filtros conforme mostra a figura abaixo. 

[[Arquivo:156.png|750x500px|centro]]

&emsp; Ao entrar na tela de filtros, pressione CTRL + I para inserir um novo filtro. Com o cursor parado em cima do campo Parâmetro Filtro, pressione F5 para abrir as opções de filtros já cadastrados anteriormente, no cadastro de parâmetros. 

[[Arquivo:157.png|750x500px|centro]]

&emsp; Posicione o cursor sobre o parâmetro Empresa já cadastrado e pressione <ENTER>. 

[[Arquivo:158.png|750x500px|centro]]

&emsp; De volta a tela de cadastro de filtros tem as seguintes opções: 
&emsp; '''Ordem Exibição''' – Mostra a posição do parâmetro na tela. No caso de existirem 2 ou mais filtros, a partir da ordem de exibição se escolhe a ordem que eles aparecerão na tela. 
&emsp; '''Faixa''' - Indica que o filtro será com início e fim (intervalo). Nesse caso o nome do parâmetro de integração será duplo sendo composto da seguinte forma como exemplo: p_empresa_inicial e p_empresa_final. 
&emsp; '''Obrigatório''' – Serve para tornar obrigatório ou não o preenchimento desse campo na tela de parâmetros. Caso esteja marcado, não permitirá gerar o relatório sem informar algum valor no campo. 
&emsp; '''Intervalo''' - Indica se deve disponibilizar o intervalo final no filtro. Caso estiver selecionado “Faixa” e não estiver selecionado o Intervalo, será submetido o dado inicial e final porém somente o inicial é solicitado. Essa opção é útil quando se deseja filtrar um valor específico único (sem faixa) podendo-se também deixar em branco para abranger todos os registros (atual comportamento dos programas de filtros de relatórios). 
&emsp; '''Aleatório''' – utilizado para informar de forma aleatória os dados a serem filtrados. * Vale ressaltar que este tipo de parâmetro será utilizado na query do Report com o uso do comando “in”. Ex.: Select * from geempres e where e.cd_empresa in (@p_aleatorio). 
&emsp; Agora é importante notar que de acordo com o que se seleciona como Faixa e Intervalo, muda o nome do parâmetro de integração que fica visível no final da tela conforme imagem abaixo. 

[[Arquivo:159.png|750x500px|centro]]

&emsp; O parâmetro criado é o p_empresa. Como escolhido um intervalo, o Cigam já cria o parâmetro inicial e o final. O nome nesse caso ficará como p_empresa_inicial e p_empresa_final. É muito importante observar isso. Porque esses parâmetros serão informados dentro do Cigam Report, e informados na consulta SQL que foi montada. 
&emsp; '''IMPORTANTE:''' Ter atenção de como os filtros são criados é extremamente importante, pois o CIGAM Report é Case Sensitive. O parâmetro informado na consulta não estando da mesma maneira que o apresentado na tela de filtros, fará com que o relatório não seja aberto, irá apresentar uma tela que está acessando os dados, porém não abrirá nada em tela. 

=Como indicar os parâmetros do CIGAM Report na consulta SQL?=

&emsp; Para que os parâmetros sejam apontados na consulta, é preciso que o modelo seja aberto no Cigam Report, clique na fonte de dados com o botão direito e escolha a opção editar. 

[[Arquivo:160.jpg|750x500px|centro]]

&emsp; Na tela que abrir clique no botão seguinte. 

[[Arquivo:161.jpg|750x500px|centro]]

&emsp; Na tela seguinte irá aparecer com a consulta SQL, e nessa será incluída os parâmetros. 

[[Arquivo:162.jpg|750x500px|centro]]

&emsp; Agora será necessário alterar essa consulta SQL, inserindo nela os filtros que serão utilizados na tela do Cigam, para gerar o relatório. 

[[Arquivo:163.jpg|750x500px|centro]]

&emsp; Os filtros são cláusulas de restrição. Então é necessário inserir um WHERE na nossa consulta SQL. Como se escolheu informar um Intervalo de dados, no SQL se precisa colocar o comando BETWEEN e o parâmetro inicial e final, sendo :p_empresa_inicial e :p_empresa_final respectivamente. 

&emsp; Uma observação importante: 
* uso dos dois pontos (:) desse exemplo deve-se ao fato de estar usando um banco ORACLE. No caso de bancos MSSQL usa-se @. Dessa forma fica assim:
:: ORACLE :p_empresa_inicial 
:: MSSQL @p_empresa_final 

&emsp; Após a inclusão do comando SQL, clique no botão seguinte. A tela seguinte será preciso cadastrar dentro do Cigam Report os parâmetros. É necessário informar os dados de cada um dos parâmetros. No caso desse exemplo são dois, o inicial e final. 

[[Arquivo:164.jpg|750x500px|centro]]

&emsp; É necessário informar sempre: 
* '''Name:''' É o nome do parâmetro. 
* ''' DataType:''' é o tipo de data do parâmetro. Nesse exemplo é um VarChar. 
* ''' DefaultValue:''' Valor padrão, nesse caso foi informado zero. 
* ''' Size:''' é o tamanho do campo. 
&emsp; Em caso de dúvidas, essas informações aparecem na tela do Cigam quando foi cadastrado o parâmetro. 

[[Arquivo:165.png|750x500px|centro]]

&emsp; Após terminar de cadastrar os parâmetros clique no botão seguinte. Apresentará a tela conforme imagem abaixo, nessa basta clicar no botão terminar. 

[[Arquivo:166.jpg|750x500px|centro]]

&emsp; Retornando a tela do layout o modelo deverá ser salvo para que seja armazenado com os parâmetros incluídos. 
&emsp; Agora, de volta ao Cigam, pode se verificar como ficará a tela de filtros. Para isso, clique no botão Executar. 

[[Arquivo:167.png|750x500px|centro]]

&emsp; Ao clicar no botão executar abrirá uma janela, que será a tela de filtros do relatório. Observe que o nome cadastrado anteriormente aparece na parte superior da tela. O filtro criado, de empresa, aparece com um intervalo, onde deve ser informado valor inicial e final, conforme cadastrado na tela de filtros. 

[[Arquivo:168.png|750x500px|centro]]

&emsp; Com o cursor posicionado em cima do campo empresa tecle F5, para isso o ambiente deverá que estar parametrizado conforme o capitulo inicial do documento. Ao clicar o F5 abre uma tela de zoom, onde é possível fazer o filtro específico, encontrar o cliente/fornecedor desejado para efetuar a pesquisa. Como na definição dos parâmetros foi deixado o campo de empresa não sendo obrigatório, podemos escolher informar ou não o código da empresa para gerar o relatório. 
&emsp; Então agora se pode testar como fica a integração entre o Cigam e o Cigam Report. Cabe ressaltar, que o usuário final, ao rodar o relatório, somente irá enxergar essa tela de filtros e o relatório pronto. Toda a parte de desenvolvimento do relatório será “transparente” para ele. No exemplo abaixo será deixado primeiramente o filtro em branco. 

[[Arquivo:169.jpg|500x250px|centro]]

&emsp; O relatório é gerado com todos os dados disponíveis na base de dados. 

[[Arquivo:170.jpg|750x500px|centro]]

&emsp; Agora será gerado o relatório novamente utilizando o filtro. 

[[Arquivo:171.jpg|500x250px|centro]]

&emsp; Utilizando o filtro dessa forma, o relatório retorna apenas os itens dentro da faixa informada. 

[[Arquivo:172.png|750x500px|centro]]

&emsp; Com o modelo de relatório apontado, filtros criados e parâmetros indicados na consulta SQL, será preciso apontar o relatório ao Menu Cigam para utilização dos usuários finais. 

=Como realizar exportação direta para ferramentas como PDF, EXCEL, WORD pelo CIGAM Report?=

&emsp; A partir das ultimas verões o CIGAM Report.ecf, passa a permitir a exportação dos dados diretamente para as ferramentas de extensão PDF, RTF, HTML, MHT, XML, XLSX, PPTX, ODS, CSV, DBF e JPG. Essa opção não abrirá o preview do report mas sim a ferramenta cuja a extensão que foi informada junto ao campo Arquivo Exportar. 
&emsp; Para utilizar essa opção na tela de cadastro dos relatórios CIGAM Report no campo Exportação selecione a extensão requerida, como apresenta a imagem a abaixo. Ao selecionar a extensão o checkbox e o campo Arquivo Exportar serão habilitados. 

[[Arquivo:173.png|500x250px|centro]]

&emsp; No campo Arquivo Exportar é informado o caminho seguido do nome do arquivo e a extensão, exemplo: C:\Temp\Teste.pdf. Somente com o preenchimento desse campo será criada a exportação e caso marcando o checkbox a abertura do mesmo. 
&emsp; Para a abertura do arquivo na extensão requerida o checkbox Abrir ao Concluir deve ser marcado. Após a exportação a abertura será na respectiva extensão/ferramenta disponível no Windows. Não marcando o checkbox, será somente exportando e não será aberta nenhuma tela de visualização do relatório. 
&emsp; '''IMPORTANTE:''' no campo Arquivo Exportação é obrigatória a informação da extensão, mesmo que essa foi selecionada no campo Exportação. Pois o campo exportação é informativo e como chave de liberação dos campos. Informado o caminho\arquivo.extensão essa validação será feita pelo próprio Windows para a exportação e abertura do arquivo na ferramenta apropriada. 

=Como cadastrar Nomes Logicos e Conexões?=

&emsp; Para auxiliar no desenvolvimento dos relatórios customizados, além de melhorias na performance para apresentar as informações pretendidas, há a opção de cadastrar os Nomes Lógicos a serem utilizadas, no exemplo abaixo, as tabelas que o relatório irá utilizar assim como eventuais customizações que serão utilizadas, conforme apresenta a imagem a seguir. 

[[Arquivo:174.png|750x500px|centro]]

&emsp; Para uso basta clicar no botão Nomes-Lógicos, pressionar CRTL+I, e sobre o campo nome logico pressionar F5, onde irá apresentar todos os Nomes Lógicos inclusive de projetos customizados. Após cadastrado, no relatório basta informar o parâmetro submetido. 
&emsp; O uso do botão Conexões é utilizado para cadastrar as conexões com o banco de dados após o cadastro realizado dentro do relatório customizado em Report. Cada conexão possui um nome, como ilustra a imagem abaixo, e esse nome após é informado no cadastro das conexões e direcionado para outro banco de dados pretendido. 

[[Arquivo:175.png|750x500px|centro]]

&emsp; Para realizar a criação da conexão é preciso preencher o Nome da Conexão conforme é apresentado no relatório, como ilustra a imagem anterior. A Ordem que as conexões serão realizadas, o Tipo da conexão (Automatica ou Especifica) e qual Provider será utilizada essa opção irá variar entre banco de dados Oracle e Mssql. 
&emsp; Os dois tipos de conexão que apresenta significa que Automático irá buscar as conexões do banco já utilizado pelo Cigam e Especifica deverá ser manualmente informado a string de conexão pretendida. Como demonstra a figura seguinte. 

[[Arquivo:176.png|750x500px|centro]]

&emsp; Após criada a conexão há a opção de criar eventos, o opção existe para caso o relatórios customizado precise realizar alguma ação após de gerado. Exemplo, emissão de Nota Fiscal customizado, após de impresso precisa setar o campo como impresso. 
&emsp; Para realizar esse cadastro dentro da telaro de conexão há o botão Evento, clicando sobre o botão será apresenta a tela conforme ilustra a imagem a seguir. No campo Tipo selecionar a opção de executar a ação antes ou depois de gerar o relatório. No campo Ordem a sequencia de execução. No campo Instrução SQL informar o comando a ser executado e caso for uma procedure a ser executado marcar o checkbox Procedure. 

[[Arquivo:177.png|750x500px|centro]]

&emsp; O cadastro do evento não precisa ser acrescentado ao relatório CIGAM Report.

=Como cadastrar Zoom dos campos CIGAM Report?=
&emsp; Ao realizar a preparação do ambiente para atender o CIGAM Report, como descrito nos capítulos iniciais é executado o scripts que os programas de zoom. Essa opção permite na tela de filtros pressionar F5 e selecionar a opção desejada para executar o relatório. 
&emsp; Os scripts carregam os programas de pesquisa para os campos até o momento mapeados, não significa que para todos os campos se tenha o programa de pesquisa criado, visto que o mesmo precisa existir no Cigam para que possa ser linkado. 
&emsp; O mesmo link dos campos com programas pode ser feito manualmente, principalmente de campo ainda não mapeadas e disponibilizados para serem atualizados. Ou de tabelas customizadas, módulos terceiros ou parceiros desenvolvedores. Ou caso se tenha a necessidade de apontar para outro programa fora do padrão disponibilizado. 
&emsp; Para realizar o cadastro basta ter em mãos o números do Programa de pesquisa e informa-lo no campo Nome Publico Programa. Como ilustrado a seguir. 

[[Arquivo:178.png|750x500px|centro]]

&emsp; O campo Posição Retorno por padrão vem apontado como 1 ou seja, após selecionar o dado o retorno para a tela de filtro será o código. Sendo necessário a descrição do dado a opção deve ser alterada para 2. Mas isso deve está ajustado internamente no programa Cigam e não há opção de ajustes. Eventual necessidade de mudança deve ser avaliado via desenvolvimento a possibilidade de ajuste. 
&emsp; Para alguns programas há disponíveis retornos 3, 4 e demais, mas isso não é regra para todos. E somente avaliando para ver o que os demais retornos retornam pois como a definição ocorre no desenvolvimento do programa. Como regra utiliza-se as opção 1 – Codigo e 2 – Descrição. 

=Como cadastrar Zoom para tabelas customizadas CIGAM Report?=

&emsp; Para tabelas customizadas para o cadastro de zoom funcionar deve ser informado no campo Nome Publico do Programa o programa customizado e no campo Componente, o caminho onde se encontra o projeto da customização. A tabela irá apresentar a sua formatação em negrito, se destacando dos demais para diferenciar das tabelas do ERP Cigam, como demonstra a figura abaixo. 

[[Arquivo:179.png|750x500px|centro]]

&emsp; É importante relatar que além do projeto customizado, tabelas, existem os nomes lógicos, conectores necessários para o correto funcionando do projeto customizado e consequentemente o cadastro de zoom também. Na falta de algum dos arquivos citados, o padão é buscar do projeto Cigam (CGGeral). 
&emsp; Outra opção é realizar o cadastro de zoom para uma customização da tabela do ERP Cigam. Para isso basta selecionar a tabela e campos e preencher os campos para buscar o projeto da customização, módulos terceiros ou parceiros desenvolvedores. Da mesma forma que ocorre para a tabela terceira para a tabela do ERP Cigam também irá apresentar em negrito demostrando que essa possui outro projeto linkado, como demonstra a ilustração a seguir. 

[[Arquivo:180.png|750x500px|centro]]

&emsp; Dessa forma há como facilitar ao usuário a seleção dos dados para filtrar as informações se seu relatório customizado. 

=Como disponibilizar o Relatório CIGAM Report no Menu Cigam?=

&emsp; Para cadastrar um atalho do relatório no Menu do CIGAM, basta posicionar no local desejado e executar a “Tecla Fácil CIGAM” (com atalho pelo F10) e na tela clicar em “Nova Opção de Menu, como ilustra a figura abaixo. 

[[Arquivo:181.png|500x250px|centro]]

&emsp; Na tela seguinte selecionar “Relatório CIGAM Report” como tipo de opção de menu. 

[[Arquivo:182.png|500x250px|centro]]

&emsp; Após a seleção, automaticamente os campos com as informações da chamada da aplicação do CIGAM Report e os programas necessários são preenchidos e bloqueados para modificação. Deve-se apenas informar uma descrição para o relatório e a chave do programa que será o número do relatório cadastrado. 

[[Arquivo:183.png|500x250px|centro]]

&emsp; No campo Chave do Programa está disponível o zoom no campo para selecionar o relatório requerido, esse apresenta a tela de cadastro dos relatórios, conforme figura abaixo. 

[[Arquivo:184.png|750x500px|centro]]

&emsp; Após clicar em confirmar será aberta uma tela onde devem ser informados quais usuários devem ter acesso ao relatório. Pode-se escolher entre as opções de apenas o usuário que está cadastrando, escolher um usuário específico da lista que aparece, um grupo de usuários ou todos os usuários. Nesse exemplo foi escolhida a opção Todos os Usuários. 

[[Arquivo:185.jpg|750x500px|centro]]

&emsp; Após o cadastro a opção ficará disponível para execução o relatório por dentro do Menu do Cigam, como ilustra a imagem abaixo. 
[[Arquivo:186.png|500x250px|centro]]

&emsp; Por meio desse ajuste o relatório está integrado ao Menu Cigam dentro do módulo correspondente. 

=Como ativar modo DEBUG no CIGAM Report?=

&emsp; A funcionalidade foi criada para facilitar a visualização dos dados da integração entre o CIGAM e o CIGAM Report. Para ativá-la, basta setar o nome-lógico DEBUG_CIGAM REPORT com “S”. Cabe lembrar que esta opção somente deverá ser ativada quando da necessidade de depuração para procurar e ou verificar erros. 

[[Arquivo:200.png|750x500px|centro]]

&emsp; Ao executar o cadastro do relatório, a atividade da funcionalidade pode ser identificada no título da janela, conforme ilustra a imagem abaixo.

[[Arquivo:201.png|750x500px|centro]]

&emsp; Ao executar o relatório (pelo botão “Executar” ou pela integração com o menu do CIGAM) será exibida uma mensagem, figura abaixo, com a linha de comando que será executada. 

[[Arquivo:202.png|750x500px|centro]]

&emsp; O conteúdo dessa mensagem pode ser obtido em formato texto através de um CTRL+C sob a mensagem em exibição. O resultado será o seguinte: 
--------------------------- 
Atenção 
--------------------------- 
Linha de comando: 
H:\CIGAM10\PROJECTS\CIGAM\CIGAM Report.exe -G: -M:f:\Teste_data.frx -A:f:\Teste_data_xx.frx -P::p_data='08/11/2009' 
--------------------------- 
OK 

&emsp; Após a exibição da linha de comando é possível escolher se deseja submeter (executar a geração do relatório) no executável do CIGAM Report instalado (também aparece o caminho completo do arquivo o qual deverá existir). 

[[Arquivo:203.png|750x500px|centro]]

&emsp; Após realizar as verificações o nome lógico, deve ser alterado para ‘N’, pois senão as telas irão ser apresentadas aos usuários que utilizarão o relatório, cada vez que for utilizando, podendo trazer descontentamento ao cliente por ter tantas telas para confirmar. 
&emsp; Com meio dessas instruções que se realiza a integração do Cigam Report com o Cigam. Podendo criar relatórios conforme necessidade sem o envolvimento do setor de desenvolvimento, agilizando dessa forma a solicitação do cliente. 

'''Mais duvidas consultar'''
[[FAQ GE|FAQ GE|CGReport]]

GE Funções

2025-10-16T19:49:49Z

Alessandro.voto: /* Funções */

{{VoltarPagina}}

[[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Cadastros|Cadastros]] > [[GE_Funções|Funções]]
 
= Funções =
* O cadastro de '''Funções''' está localizado em '''Genéricos → Cadastros → Funções'''.
* Esta funcionalidade permite '''cadastrar e manter a lista de funções ou cargos''' que poderão ser associados aos '''contatos das empresas/pessoas''' no sistema.
* Cada função cadastrada é identificada por um '''código numérico único''' e uma '''descrição''', que representa o nome da função (ex.: “Analista de Testes”, “Analista de Sistemas” etc.).
* As funções cadastradas aqui ficam disponíveis para seleção no cadastro de '''Empresa/Pessoa → Complemento → Contatos''', permitindo relacionar com o '''cargo/função''' de cada contato vinculado à empresa.

'''📌 Campos disponíveis'''
:* '''Código -''' Identificador numérico único da função.
:* '''Descrição -''' Nome ou título da função/cargo.

'''📝 Exemplo de uso'''
:* Ao cadastrar um novo contato em uma empresa, é possível selecionar a função previamente cadastrada, garantindo padronização e facilidade de identificação do papel de cada pessoa no relacionamento com a empresa.

[[Arquivo:Funcoes.jpg|commoldura|center|Funções]]

GE - Como Fazer - Integração CIGAM entre Matriz e Filiais

2025-10-09T12:04:12Z

Alessandro.voto: /* Como parametrizar a base de dados correspondente a filial? */

GE - Como Fazer - Configuração da Aplicação React no IIS

2025-08-14T18:57:42Z

Alessandro.voto: /* 📌 Definindo o Método de Entrada Padrão */

{{VoltarPagina}}
 
[[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 - Configuração da Aplicação React no IIS|Configuração da Aplicação React no IIS]]

=Configuração da Aplicação React no IIS=
===📌 Pré-requisitos===
:* O módulo URL Rewrite deve estar previamente instalado no IIS.
::→ Consulte: [[GE - Como Fazer - Instalação do IIS]] para instruções.
::→ Alternativamente, faça o download direto pelo link: [https://www.iis.net/downloads/microsoft/url-rewrite URL Rewrite IIS].

===📌 Implantação da Aplicação React===
:1. A aplicação React deve ser instalada como uma '''aplicação web no IIS''' utilizando o pacote compactado: React.zip.

:2. '''Importante:'''
::* O '''nome do site''' e o '''nome da aplicação''' devem ser '''iguais'''.
::* A instalação exige a criação de um '''site dedicado exclusivamente ao React''', sem outras aplicações.
::* Os arquivos devem ser posicionados diretamente na '''raiz deste site'''.
::* '''Não utilize''' um site que já contenha outras aplicações, pois isso compromete o funcionamento.

:3. As aplicações '''React e API''' funcionam em conjunto.
::→ Portanto, ao instalar a aplicação React, também é necessário implantar a '''API''' correspondente.
::→ Consulte o tópico específico sobre a implantação da API para detalhes adicionais.

:4. Durante a implantação do React, '''não é necessário informar''':
::* “String de conexão”;
::* “Banco de dados”;
::* “Endereço do servidor de aplicação Magic”.
:: ➡️ Esta comunicação é realizada exclusivamente pela '''API'''.
{{VoltarInicio}}
===📌 Pós-implantação: Configuração do Arquivo de Parâmetros===
:1. Localize o arquivo:
::→ <code>static\base_config.json</code>

:2. Renomeie para:
::→ <code>static\config.json</code>

:3. Realize as '''configurações adicionais manualmente''' neste arquivo.

:4. As configurações de '''endereços''' devem ser:
::* Revisadas após a instalação;
::* Ou recuperadas a partir da cópia da versão anterior (realizada automaticamente pela instalação).

:🔹 '''Atenção:''' Sempre mantenha a '''vírgula de separação''' entre as configurações.

===📌 Desativando Endereços de Aplicações Não Utilizadas===
:* Nas configurações de endereço (campos com sufixo: <code>"_URL"</code>), caso a aplicação '''não esteja instalada''', o valor deve ser '''anulado'''.
:* Para isso, '''remova as aspas''' e deixe o valor como <code>null</code>.
:'''Exemplo:'''
{
"PORTAL_SERVICOS_URL": null
}

===📌 Habilitando Portais em Uso===
:Inclua no campo <code>"ACTIVE_PORTALS"</code> os portais que devem ser ativados.
::→ Os valores devem estar entre aspas e separados por vírgula.

:'''Portais disponíveis e seus valores:'''
::1. '''Portal Cliente''' (login contato) - valor: <code>"portalcliente"</code> → Referência: [[GF - Como Fazer - Portal Cliente - Área Financeira|Portal Cliente - Área Financeira]]

::2. '''Portal Cliente/Serviços''' (login contato) - valor: <code>"portalclienteservicos"</code> → Referência: [[Portal Cliente Serviços]]

::3. '''Portal Financeiro''' - valor: <code>"portalfinanceiro"</code> → Referência: [[GF - Como Fazer - Portal Financeiro|Portal Financeiro]]

::4. '''Portal Indústria''' - valor: <code>"portalindustria"</code> → Referência: [[Portal Indústria]]

::5. '''Portal Compras''' - valor: <code>"portalcompras"</code> → Referência: [[Portal Compras]]

::6. '''Portal Projetos''' - valor: <code>"portalprojetos"</code> → Referência: [[Portal Projetos]]

:'''Exemplo de configuração:'''
{
"ACTIVE_PORTALS": ["portalcliente", "portalclienteservicos"]
}
:OU
{
"ACTIVE_PORTALS": ["portalfinanceiro", "portalindustria", "portalcompras", "portalprojetos"]
}
{{VoltarInicio}}
===📌 Configuração do DEFAULT_PORTAL no React===
: ✅ '''O que mudou?'''
:: A partir da <ref group="Versão 250505">Liberado a partir da OS 373456/334.</ref>, para usuários que já possuem os '''portais React''' instalados, é importante realizar uma atualização na configuração:
:::* O parâmetro <code>ACTIVE_PORTALS</code> foi substituído por <code>DEFAULT_PORTAL</code>.
:::* Agora, deve-se definir '''qual portal será aberto por padrão''' ao acessar a aplicação React.

: ✅ '''Como configurar?'''
::1. Acesse o arquivo:
:::→ Local: <code>static/config.json</code> na raiz da aplicação React dentro do '''site configurado no IIS'''.

::2. Localize ou adicione o parâmetro:
:::→ <code>"DEFAULT_PORTAL"</code>

::3. Informe o portal que deve ser aberto automaticamente ao acessar a aplicação.

: ✅ '''Valores válidos para DEFAULT_PORTAL:'''

<center>
{| class="wikitable mw-collapsible sortable" border="1" cellpadding="5" cellspacing="0" style="text-align: center;" style="width: 450px;"
!Portal!!Valor
|-
|Portal Financeiro||<code>"portalfinanceiro"</code>
|-
|Portal Indústria||<code>"portalindustria"</code>
|-
|Portal Serviços||<code>"portalservicos"</code>
|-
|Portal Compras||<code>"portalcompras"</code>
|-
|Portal Projetos||<code>"portalprojetos"</code>
|}
</center>

:✅ '''Exemplo de arquivo''' <code>config.json</code>:
{
"API_URL": "https://servidor:porta/api/api",
"CDN_URL": "https://servidor:porta/cdn/files.ashx/",
"CDN_KEY": "1",
"APM_MONITOR_URL": "https://servidor:porta/apm",
"PORTAL_SERVICOS_URL": "https://servidor:porta/portalservicos",
"PD_URL": "https://servidor:porta/pesquisadinamica",
"DEFAULT_THEME": "CIGAM",
"DEFAULT_PORTAL": "portalcompras",
"DEFAULT_LOGIN": "cigam",
"THEMES": null
}

:⚠️ '''Importante:'''
::* O parâmetro <code>DEFAULT_PORTAL</code> define '''qual portal será aberto automaticamente''' ao acessar a aplicação React. Apenas '''um portal''' deve ser definido neste parâmetro.
::* O parâmetro <code>ACTIVE_PORTALS</code> pode continuar sendo utilizado no arquivo <code>config.json</code> '''para informar quais portais estão disponíveis''' na instalação, mas '''não é mais obrigatório''' e '''não interfere''' na definição do portal padrão.
::* Caso esteja utilizando o <code>ACTIVE_PORTALS</code>, mantenha-o atualizado com os portais efetivamente implantados.
::* Após realizar qualquer alteração no arquivo <code>config.json</code>, é '''necessário reiniciar o site no IIS''' para que as configurações sejam aplicadas corretamente.
{{VoltarInicio}}
===📌 Definindo o Método de Entrada Padrão===
:Configure qual método de entrada será '''aberto automaticamente''' ao acessar o endereço base da aplicação React.
:→ Informe o valor correspondente no campo <code>"DEFAULT_LOGIN"</code>, '''entre aspas'''.

:'''Opções disponíveis:'''
::1. '''CIGAM Padrão''' - <code>"cigam"</code>
:::→ Utilizado para autenticação interna padrão.

::2. '''Contato Externo''' - <code>"contato"</code>
:::→ Utilizado atualmente para:
::::* Portal Cliente - Área Financeira
::::* Portal Cliente - Serviços

:'''Exemplo:'''
{
"DEFAULT_LOGIN": "cigam"
}

:⚠️ '''Atenção Importante:'''
::* A aplicação '''CIGAM Padrão''' e a de '''Contato Externo''' são componentes distintos.
::* Ambas devem ser '''instaladas separadamente''', conforme necessidade e contexto de uso.
::* As configurações e rotas de acesso são específicas e devem ser configuradas corretamente.
::* O parâmetro <code>"DEFAULT_LOGIN"</code> deve ser informado utilizando caracteres '''minúsculos'''.

===📌 Acessos Alternativos à Aplicação React===
:Para realizar acesso por um método específico, adicione o '''sufixo correspondente ao endereço da aplicação''', precedido pelo '''nome do portal''' instalado.

<center>
{| class="wikitable mw-collapsible sortable" border="1" cellpadding="5" cellspacing="0" style="text-align: center;" style="width: 550px;"
!Método de Entrada!!Valor!!Sufixo de Acesso
|-
|CIGAM Padrão||<code>"cigam"</code>||<code>/login</code>
|-
|Contato Externo||<code>"contato"</code>||<code>/logincontato</code>
|}
</center>

:'''Exemplo:'''
::* Para o CIGAM Padrão:
:::→ https://sistema.empresa.com/portalcompras/login</code>

::* Para o Contato Externo:
:::→ https://sistema.empresa.com/portalclienteservicos/logincontato</code>
{{VoltarInicio}}
=Documento relacionado=
* [[GE - Como Fazer - Configuração do menu mosaico nos Portais Web#Como parametrizar o menu mosaico nos portais REACT|Como parametrizar o menu mosaico nos portais REACT]]

=Versões=
==Versão 250505==
<references group="Versão 250505"/>

GE - Como Fazer - Login Active Directory

2025-06-23T20:22:45Z

Alessandro.voto: /* Como configuro o CIGAM para utilizar o Active Directory? */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[categoria:Como Fazer Utilidades/Diversos_5]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Login Active Directory|Login Active Directory]]

Active Directory é um software da Microsoft, que utiliza o protocolo LDAP para gerenciar e armazenar informações de objetos em uma rede de computadores, além de disponibilizar essas informações para usuários e administradores da rede.
 
Com a integração entre CIGAM e Active Directory, o login irá usar as informações de usuário da rede, consultando o usuário logado no Active Directory, e realizando o login automaticamente no CIGAM.

=Como configuro o CIGAM para utilizar o Active Directory?=
Através do item Utilidades, disponível no menu de topo da tela principal do CIGAM, acessar o item de menu Ambiente - Configurações do ambiente. Liberar a permissão de escrita no arquivo MAGIC.INI e acessar o item de menu 'Opções - Configurações - Ambiente'.
 
<center>
[[Arquivo:ADAmbiente.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Na tela de configuração do ambiente, na guia “Sistema”, caso a integração com o Active Directory não esteja configurada, a opção “Logon do sistema” estará como "Nenhum" ou como "Usuário".

<center>
[[Arquivo:ADAmbiente6.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Altere a opção “Logon do sistema” para “Active Directory”.

<center>
[[Arquivo:ADAmbiente2.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Clique em OK para confirmar as alterações, e em seguida abra o menu Opções – Configurações – Nomes Secretos.

<center>
[[Arquivo:ADAmbiente4.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Nomes secretos são utilizados onde há a necessidade de omitir informações de autorização para pessoas não autorizadas. Podem ser usados para chaves de acesso de arquivos de projeto, campos de senha de usuários, propriedades de servidores/banco de dados e arquivos de dados de acesso.

O repositório de nomes secretos é idêntico ao de nomes lógicos, exceto que:
*Acesso ao repositório de nomes secretos é permitido apenas para usuários com acesso de supervisor.
*Nomes secretos são armazenados no Arquivo de Segurança especificado na configuração de ambiente. Este arquivo é criptografado. O nome secreto para uma senha de servidor é armazenado nas configurações do servidor.
*Nomes secretos podem ser usados apenas em campos autorizados.
*Magic xpa tentará resolver um nome lógico através do repositório de nomes secretos antes de buscar por ele no repositório de nomes lógicos.

Na janela que abrirá configure os seguintes nomes secretos:
 
*'''Directory_Binding'''
*'''Domain_Name'''

A opção '''Directory_Binding''' corresponde ao servidor do Active Directory, e deve ser implementado com WinNT://servidor/. Por exemplo: WinNT://192.168.0.7/

A opção '''Domain_Name''' corresponde ao nome do domínio no Active Directory. Por exemplo: empresa.com.br

<center>
[[Arquivo:ADAmbiente5.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Clique em OK para salvar as alterações.

=É necessária alguma alteração no Active Diretory?=

Sim, é necessário que sejam cadastradas informações em campos específicos no Active Directory, para correto funcionamento do recurso, quando o usuário na rede e no CIGAM forem diferentes. Estes campos são:
 
*'''EmployeeID'''
*'''EmployeeNumber''' (utilizado somente no CIGAM e10)

O campo '''EmployeeID''' irá guardar o login CIGAM do usuário.

O campo '''EmployeeNumber''' irá guardar o login de rede do usuário.

Por exemplo:

Um usuário que faz login na rede como joao.silva e no CIGAM como JOAOS, terá os campos preenchidos da seguinte maneira:

EmployeeID = JOAOS
EmployeeNumber = joao.silva

Existem controles para os nomes dos atributos utilizados no recurso de autenticação pelo MS Active Directory. Ao informar os nomes lógicos abaixo, é possível escolher os atributos a serem utilizados.
 
CGLOGIN_AD_DE = outroEmployeeNumber (utilizado somente no CIGAM e10)
CGLOGIN_AD_PARA = outroEmployeeID

'''Informações importantes'''
*O cadastro de Usuários - Grupos e Direitos no CIGAM deve ser implementado normalmente, onde o campo 'Usuário' serve como a chave de ligação com o usuário logado na rede Windows. Quando o usuário logado no Windows difere do usuário informado no cadastro CIGAM, o sistema utiliza o nome de usuário especificado no atributo employeeID.

GE - Como Fazer - Login Active Directory

2025-06-18T14:26:03Z

Alessandro.voto: /* É necessária alguma alteração no Active Diretory? */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[categoria:Como Fazer Utilidades/Diversos_5]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Login Active Directory|Login Active Directory]]

Active Directory é um software da Microsoft, que utiliza o protocolo LDAP para gerenciar e armazenar informações de objetos em uma rede de computadores, além de disponibilizar essas informações para usuários e administradores da rede.
 
Com a integração entre CIGAM e Active Directory, o login irá usar as informações de usuário da rede, consultando o usuário logado no Active Directory, e realizando o login automaticamente no CIGAM.

=Como configuro o CIGAM para utilizar o Active Directory?=
Através do item Utilidades, disponível no menu de topo da tela principal do CIGAM, acessar o item de menu Ambiente - Configurações do ambiente. Liberar a permissão de escrita no arquivo MAGIC.INI e acessar o item de menu 'Opções - Configurações - Ambiente'.
 
<center>
[[Arquivo:ADAmbiente.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Na tela de configuração do ambiente, na guia “Sistema”, caso a integração com o Active Directory não esteja configurada, a opção “Logon do sistema” estará como "Nenhum" ou como "Usuário".

<center>
[[Arquivo:ADAmbiente6.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Altere a opção “Logon do sistema” para “Active Directory”.

<center>
[[Arquivo:ADAmbiente2.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Clique em OK para confirmar as alterações, e em seguida abra o menu Opções – Configurações – Nomes Secretos.

<center>
[[Arquivo:ADAmbiente4.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Nomes secretos são utilizados onde há a necessidade de omitir informações de autorização para pessoas não autorizadas. Podem ser usados para chaves de acesso de arquivos de projeto, campos de senha de usuários, propriedades de servidores/banco de dados e arquivos de dados de acesso.

O repositório de nomes secretos é idêntico ao de nomes lógicos, exceto que:
*Acesso ao repositório de nomes secretos é permitido apenas para usuários com acesso de supervisor.
*Nomes secretos são armazenados no Arquivo de Segurança especificado na configuração de ambiente. Este arquivo é criptografado. O nome secreto para uma senha de servidor é armazenado nas configurações do servidor.
*Nomes secretos podem ser usados apenas em campos autorizados.
*uniPaaS tentará resolver um nome lógico através do repositório de nomes secretos antes de buscar por ele no repositório de nomes lógicos.

Na janela que abrirá configure os seguintes nomes secretos:
 
*'''Directory_Binding'''
*'''Domain_Name'''

A opção '''Directory_Binding''' corresponde ao servidor do Active Directory, e deve ser implementado com WinNT://servidor/. Por exemplo: WinNT://192.168.0.7/

A opção '''Domain_Name''' corresponde ao nome do domínio no Active Directory. Por exemplo: empresa.com.br

<center>
[[Arquivo:ADAmbiente5.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Clique em OK para salvar as alterações.

=É necessária alguma alteração no Active Diretory?=

Sim, é necessário que sejam cadastradas informações em campos específicos no Active Directory, para correto funcionamento do recurso, quando o usuário na rede e no CIGAM forem diferentes. Estes campos são:
 
*'''EmployeeID'''
*'''EmployeeNumber''' (utilizado somente no CIGAM e10)

O campo '''EmployeeID''' irá guardar o login CIGAM do usuário.

O campo '''EmployeeNumber''' irá guardar o login de rede do usuário.

Por exemplo:

Um usuário que faz login na rede como joao.silva e no CIGAM como JOAOS, terá os campos preenchidos da seguinte maneira:

EmployeeID = JOAOS
EmployeeNumber = joao.silva

Existem controles para os nomes dos atributos utilizados no recurso de autenticação pelo MS Active Directory. Ao informar os nomes lógicos abaixo, é possível escolher os atributos a serem utilizados.
 
CGLOGIN_AD_DE = outroEmployeeNumber (utilizado somente no CIGAM e10)
CGLOGIN_AD_PARA = outroEmployeeID

'''Informações importantes'''
*O cadastro de Usuários - Grupos e Direitos no CIGAM deve ser implementado normalmente, onde o campo 'Usuário' serve como a chave de ligação com o usuário logado na rede Windows. Quando o usuário logado no Windows difere do usuário informado no cadastro CIGAM, o sistema utiliza o nome de usuário especificado no atributo employeeID.

Arquivo:ADAmbiente5.png

2025-06-18T13:47:51Z

Alessandro.voto: Alessandro.voto carregada uma nova versão de Arquivo:ADAmbiente5.png

Arquivo:ADAmbiente5.png

2025-06-18T13:43:23Z

Alessandro.voto: Alessandro.voto carregada uma nova versão de Arquivo:ADAmbiente5.png

GE - Como Fazer - Login Active Directory

2025-06-17T16:52:02Z

Alessandro.voto: /* Como configuro o CIGAM para utilizar o Active Directory? */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[categoria:Como Fazer Utilidades/Diversos_5]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Login Active Directory|Login Active Directory]]

Active Directory é um software da Microsoft, que utiliza o protocolo LDAP para gerenciar e armazenar informações de objetos em uma rede de computadores, além de disponibilizar essas informações para usuários e administradores da rede.
 
Com a integração entre CIGAM e Active Directory, o login irá usar as informações de usuário da rede, consultando o usuário logado no Active Directory, e realizando o login automaticamente no CIGAM.

=Como configuro o CIGAM para utilizar o Active Directory?=
Através do item Utilidades, disponível no menu de topo da tela principal do CIGAM, acessar o item de menu Ambiente - Configurações do ambiente. Liberar a permissão de escrita no arquivo MAGIC.INI e acessar o item de menu 'Opções - Configurações - Ambiente'.
 
<center>
[[Arquivo:ADAmbiente.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Na tela de configuração do ambiente, na guia “Sistema”, caso a integração com o Active Directory não esteja configurada, a opção “Logon do sistema” estará como "Nenhum" ou como "Usuário".

<center>
[[Arquivo:ADAmbiente6.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Altere a opção “Logon do sistema” para “Active Directory”.

<center>
[[Arquivo:ADAmbiente2.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Clique em OK para confirmar as alterações, e em seguida abra o menu Opções – Configurações – Nomes Secretos.

<center>
[[Arquivo:ADAmbiente4.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Nomes secretos são utilizados onde há a necessidade de omitir informações de autorização para pessoas não autorizadas. Podem ser usados para chaves de acesso de arquivos de projeto, campos de senha de usuários, propriedades de servidores/banco de dados e arquivos de dados de acesso.

O repositório de nomes secretos é idêntico ao de nomes lógicos, exceto que:
*Acesso ao repositório de nomes secretos é permitido apenas para usuários com acesso de supervisor.
*Nomes secretos são armazenados no Arquivo de Segurança especificado na configuração de ambiente. Este arquivo é criptografado. O nome secreto para uma senha de servidor é armazenado nas configurações do servidor.
*Nomes secretos podem ser usados apenas em campos autorizados.
*uniPaaS tentará resolver um nome lógico através do repositório de nomes secretos antes de buscar por ele no repositório de nomes lógicos.

Na janela que abrirá configure os seguintes nomes secretos:
 
*'''Directory_Binding'''
*'''Domain_Name'''

A opção '''Directory_Binding''' corresponde ao servidor do Active Directory, e deve ser implementado com WinNT://servidor/. Por exemplo: WinNT://192.168.0.7/

A opção '''Domain_Name''' corresponde ao nome do domínio no Active Directory. Por exemplo: empresa.com.br

<center>
[[Arquivo:ADAmbiente5.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Clique em OK para salvar as alterações.

=É necessária alguma alteração no Active Diretory?=

Sim, é necessário que sejam cadastradas informações em campos específicos no Active Directory, para correto funcionamento do recurso, quando o usuário na rede e no CIGAM forem diferentes. Estes campos são:
 
*'''EmployeeID'''
*'''EmployeeNumber''' (utilizado somente no CIGAM e10)

O campo '''EmployeeID''' irá guardar o login CIGAM do usuário.

O campo '''EmployeeNumber''' irá guardar o login de rede do usuário.

Por exemplo:

Um usuário que faz login na rede como joao.silva e no CIGAM como JOAOS, terá os campos preenchidos da seguinte maneira:

EmployeeID = JOAOS
EmployeeNumber = joao.silva

Existem controles para os nomes dos atributos utilizados no recurso de autenticação pelo MS Active Directory. Ao informar os nomes lógicos abaixo, é possível escolher os atributos a serem utilizados.
 
CGLOGIN_AD_DE = outroEmployeeNumber
CGLOGIN_AD_PARA = outroEmployeeID

'''Informações importantes'''
*O cadastro de Usuários - Grupos e Direitos no CIGAM deve ser implementado normalmente, onde o campo 'Usuário' serve como a chave de ligação com o usuário logado na rede Windows. Quando o usuário logado no Windows difere do usuário informado no cadastro CIGAM, o sistema utiliza o nome de usuário especificado no atributo employeeID.

GE - Como Fazer - Login Active Directory

2025-06-17T16:47:05Z

Alessandro.voto:

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[categoria:Como Fazer Utilidades/Diversos_5]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Login Active Directory|Login Active Directory]]

Active Directory é um software da Microsoft, que utiliza o protocolo LDAP para gerenciar e armazenar informações de objetos em uma rede de computadores, além de disponibilizar essas informações para usuários e administradores da rede.
 
Com a integração entre CIGAM e Active Directory, o login irá usar as informações de usuário da rede, consultando o usuário logado no Active Directory, e realizando o login automaticamente no CIGAM.

=Como configuro o CIGAM para utilizar o Active Directory?=
Através do item Utilidades, disponível no menu de topo da tela principal do CIGAM, acessar o item de menu Ambiente - Configurações do ambiente. Liberar a permissão de escrita no arquivo MAGIC.INI e acessar o item de menu 'Opções - Configurações - Ambiente'.
 
<center>
[[Arquivo:ADAmbiente.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Na tela de configuração do ambiente, na guia “Sistema”, caso a integração com o Active Directory não esteja configurada, a opção “Logon do sistema” estará como "Nenhum" ou como "Usuário".

<center>
[[Arquivo:ADAmbiente6.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Altere a opção “Logon do sistema” para “Active Directory”.

<center>
[[Arquivo:ADAmbiente2.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Acesse a guia “Externo”, e procure pelas opções:
*'''LDAP Endereço: porta'''
*'''String de Conexão LDAP'''
*'''Contexto de Domínio LDAP'''

A opção '''LDAP Endereço: porta''' corresponde ao endereço e a porta do servidor onde está rodando o Active Diretory. Por exemplo: 192.168.0.7:389 (Onde “192.168.0.7” é o endereço do servidor, e “389” corresponde a porta de conexão).

A opção '''String de Conexão LDAP''' é o login necessário para conectar no Active Directory e realizar as pesquisas de usuário, use o nome secreto %LDAP_USER% + o domínio da empresa. Por exemplo: %LDAP_USER%@empresa.com.br (O nome secreto é configurado mais adiante).

A opção '''Contexto de Domínio LDAP''' representa o domínio de login, e domínio de busca do protocolo LDAP. Seguindo o exemplo anterior (%LDAP_USER%@empresa.com.br), o valor para esta opção seria: DC=empresa,DC=com,DC=br

<center>
[[Arquivo:ADAmbiente3.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Clique em OK para confirmar as alterações, e em seguida abra o menu Opções – Configurações – Nomes Secretos.

<center>
[[Arquivo:ADAmbiente4.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Nomes secretos são utilizados onde há a necessidade de omitir informações de autorização para pessoas não autorizadas. Podem ser usados para chaves de acesso de arquivos de projeto, campos de senha de usuários, propriedades de servidores/banco de dados e arquivos de dados de acesso.

O repositório de nomes secretos é idêntico ao de nomes lógicos, exceto que:
*Acesso ao repositório de nomes secretos é permitido apenas para usuários com acesso de supervisor.
*Nomes secretos são armazenados no Arquivo de Segurança especificado na configuração de ambiente. Este arquivo é criptografado. O nome secreto para uma senha de servidor é armazenado nas configurações do servidor.
*Nomes secretos podem ser usados apenas em campos autorizados.
*uniPaaS tentará resolver um nome lógico através do repositório de nomes secretos antes de buscar por ele no repositório de nomes lógicos.

Na janela que abrirá configure os seguintes nomes secretos:
 
*'''Directory_Binding'''
*'''Domain_Name'''
*'''LDAP_USER'''
*'''LDAP_PASS'''

A opção '''Directory_Binding''' corresponde ao servidor do Active Directory, e deve ser implementado com WinNT://servidor/. Por exemplo: WinNT://192.168.0.7/

A opção '''Domain_Name''' corresponde ao nome do domínio no Active Directory. Por exemplo: empresa.com.br

A opção '''LDAP_USER''', necessita do login de (do Active Directory) que possua as permissões de pesquisa de usuários no Active Directory. Por estar na opção de Nomes Secretos, apenas usuários Supervisores poderão ver esta opção, assim como todas as demais. Por exemplo: administrador

A opção '''LDAP_PASS''' corresponde a senha do usuário informado na opção LDAP_USER.

Atenção: A opção '''LDAP_USER''' (bem como '''LDAP_PASS''') não requer um usuário do CIGAM, e sim um usuário da rede, onde está sendo implementado o recurso, que possua os direitos necessários para fazer a pesquisa de usuários no Active Diretory.

<center>
[[Arquivo:ADAmbiente5.png| 750x500px|semmoldura|centro|Ambiente do Magic]]
</center>
 
Clique em OK para salvar as alterações.

=É necessária alguma alteração no Active Diretory?=

Sim, é necessário que sejam cadastradas informações em campos específicos no Active Directory, para correto funcionamento do recurso, quando o usuário na rede e no CIGAM forem diferentes. Estes campos são:
 
*'''EmployeeID'''
*'''EmployeeNumber''' (utilizado somente no CIGAM e10)

O campo '''EmployeeID''' irá guardar o login CIGAM do usuário.

O campo '''EmployeeNumber''' irá guardar o login de rede do usuário.

Por exemplo:

Um usuário que faz login na rede como joao.silva e no CIGAM como JOAOS, terá os campos preenchidos da seguinte maneira:

EmployeeID = JOAOS
EmployeeNumber = joao.silva

Existem controles para os nomes dos atributos utilizados no recurso de autenticação pelo MS Active Directory. Ao informar os nomes lógicos abaixo, é possível escolher os atributos a serem utilizados.
 
CGLOGIN_AD_DE = outroEmployeeNumber
CGLOGIN_AD_PARA = outroEmployeeID

'''Informações importantes'''
*O cadastro de Usuários - Grupos e Direitos no CIGAM deve ser implementado normalmente, onde o campo 'Usuário' serve como a chave de ligação com o usuário logado na rede Windows. Quando o usuário logado no Windows difere do usuário informado no cadastro CIGAM, o sistema utiliza o nome de usuário especificado no atributo employeeID.

O que fazer caso seja apresentada a mensagem "Ocorreu uma falha"

2025-04-28T18:37:56Z

Alessandro.voto: /* Possíveis soluções */

{{VoltarPagina}}
 
[[FAQ_CIGAM]] > [[FAQ_Portais| Portais]] > [[FAQ Dúvidas Gerais sobre Portais]] > [[O que fazer caso seja apresentada a mensagem "Ocorreu uma falha"]]

=='''Mensagens:'''==
"Ocorreu uma falha (-102). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-102) = A conexão com o broker foi recusada.

"Ocorreu uma falha (-103). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-103) = Aplicativo do broker não encontrado. 

"Ocorreu uma falha (-104). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-104) = Aplicativo do broker em uso. 

"Ocorreu uma falha (-105). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-105) = Broker não responde. 

"Ocorreu uma falha (-107). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-107) = A conexão com o broker foi reiniciada pelo servidor. 

"Ocorreu uma falha (-108). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-108) = A conexão com o broker foi reiniciada pelo servidor. 

"Ocorreu uma falha (-109). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-109) = Problemas de conexão entre requesters e enterprise server. 

"Ocorreu uma falha (-119). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-119) = Licenças excedidas Magic Broker. 

"Ocorreu uma falha (-120). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-120) = Não foi possível encontrar um servidor disponível porque o máximo de contextos foi atingido. 

"Ocorreu uma falha (-133). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-133) = O acesso foi negado à aplicação do broker. 

"Ocorreu uma falha (-136). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-136) = O número máximo de ocorrências foi atingido durante a validação da licença Magic Broker. 

"Ocorreu uma falha (-137). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-137) = A requisição foi rejeitada. 

"Ocorreu uma falha (-144). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-144) = A conexão com o broker foi reiniciada pelo servidor. 

"Ocorreu uma falha (-149). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-149) = O módulo atual atingiu o número máximo de soquetes abertos. 

"Ocorreu uma falha (-151). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-151) = Durante a execução de uma solicitação, o solicitante fechou a conexão após receber o status de TIMEOUT. 

"Ocorreu uma falha (-152). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-152) = A conexão com o servidor xpa foi redefinida pelo solicitante. 

"Ocorreu uma falha (-185). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-185) = O broker falhou durante sua inicialização como um serviço. 

"Ocorreu uma falha (-198). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-198) = Limite de fila do broker atingido. 

"Ocorreu uma falha (-200). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-200) = Erro inesperado. 

Esses casos indicam que o '''broker''', responsável por gerenciar conexões entre os clientes e o servidor, não está acessível. O problema pode estar relacionado a:
:1. Broker não iniciado → O serviço do broker não está rodando na máquina onde deveria estar.
:2. Porta incorreta ou bloqueada → A porta configurada para o broker pode estar incorreta ou bloqueada por firewall ou antivírus.
:3. Problemas de rede → Falha de comunicação entre o cliente e o servidor, seja por problemas na rede ou configurações erradas de IP/hostname.
:4. Permissões insuficientes → O usuário que executa o broker pode não ter permissões adequadas para inicializar o serviço corretamente.

==Possíveis soluções==
:1. Verifique se o broker está rodando.
:2. Verifique qual porta o broker está configurado para usar.
:3. Teste a conectividade.
:4. Certifique-se de que o firewall ou antivírus não está bloqueando a porta do broker.

O que fazer caso seja apresentada a mensagem "Ocorreu uma falha"

2025-04-28T18:31:14Z

Alessandro.voto: /* Mensagens: */

{{VoltarPagina}}
 
[[FAQ_CIGAM]] > [[FAQ_Portais| Portais]] > [[FAQ Dúvidas Gerais sobre Portais]] > [[O que fazer caso seja apresentada a mensagem "Ocorreu uma falha"]]

=='''Mensagens:'''==
"Ocorreu uma falha (-102). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-102) = A conexão com o broker foi recusada.

"Ocorreu uma falha (-103). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-103) = Aplicativo do broker não encontrado. 

"Ocorreu uma falha (-104). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-104) = Aplicativo do broker em uso. 

"Ocorreu uma falha (-105). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-105) = Broker não responde. 

"Ocorreu uma falha (-107). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-107) = A conexão com o broker foi reiniciada pelo servidor. 

"Ocorreu uma falha (-108). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-108) = A conexão com o broker foi reiniciada pelo servidor. 

"Ocorreu uma falha (-109). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-109) = Problemas de conexão entre requesters e enterprise server. 

"Ocorreu uma falha (-119). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-119) = Licenças excedidas Magic Broker. 

"Ocorreu uma falha (-120). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-120) = Não foi possível encontrar um servidor disponível porque o máximo de contextos foi atingido. 

"Ocorreu uma falha (-133). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-133) = O acesso foi negado à aplicação do broker. 

"Ocorreu uma falha (-136). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-136) = O número máximo de ocorrências foi atingido durante a validação da licença Magic Broker. 

"Ocorreu uma falha (-137). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-137) = A requisição foi rejeitada. 

"Ocorreu uma falha (-144). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-144) = A conexão com o broker foi reiniciada pelo servidor. 

"Ocorreu uma falha (-149). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-149) = O módulo atual atingiu o número máximo de soquetes abertos. 

"Ocorreu uma falha (-151). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-151) = Durante a execução de uma solicitação, o solicitante fechou a conexão após receber o status de TIMEOUT. 

"Ocorreu uma falha (-152). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-152) = A conexão com o servidor xpa foi redefinida pelo solicitante. 

"Ocorreu uma falha (-185). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-185) = O broker falhou durante sua inicialização como um serviço. 

"Ocorreu uma falha (-198). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-198) = Limite de fila do broker atingido. 

"Ocorreu uma falha (-200). Por favor, tente novamente em alguns instantes. Se o problema persistir, entre em contato com o administrador do sistema."
Código (-200) = Erro inesperado. 

Esses casos indicam que o '''broker''', responsável por gerenciar conexões entre os clientes e o servidor, não está acessível. O problema pode estar relacionado a:
:1. Broker não iniciado → O serviço do broker não está rodando na máquina onde deveria estar.
:2. Porta incorreta ou bloqueada → A porta configurada para o broker pode estar incorreta ou bloqueada por firewall ou antivírus.
:3. Problemas de rede → Falha de comunicação entre o cliente e o servidor, seja por problemas na rede ou configurações erradas de IP/hostname.
:4. Permissões insuficientes → O usuário que executa o broker pode não ter permissões adequadas para inicializar o serviço corretamente.

==Possíveis soluções==
:1. Verifique se o Broker está rodando.
:2. Verifique qual porta o Broker está configurado para usar.
:3. Teste a conectividade.
:4. Certifique-se de que o firewall ou antivírus não está bloqueando a porta do Broker.

IN CadastroEmpresas.integrador

2025-04-10T16:50:00Z

Alessandro.voto: /* CadastrarEmpresas */

{{VoltarPagina}}
[[Integrador]] >
[[IN_CIGAM Integrador|WebServices]] >
[[IN CadastroEmpresas.integrador]]

*Requisição
**Soap: http://servidor/CadastroEmpresas.integrador.asmx
**Rest/JSon: http://servidor/CadastroEmpresas.integrador.ashx/metodo
***Tipo de registro: EMPCAD

== Cadastrar ==
Método que tem por finalidade cadastrar a base de Empresa/Pessoas conforme os parâmetros e tipos indicados abaixo:

*Parâmetros: 
{{#tree: minExpandLevel=2 |

*pin
** Obrigatório, Tipo: String 20

*statusRegistro
** Tipo: String 1
** L=Liberado, P=Pendente
** Este parâmetro não é obrigatório, mas se for informado algo diferente de L ou P,
** por padrão, será cadastrado como P na tabela de integração

*codigoEmpresa
** Tipo: String 6
** Campo onde será inserido o código da empresa.
** Caso não for informado, o código será o próximo disponível para a sua ‘Divisão’.

*nomeCompleto
** Obrigatório, Tipo: String 60
** Existe uma verificação de caracteres inválidos: *, "?", "´", ":", "&", "|", "(", ")", "[", "]", "{", "}", ",", "%"

*contato
** Tipo: String 30

*fone
** Tipo: String 20

*faxFone
** Tipo: String 20

*endereco
** Tipo: String 40

*bairro
** Tipo: String 20

*municipio
** Tipo: String 30

*uf
** Tipo: String 2

*Cep
** Tipo: Int 8

*cnpjCpf
** Tipo: String 14

*inscrito
** Obrigatório, Tipo: Bool

*inscricao
** Obrigatório, Tipo: String 20
** Se o parâmetro "inscrito" for "false", o parâmetro "inscricao" deve ser “ISENTO”.

*conceito
** Tipo: String 1

*codigoDivisao
** Tipo: String 2

*dtNascimento
** Tipo: Date

*codigoIndicacao
** Tipo: String 6

*codigoRepresentante
** Tipo: String 6

*percentualComissaoBaixa
** Tipo: Float 3.2

*contabilCliente
** Tipo: String 8

*codigoResponsavel
** Tipo: String 6

*fantasia
** Obrigatório, Tipo: String 20

*pessoa
** Tipo: Bool

*codigoContabilFornecedor
** Tipo: String 8

*codigoCondicaoPagamento
** Tipo: String 3

*codigoTipoPagamento
** Tipo: String 2

*codigoTipoOperacao
** Tipo: String 5

*irrfAcumulado
** Tipo: Float 13.2

*tipoEmpresa
** Tipo: String 2

*atividade
** Tipo: String 3

*funcionarios
** Tipo: Int 6

*faturamento
** Tipo: Float 13.2

*limiteCredito
** Tipo: Float 13.2

*codigoMercado
** Tipo: String 2

*enviarCarta
** Tipo: String 1

*tabelaPrecos
** Tipo: String 6

*agendaInterna
** Tipo: String 6

*codigoPais
** Tipo: String 3

*codigoCentralizadora
** Tipo: String 6

*atrasoMedio
** Tipo: Int 5

*numero
** Tipo: String 10

*complemento
** Tipo: String 15

*inscricaoMunicipal
** Tipo: String 20

*suframa
** Tipo: String 20

*tipoFrete
** Tipo: String 1

*percentualIndenizacao
** Tipo: Float 3.2

*percDescontoSugestaoItens
** Tipo: Float 3.2

*percentualDesconto2
** Tipo: Float 3.2

*jurosPadrao
** Tipo: Float 3.2

*codigoUnidadeNegocio
** Obrigatório, Tipo: String 3

*codigoPortadorPadrao
** Tipo: String 3

*ativo
** Tipo: Bool

*codigoContabilAdiantamentoCli
** Tipo: String 8

*codigoContabilAdiantamentoForn
** Tipo: String 8

*codigoCentroArmazenagem
** Tipo: String 4

*codigoIndiceCredito
** Tipo: String 5

*codigoRegiaoEntrega
** Tipo: String 3

*dtValidadeCredito
** Tipo: Date

*codigoSetor
** Tipo: String 25

*codigoRegimeTriburario
** Tipo: String 2

*dtUltimaConsultaCredito
** Tipo: Date

*validadeCobrancaAdmin
** Tipo: Date

*ultimaVenda
** Tipo: Date

*prefixoCnae
** Tipo: String 6

*basePrazoDiferenciado
** Tipo: String 6

*possuiRetencaoIss
** Tipo: String 6

*codigoCentroArmazenagemMatAlte
** Tipo: String 6

*filtroDataDirf
** Tipo: String 1

*tipoImovel
** Tipo: String 1

*listarIss
** Tipo: String 1

*diaVencimento
** Tipo: String 2

*limiteFaturamento
** Tipo: String 2

*grauRelacionamento
** Tipo: String 2

*sufixoCnae
** Tipo: String 3

*toleranciaVencimento
** Tipo: String 3

*nivelCredito
** Tipo: String 3

*listarDirf
** Tipo: Bool

*conveniada
** Tipo: Bool

*creditoLiberado
** Tipo: Bool

*percentualFrete
** Tipo: Float 3.4

*codigoEan
** Tipo: Float 13.1

*percentualAcrescimoLimite
** Tipo: Float 8.6

*percentualAcrescimoPreco
** Tipo: Float 8.6

*utilizaPrazoDiferenciado
** Tipo: Float 11.2

*tgPadraoNfs
** Tipo: Float 11.2

*limiteCreditoMensal
** Tipo: Float 13.2

*optanteSimples
** Tipo: Float 13.2

*Usrempr1
** Tipo: String 20

*Usrempr2
** Tipo: String 20

*cnaeServico
** Tipo: String 20

*Usrempr4
** Tipo: Date

*valorFrete
** Tipo: Float 11.2

*recebeEmailNfe
** Tipo: String 1

*recebeEmailCartaCobranca
** Tipo: String 1

*recebeEmailCobranca
** Tipo: String 1

*recebeEmailBoleto
** Tipo: String 1

*nif
** Tipo: String 50

*identificacaoSCP
** Tipo: String 25

*permiteSobrescreverBranco
**Passar True ou False
**Importante: Ao optar por "True" os parâmetro não enviados irão atualizar seus respectivos campos com branco.

*contabilClienteLongoPrazo
** Tipo: String 8


*indicativoNif
** Tipo: String
** Em branco=Nenhum, 1=Beneficiário com NIF, 2=Beneficiário dispensado do NIF, 3=País não exige NIF

*formaTributacao
** Tipo: String

*sobreFontePagadora
** Tipo: String

*cpfProdutorRural
** Tipo: String

*orgaoPublico
** Tipo: Bool
}}

 

Retornos: 
   Se sucesso: 
      idRegistro - ID que representa este registro na tabela de integração. 
 
   Se pin inválido: 
      O usuário não possui direitos suficientes para executar esta rotina. 
 
   Se algum parâmetro inválido: 
      Parâmetro necessário não informado.
{{VoltarInicio}}

== CadastrarEmpresas ==

Método que tem por finalidade cadastrar Empresa/Pessoas e contatos de empresas. Os
dados da Empresa/Pessoas deverão estar em formato XML para requisições SOAP e JSON para
requisições REST. Ambos com estrutura específica conforme descrito a seguir. 
'''Ao passar um código de uma empresa já cadastrada é possível alterar seus dados.'''

*Parâmetros: 
{{#tree: minExpandLevel=2 |

*pin
** Obrigatório, Tipo: String 20

*statusRegistro
** Tipo: String 1
** L=Liberado, P=Pendente
** Este parâmetro não é obrigatório, mas se for informado algo diferente de L ou P,
** por padrão, será cadastrado como P na tabela de integração

*empresasXml
** Obrigatório para requisições SOAP. Tipo: String
** Caminho de um arquivo XML com as Empresas, contatos e representantes

*empresasJson
** Obrigatório para requisições REST/JSON. Tipo: String
** Conteúdo de um arquivo JSON com as Empresa, contatos e representantes.
}}

*Distribuição das Tags XML:
{{#tree: |
*<cadastroEmpresa>
** <empresas>
*** <empresa>
**** <codigo>
**** <nomeCompleto>
**** <contato>
**** <fone>
**** <faxFone>
**** <endereco>
**** <bairro>
**** <municipio>
**** <uf>
**** <cep>
**** <cnpjCpf>
**** <tipoInscricaoEstadual>
***** 0 - False, 1 - True
**** <inscricao>
***** Se o parâmetro "tipoInscricaoEstadual" for "false", o parâmetro "inscrição" deve ser “ISENTO”.
**** <conceito>
**** <divisao>
***** <codigoDivisao>
***** <descricao>
**** <dtNascimento>
**** <indicacao>
**** <representante>
**** <percentualComissaoBaixa>
**** <contabilCliente>
**** <responsavel>
**** <fantasia>
**** <pessoa>
***** 0 - Jurídica, 1 - Física
**** <identificacaoSCP>
**** <contabilFornecedor>
**** <condicaoPagamento>
**** <tipoPagamento>
**** <tipoOperacao>
**** <irrfAcumulado>
**** <tipoEmpresa>
**** <atividade>
**** <funcionarios>
**** <faturamento>
**** <limiteDeCredito>
**** <mercado>
**** <enviarCarta>
**** <tabelaPrecos>
**** <agendaInterna>
**** <pais>
**** <centralizadora>
**** <atrasoMedio>
**** <numero>
**** <complemento>
**** <inscricaoMunicipal>
**** <suframa>
**** <tipoFrete>
**** <percentualIndenizacao>
**** <percDescontoSugestaoItens>
**** <percentualDesconto2>
**** <jurosPadrao>
**** <unidadeDeNegocio>
**** <portadorPadrao>
**** <ativo>
***** Passar True ou False
**** <contabilAdiantamentoCliente>
**** <contabilAdiantamentoFornecedor>
**** <centroArmazenagem>
**** <indiceCredito>
**** <regiaoEntrega>
**** <dtValidadeCredito>
**** <setor>
**** <regimeTributario>
**** <dtUltimaConsultaCredito>
**** <validadeCobrancaAdmin>
**** <dtUltimaVenda>
**** <prefixoCnae>
**** <basePrazoDiferenciado>
**** <possuiRetencaoIss>
**** <centroArmazMaterailAlternativo>
**** <filtroDataDirf>
**** <tipoImovel>
**** <listarIss>
**** <diaVencimento>
**** <limiteFaturamento>
**** <grauRelacionamento>
**** <sufixoCnae>
**** <toleranciaVencimento>
**** <nivelCredito>
**** <listarDirf>
**** <conveniada>
**** <creditoLiberado>
**** <percentualFrete>
**** <codigoEan>
**** <percentualAcrescimoLimite>
**** <percentualAcrescimoPreco>
**** <utilizaPrazoDiferenciado>
**** <tgPadraoNfs>
**** <limiteCreditoMensal>
**** <optanteSimples>
**** <Usrempr1>
**** <Usrempr2>
**** <cnaeServico>
**** <Usrempr4>
**** <valorFrete>
**** <recebeEmailNfe>
***** opcoesAuxiliares,
***** posicao 1
**** <recebeEmailCartaCobranca>
**** <recebeEmailCobranca>
***** notificacaoBloquetoEmail,
***** posicao 1
**** <recebeEmailBoleto>
***** notificacaoBloquetoEmail,
***** posicao 2
**** <contatos>
***** <contatoEmpresa>
***** <sequenciaContato>
****** se não informado, assume a sequência 0 (zero)
***** <pessoaContato>
***** <email>
***** <fone>
***** <recebeEmailNfe>
***** <recebeEmailCartaCobranca>
***** <recebeEmailCobranca>
***** <recebeEmailBoleto>
***** <fone>
***** <homePage>
***** <observacao>
***** <sid>
***** <senha>
***** <numeroIp>
***** <celular>
***** <ramal>
***** <foto>
***** <pessoaFisica>
***** <superior>
***** <sexo>
***** <tratamento>
***** <sessao>
***** <usuarioModificacao>
***** <usuarioCriacao>
***** <dataModificacao>
***** <setor>
***** <validadeCredenciamento>
***** <utilizaTransferPrice>
***** <contibuinteExclusivoISS>
***** <dataAtualizacao>
***** <contaFinanceira>
***** <relacionamento>
***** <controleRemessas>
***** <opcoesAuxiliares>
****** se informado,
****** ignora os campos separados
***** <validacaoContatoItemOs>
***** <recebeEmailPagamentos>
***** <notificacaoBloquetoEmail>
****** se informado,
****** ignora os campos separados
***** <tipoPessoa>
***** <recebeEmailSolicitacao>
***** <diaSemanaInicio>
***** <diaSemanaTermino>
***** <utilizarModalidadePagamento>
***** <recebeEmailAcompanhamento>
***** <participaPesquisaEmail>
***** <notificaVendaContrato>
***** <regraEnvioEmail>
***** <participacaoCotas>
***** <diasDuplicata>
***** <descontoAteVencimento>
***** <posicaoGeografica>
***** <tgTipoOS>
***** <funcao>
***** <Usrcemp1>
***** <Usrcemp2>
***** <Usrcemp3>
***** <rg>
***** <orgaoExpedidor>
***** <dataExpedicao>
***** </contatoEmpresa>
**** <obsEmpresa>
***** <obs>
****** <sequencia>
****** <tipoOBS>
******* 01 - NFE,
******* 02 - OC,
******* 03 - NFE e OC,
******* 04 - NFS,
******* 05 - Pedido
******* 06 - NFS e PEDIDO,
******* 07 - OS,
******* 08 - OS/NFS e Pedido,
******* 09 - Geral,
******* 10 - Atividade,
******* 11 - Convênio,
******* 12 - Compl. Item Pedido,
******* 13 - Transportadora,
******* 14 - ANTT Transportadora,
******* 15 - Certidão Negativa de Débitos
****** <observacao>
***** </obs>
**** <permiteSobrescreverBranco>
***** Passar True ou False
***** Importante: Ao optar por "True" os parâmetro não enviados irão atualizar seus respectivos campos com branco.
**** <contabilClienteLongoPrazo>
**** <boletoRetencao>
**** <nif>
**** <identificacaoSCP>
**** <contabilClienteLongoPrazo>
**** <indicativoNif>
***** Em branco=Nenhum, 1=Beneficiário com NIF, 2=Beneficiário dispensado do NIF, 3=País não exige NIF
**** <formaTributacao>
**** <sobreFontePagadora>
**** <cpfProdutorRural>
**** <orgaoPublico>
*** </empresa>
** </empresas>
* </cadastroEmpresa>
}}

*Distribuição das Tags Json:
{{#tree:
*{
** "empresas": [
*** {
**** "codigo": "",
**** "nomeCompleto": "",
**** "contato": "",
**** "fone": "",
**** "faxFone": "",
**** "endereco": "",
**** "bairro": "",
**** "municipio": "",
**** "uf": "",
**** "cep": "",
**** "cnpjCpf": "",
**** "tipoInscricaoEstadual": "",
***** 0 - False, 1 - True
**** "inscricao": "",
***** Se o parâmetro "tipoInscricaoEstadual" for "false", o parâmetro "inscrição" deve ser “ISENTO”.
**** "conceito": "",
**** "divisao": "",
***** "codigoDivisao": "",
***** "descricao": "",
**** "dtNascimento": "",
**** "indicacao": "",
**** "representante": "",
**** "percentualComissaoBaixa": "",
**** "contabilCliente": "",
**** "responsavel": "",
**** "fantasia": "",
**** "pessoa": "",
***** 0 - Jurídica, 1 - Física
**** "identificacaoSCP": "",
**** "contabilFornecedor": "",
**** "condicaoPagamento": "",
**** "tipoPagamento": "",
**** "tipoOperacao": "",
**** "irrfAcumulado": "",
**** "tipoEmpresa": "",
**** "atividade": "",
**** "funcionarios": "",
**** "faturamento": "",
**** "limiteDeCredito": "",
**** "mercado": "",
**** "enviarCarta": "",
**** "tabelaPrecos": "",
**** "agendaInterna": "",
**** "pais": "",
**** "centralizadora": "",
**** "atrasoMedio": "",
**** "numero": "",
**** "complemento": "",
**** "inscricaoMunicipal": "",
**** "suframa": "",
**** "tipoFrete": "",
**** "percentualIndenizacao": "",
**** "percDescontoSugestaoItens": "",
**** "percentualDesconto2": "",
**** "jurosPadrao": "",
**** "unidadeDeNegocio": "",
**** "portadorPadrao": "",
**** "ativo": "",
***** Passar True ou False
**** "contabilAdiantamentoCliente": "",
**** "contabilAdiantamentoFornecedor": "",
**** "centroArmazenagem": "",
**** "indiceCredito": "",
**** "regiaoEntrega": "",
**** "dtValidadeCredito": "",
**** "setor": "",
**** "regimeTributario": "",
**** "dtUltimaConsultaCredito": "",
**** "validadeCobrancaAdmin": "",
**** "dtUltimaVenda": "",
**** "prefixoCnae": "",
**** "basePrazoDiferenciado": "",
**** "possuiRetencaoIss": "",
**** "centroArmazMaterailAlternativo": "",
**** "filtroDataDirf": "",
**** "tipoImovel": "",
**** "listarIss": "",
**** "diaVencimento": "",
**** "limiteFaturamento": "",
**** "grauRelacionamento": "",
**** "sufixoCnae": "",
**** "toleranciaVencimento": "",
**** "nivelCredito": "",
**** "listarDirf": "",
**** "conveniada": "",
**** "creditoLiberado": "",
**** "percentualFrete": "",
**** "codigoEan": "",
**** "percentualAcrescimoLimite": "",
**** "percentualAcrescimoPreco": "",
**** "utilizaPrazoDiferenciado": "",
**** "tgPadraoNfs": "",
**** "limiteCreditoMensal": "",
**** "optanteSimples": "",
**** "Usrempr1": "",
**** "Usrempr2": "",
**** "cnaeServico": "",
**** "Usrempr4": "",
**** "valorFrete": "",
**** "recebeEmailNfe": "",
***** opcoesAuxiliares,
***** posicao 1
**** "recebeEmailCartaCobranca": "",
**** "recebeEmailCobranca": "",
***** notificacaoBloquetoEmail,
***** posicao 1
**** "recebeEmailBoleto": "",
***** notificacaoBloquetoEmail,
***** posicao 2
**** "contatos": [
***** {
****** "sequenciaContato": "",
******* se não informado, assume a sequência 0 (zero)
****** "pessoaContato": "",
****** "email": "",
****** "fone /": "",
****** "recebeEmailNfe": "",
****** "recebeEmailCartaCobranca": "",
****** "recebeEmailCobranca": "",
****** "recebeEmailBoleto": "",
****** "fone": "",
****** "homePage": "",
****** "observacao": "",
****** "sid": "",
****** "senha": "",
****** "numeroIp": "",
****** "celular": "",
****** "ramal": "",
****** "foto": "",
****** "pessoaFisica": "",
****** "superior": "",
****** "sexo": "",
****** "tratamento": "",
****** "sessao": "",
****** "usuarioModificacao": "",
****** "usuarioCriacao": "",
****** "dataModificacao": "",
****** "setor": "",
****** "validadeCredenciamento": "",
****** "utilizaTransferPrice": "",
****** "contibuinteExclusivoISS": "",
****** "dataAtualizacao": "",
****** "contaFinanceira": "",
****** "relacionamento": "",
****** "controleRemessas": "",
****** "opcoesAuxiliares": "",
******* se informado,
******* ignora os campos separados
****** "validacaoContatoItemOs": "",
****** "recebeEmailPagamentos": "",
****** "notificacaoBloquetoEmail": "",
******* se informado,
******* ignora os campos separados
****** "tipoPessoa": "",
****** "recebeEmailSolicitacao": "",
****** "diaSemanaInicio": "",
****** "diaSemanaTermino": "",
****** "utilizarModalidadePagamento": "",
****** "recebeEmailAcompanhamento": "",
****** "participaPesquisaEmail": "",
****** "notificaVendaContrato": "",
****** "regraEnvioEmail": "",
****** "participacaoCotas": "",
****** "diasDuplicata": "",
****** "descontoAteVencimento": "",
****** "posicaoGeografica": "",
****** "tgTipoOS": "",
****** "funcao": "",
****** "Usrcemp1": "",
****** "Usrcemp2": "",
****** "Usrcemp3": "",
****** "rg": "",
****** "orgaoExpedidor": "",
****** "dataExpedicao": "",
***** }
**** ]
**** "obsEmpresa":[
***** {
***** "sequencia":"",
***** "tipoOBS":"",
****** 01 - NFE,
****** 02 - OC,
****** 03 - NFE e OC,
****** 04 - NFS,
****** 05 - Pedido
****** 06 - NFS e PEDIDO,
****** 07 - OS,
****** 08 - OS/NFS e Pedido,
****** 09 - Geral,
****** 10 - Atividade,
****** 11 - Convênio,
****** 12 - Compl. Item Pedido,
****** 13 - Transportadora,
****** 14 - ANTT Transportadora,
****** 15 - Certidão Negativa de Débitos
***** "observacao": ""
***** }
**** ]
**** "permiteSobrescreverBranco": "",
***** Passar True ou False
***** Importante: Ao optar por "True" os parâmetro não enviados irão atualizar seus respectivos campos com branco.
**** "contabilClienteLongoPrazo": "",
**** "boletoRetencao": "",
**** "nif": "",
**** "identificacaoSCP": "",
**** "contabilClienteLongoPrazo": "",
**** "indicativoNif": "",
***** Em branco=Nenhum, 1=Beneficiário com NIF, 2=Beneficiário dispensado do NIF, 3=País não exige NIF
**** "formaTributacao": "",
**** "sobreFontePagadora": "",
**** "cpfProdutorRural": "",
**** "orgaoPublico": ""
*** }
** ]
* }
}}
 
Retornos: 
   Se sucesso: 
      idRegistro - ID que representa este registro na tabela de integração. 
 
   Se pin inválido: 
      O usuário não possui direitos suficientes para executar esta rotina. 
 
   Se algum parâmetro inválido: 
      Parâmetro necessário não informado.
{{VoltarInicio}}

== ListarId ==



*Parâmetros: 
{{#tree: minExpandLevel=2 |

*pin
** Obrigatório, Tipo: String 20
}}

 
Retornos: 
   Se sucesso: 
{{#tree: minExpandLevel=2 |
*codigoEmpresa
** Tipo: String 6
}}
 
   Se pin inválido: 
      O usuário não possui direitos suficientes para executar esta rotina. 
 
   Se nenhum registro encontrado: 
      A consulta não retornou nenhum registro.
{{VoltarInicio}}

== ListarIndividual ==



*Parâmetros: 
{{#tree: minExpandLevel=2 |

*pin
** Obrigatório, Tipo: String 20

*codigoEmpresa
** Obrigatório, Tipo: String 6
}}
 
Retornos: 
   Se sucesso: 
{{#tree: minExpandLevel=2 |
*codigoEmpresa
** Tipo: String 6

*nomeCompleto
** Tipo: String 60

*contato
** Tipo: String 30

*fone
** Tipo: String 20

*faxFone
** Tipo: String 20

*endereco
** Tipo: String 40

*bairro
** Tipo: String 20

*municipio
** Tipo: String 30

*Uf
** Tipo: String 2

*cep
** Tipo: Int 8

*cnpjCpf
** Tipo: String 14

*inscrito
** Tipo: Bool

*inscricao
** Tipo: String 20

*conceito
** Tipo: String 1

*codigoDivisao
** Tipo: String 2

*dataNascimento
** Tipo: Date

*ultimoMovimento
** Tipo: Date

*cadastro
** Tipo: Date

*codigoIndicacao
** Tipo: String 6

*codigoRepresentante
** Tipo: String 6

*percentualComissaoBaixa
** Tipo: Float 3.2

*contabilCliente
** Tipo: String 8

*codigoResponsavel
** Tipo: String 6

*fantasia
** Tipo: String 20

*pessoa
** Tipo: Bool

*codigoContabilFornecedor
** Tipo: String 20

*codigoCondicaoPagamento
** Tipo: String 3

*codigoTipoPagamento
** Tipo: String 2

*codigoTipoOperacao
** Tipo: String 5

*irrfAcumulado
** Tipo: Float 13.2

*tipoEmpresa
** Tipo: String 2

*atividade
** Tipo: String 3

*funcionarios
** Tipo: Int 6

*faturamento
** Tipo: Float 13.2

*limiteCredito
** Tipo: Float 13.2

*codigoMercado
** Tipo: String 2

*codigoUsuarioModificacao
** Tipo: String 3

*enviarCarta
** Tipo: String 1

*tabelaPrecos
** Tipo: String 6

*agendaInterna
** Tipo: String 6

*codigoPais
** Tipo: String 3

*codigoCentralizadora
** Tipo: String 6

*atrasoMedio
** Tipo: Int 5

*numero
** Tipo: String 10

*complemento
** Tipo: String 15

*inscricaoMunicipal
** Tipo: String 20

*suframa
** Tipo: String 20

*tipoFrete
** Tipo: String 1

*percentualIndenizacao
** Tipo: Float 3.2

*percDescontoSugestaoItens
** Tipo: Float 3.2

*percentualDesconto2
** Tipo: Float 3.2

*jurosPadrao
** Tipo: Float 3.2

*codigoUnidadeNegocio
** Tipo: String 3

*codigoPortadorPadrao
** Tipo: String 3

*ativo
** Tipo: Bool

*sessao
** Tipo: Int 8

*codigoContabilAdiantamentoCli
** Tipo: String 8

*codigoContabilAdiantamentoForn
** Tipo: String 8

*codigoCentroArmazenagem
** Tipo: String 4

*codigoIndiceCredito
** Tipo: String 5

*codigoUsuarioCriacao
** Tipo: String 3

*dataModificacao
** Tipo: Date

*codigoRegiaoEntrega
** Tipo: String 3

*dataValidadeCredito
** Tipo: Date

*codigoSetor
** Tipo: String 25

*codigoRegimeTriburario
** Tipo: String 2

*ultimaConsultaCredito
** Tipo: Date

*validadeCobrancaAdmin
** Tipo: Date

*ultimaVenda
** Tipo: Date

*prefixoCnae
** Tipo: String 6

*basePrazoDiferenciado
** Tipo: String 6

*possuiRetencaoIss
** Tipo: String 6

*centroArmazenagemMaterialAlt
** Tipo: String 6

*filtroDataDirf
** Tipo: String 1

*tipoImovel
** Tipo: String 1

*listarIss
** Tipo: String 1

*diaVencimento
** Tipo: String 2

*limiteFaturamento
** Tipo: String 2

*grauRelacionamento
** Tipo: String 2

*sufixoCnae
** Tipo: String 3

*toleranciaVencimento
** Tipo: String 3

*nivelCredito
** Tipo: String 3

*listarDirf
** Tipo: Bool

*conveniada
** Tipo: Bool

*creditoLiberado
** Tipo: Bool

*percentualFrete
** Tipo: Float 3.4

*codigoEan
** Tipo: Float 13.1

*percentualAcrescimoLimite
** Tipo: Float 8.6

*percentualAcrescimoPreco
** Tipo: Float 8.6

*utilizaPrazoDiferenciado
** Tipo: Float 11.2

*tgPadraoNfs
** Tipo: Float 11.2

*limiteCreditoMensal
** Tipo: Float 13.2

*optanteSimples
** Tipo: Float 13.2

*Usrempr1
** Tipo: String 20

*Usrempr2
** Tipo: String 20

*cnaeServico
** Tipo: String 20

*Usrempr4
** Tipo: Date

*valorFrete
** Tipo: Float 11.2

*diasDuplicata
*descontoAteVencimento
*contabClienteLongoPrazo
*utilizaTransferPrice
*contribuinteExclusivoISS
}}
 
   Se pin inválido: 
      O usuário não possui direitos suficientes para executar esta rotina. 
 
   Se nenhum registro encontrado: 
      A consulta não retornou nenhum registro.
{{VoltarInicio}}

== ListarModificacoes ==



*Parâmetros: 
{{#tree: minExpandLevel=2 |

*pin
** Obrigatório, Tipo: String 20

*dataInicial
** Tipo: date

*horaInicial
** Tipo: time 6

*dataFinal
** Tipo: date

*horaFinal
** Tipo: time 6
}}
 
Retornos: 
   Se sucesso: 
{{#tree: minExpandLevel=2 |
*codigoEmpresa
** Tipo: String 6

*nomeCompleto
** Tipo: String 60

*contato
** Tipo: String 30

*fone
** Tipo: String 20

*faxFone
** Tipo: String 20

*endereco
** Tipo: String 40

*bairro
** Tipo: String 20

*municipio
** Tipo: String 30

*uf
** Tipo: String 2

*cep
** Tipo: Int 8

*cnpjCpf
** Tipo: String 14

*inscricao
** Tipo: String 20

*conceito
** Tipo: String 1

*codigoDivisao
** Tipo: String 2

*dataNascimento
** Tipo: Date

*ultimoMovimento
** Tipo: Date

*cadastro
** Tipo: Date

*codigoIndicacao
** Tipo: String 6

*codigoRepresentante
** Tipo: String 6

*percentualComissaoBaixa
** Tipo: Float 3.2

*contabilCliente
** Tipo: String 8

*codigoResponsavel
** Tipo: String 6

*fantasia
** Tipo: String 20

*pessoa
** Tipo: Bool

*codigoContabilFornecedor
** Tipo: String 20

*codigoCondicaoPagamento
** Tipo: String 3

*codigoTipoPagamento
** Tipo: String 2

*codigoTipoOperacao
** Tipo: String 5

*inscrito
** Tipo: Bool

*irrfAcumulado
** Tipo: Float 13.2

*tipoEmpresa
** Tipo: String 2

*atividade
** Tipo: String 3

*funcionarios
** Tipo: Int 6

*faturamento
** Tipo: Float 13.2

*limiteCredito
** Tipo: Float 13.2

*codigoMercado
** Tipo: String 2

*codigoUsuarioModificacao
** Tipo: String 3

*enviarCarta
** Tipo: String 1

*tabelaPrecos
** Tipo: String 6

*agendaInterna
** Tipo: String 6

*codigoPais
** Tipo: String 3

*codigoCentralizadora
** Tipo: String 6

*atrasoMedio
** Tipo: Int 5

*numero
** Tipo: String 10

*complemento
** Tipo: String 15

*inscricaoMunicipal
** Tipo: String 20

*suframa
** Tipo: String 20

*tipoFrete
** Tipo: String 1

*percentualIndenizacao
** Tipo: Float 3.2

*percDescontoSugestaoItens
** Tipo: Float 3.2

*percentualDesconto2
** Tipo: Float 3.2

*jurosPadrao
** Tipo: Float 3.2

*codigoUnidadeNegocio
** Tipo: String 3

*portadorPadrao
** Tipo: String 3

*ativo
** Tipo: Bool

*sessao
** Tipo: Int 8

*codigoContabilAdiantamentoCli
** Tipo: String 8

*codigoContabilAdiantamentoForn
** Tipo: String 8

*codigoCentroArmazenagem
** Tipo: String 4

*codigoIndiceCredito
** Tipo: String 5

*codigoUsuarioCriacao
** Tipo: String 3

*dataModificacao
** Tipo: Date

*codigoRegiaoEntrega
** Tipo: String 3

*validadeCredito
** Tipo: Date

*codigoSetor
** Tipo: String 25

*codigoRegimeTriburario
** Tipo: String 2

*ultimaConsultaCredito
** Tipo: Date

*validadeCobrancaAdmin
** Tipo: Date

*ultimaVenda
** Tipo: Date

*prefixoCnae
** Tipo: String 6

*basePrazoDiferenciado
** Tipo: String 6

*possuiRetencaoIss
** Tipo: String 6

*codigoCentroArmazenagemMatAlte
** Tipo: String 6

*filtroDataDirf
** Tipo: String 1

*tipoImovel
** Tipo: String 1

*listarIss
** Tipo: String 1

*diaVencimento
** Tipo: String 2

*limiteFaturamento
** Tipo: String 2

*grauRelacionamento
** Tipo: String 2

*sufixoCnae
** Tipo: String 3

*toleranciaVencimento
** Tipo: String 3

*nivelCredito
** Tipo: String 3

*listarDirf
** Tipo: Bool

*conveniada
** Tipo: Bool

*creditoLiberado
** Tipo: Bool

*percentualFrete
** Tipo: Float 3.4

*ean
** Tipo: Float 13.1

*percentualAcrescimoLimite
** Tipo: Float 8.6

*percentualAcrescimoPreco
** Tipo: Float 8.6

*utilizaPrazoDiferenciado
** Tipo: Float 11.2

*tgPadraoNfs
** Tipo: Float 11.2

*limiteCreditoMensal
** Tipo: Float 13.2

*optanteSimples
** Tipo: Float 13.2

*Usrempr1
** Tipo: String 20

*Usrempr2
** Tipo: String 20

*cnaeServico
** Tipo: String 20

*Usrempr4
** Tipo: Date

*valorFrete
** Tipo: Float 11.2
}}
 
   Se pin inválido: 
      O usuário não possui direitos suficientes para executar esta rotina. 
 
   Se nenhum registro encontrado: 
      A consulta não retornou nenhum registro.
{{VoltarInicio}}

== ListarPendentes ==



*Parâmetros: 
{{#tree: minExpandLevel=2 |

*pin
** Obrigatório, Tipo: String 20

*acao
** Tipo: String 1
** C=Cadastrar, E=Excluir
** Se for informado algo diferente de C ou E não será aplicado nenhum filtro

*statusRegistro
** Tipo: String 1
**L=Liberado, P=Pendente
** Se for informado algo diferente de P ou L não será aplicado nenhum filtro.}}

 
Retornos: 
   Se sucesso: 
{{#tree: minExpandLevel=2 |
*idRegistro
** Tipo: Int 14

*acao
** Tipo: String 1

*statusRegistro
** Tipo: String 1

*dataRequisicao
** Tipo: Date

*horaRequisicao
** Tipo: Int 8

*idCorrelato
** Tipo: Int 14

*codigoEmpresa
** Tipo: String 6

*nomeCompleto
** Tipo: String 60

*cnpjCpf
** Tipo: String 14
}}

 
   Se pin inválido: 
      O usuário não possui direitos suficientes para executar esta rotina. 
 
   Se nenhum registro encontrado: 
      A consulta não retornou nenhum registro.
{{VoltarInicio}}

== LiberarPendentes ==



*Parâmetros: 
{{#tree: minExpandLevel=2 |

*pin
** Obrigatório, Tipo: String 20

*id
** Obrigatório, Tipo: Int

*liberarCorrelatos
** Tipo: Bool
}}

 
Retornos: 
   Se pin inválido: 
      O usuário não possui direitos suficientes para executar esta rotina. 
 
   Se erro na conexão com banco de dados: 
      A conexão com o banco de dados e/ou comando SQL possui erros. 
 
   Se ID inválido ou não encontrado: 
      Falha ao liberar registro. 
 
   Se sucesso: 
      Sucesso.
{{VoltarInicio}}

== ListarPorCnpjCpf ==



*Parâmetros: 
{{#tree: minExpandLevel=2 |

*pin
** Obrigatório, Tipo: String 20

*cnpjCpf
** Tipo: String 14

*listarEndereco
** Obrigatório, Tipo: Bool 1
}}
 
Retornos: 
   Se sucesso: 
{{#tree: minExpandLevel=2 |
*codigoEmpresa
** Tipo: String 6

*nomeCompleto
** Tipo: String 60

*fantasia
** Tipo: String 20

*endereco
** Tipo: String 40

*bairro
** Tipo: String 20

*municipio
** Tipo: String 30

*uf
** Tipo: String 2

*cep
** Tipo: Int 7

*numero
** Tipo: String 10

*complemento
** Tipo: String 15

*codigoPais
** Tipo: String 3
}}
 
   Se pin inválido: 
      O usuário não possui direitos suficientes para executar esta rotina. 
 
   Se nenhum registro encontrado: 
      A consulta não retornou nenhum registro. 
 
    Se listarEndereco for falso, então só ira listar empresa, nomeCompleto e fantasia.
{{VoltarInicio}}

== ListarEmpresas ==



*Parâmetros: 
{{#tree: minExpandLevel=2 |
*pin
** Obrigatório, Tipo: String 20

*codigoEmpresaInicial
** Tipo: String 6

*codigoEmpresaFinal
** Tipo: String 6

*nomeInicial
** Tipo: String 60

*nomeFinal
** Tipo: String 60

*fantasiaInicial
** Tipo: String 20

*fantasiaFinal
** Tipo: String 20

*pessoa
** Tipo: Bool

*codigoDivisaoinicial
** Tipo: String 2

*codigoDivisaoFinal
** Tipo: String 2

*codigoAtividadeInicial
** Tipo: String 3

*codigoAtividadeFinal
** Tipo: String 3

*cnpjCpfInicial
** Tipo: String 14

*cnpjCpfFinal
** Tipo: String 14

*municipioInicial
** Tipo: String 30

*municipioFinal
** Tipo: String 30

*ativo
** Tipo: Bool

*dataInicial
** Tipo: Date

*horaInicial
** Tipo: Time 6

*dataFinal
** Tipo: Date

*horaFinal
** Tipo: Time 6
}}
 
Retornos: 
   Se sucesso: 
{{#tree: minExpandLevel=2 |
*codigoEmpresa
** Tipo: String 6

*nomeCompleto
** Tipo: String 60

*contato
** Tipo: String 30

*fone
** Tipo: String 20

*faxFone
** Tipo: String 20

*endereco
** Tipo: String 40

*bairro
** Tipo: String 20

*municipio
** Tipo: String 30

*uf
** Tipo: String 2

*cep
** Tipo: Int 8

*cnpjCpf
** Tipo: String 14

*inscricao
** Tipo: String 20

*conceito
** Tipo: String 1

*codigoDivisao
** Tipo: String 2

*dataNascimento
** Tipo: Date

*ultimoMovimento
** Tipo: Date

*cadastro
** Tipo: Date

*codigoIndicacao
** Tipo: String 6

*codigoRepresentante
** Tipo: String 6

*percentualComissaoBaixa
** Tipo: Float 3.2

*contabilCliente
** Tipo: String 8

*codigoResponsavel
** Tipo: String 6

*fantasia
** Tipo: String 20

*pessoa
** Tipo: Bool

*codigoContabilFornecedor
** Tipo: String 20

*codigoCondicaoPagamento
** Tipo: String 3

*codigoTipoPagamento
** Tipo: String 2

*codigoTipoOperacao
** Tipo: String 5

*inscrito
** Tipo: Bool

*irrfAcumulado
** Tipo: Float 13.2

*tipoEmpresa
** Tipo: String 2

*atividade
** Tipo: String 3

*funcionarios
** Tipo: Int 6

*faturamento
** Tipo: Float 13.2

*limiteCredito
** Tipo: Float 13.2

*codigoMercado
** Tipo: String 2

*codigoUsuarioModificacao
** Tipo: String 3

*enviarCarta
** Tipo: String 1

*tabelaPrecos
** Tipo: String 6

*agendaInterna
** Tipo: String 6

*codigoPais
** Tipo: String 3

*codigoCentralizadora
** Tipo: String 6

*atrasoMedio
** Tipo: Int 5

*numero
** Tipo: String 10

*complemento
** Tipo: String 15

*inscricaoMunicipal
** Tipo: String 20

*suframa
** Tipo: String 20

*tipoFrete
** Tipo: String 1

*percentualIndenizacao
** Tipo: Float 3.2

*percDescontoSugestaoItens
** Tipo: Float 3.2

*percentualDesconto2
** Tipo: Float 3.2

*jurosPadrao
** Tipo: Float 3.2

*codigoUnidadeNegocio
** Tipo: String 3

*portadorPadrao
** Tipo: String 3

*ativo
** Tipo: Bool

*sessao
** Tipo: Int 8

*codigoContabilAdiantamentoCli
** Tipo: String 8

*codigoContabilAdiantamentoForn
** Tipo: String 8

*codigoCentroArmazenagem
** Tipo: String 4

*codigoIndiceCredito
** Tipo: String 5

*codigoUsuarioCriacao
** Tipo: String 3

*dataModificacao
** Tipo: Date

*codigoRegiaoEntrega
** Tipo: String 3

*validadeCredito
** Tipo: Date

*codigoSetor
** Tipo: String 25

*codigoRegimeTriburario
** Tipo: String 2

*ultimaConsultaCredito
** Tipo: Date

*validadeCobrancaAdmin
** Tipo: Date

*ultimaVenda
** Tipo: Date

*prefixoCnae
** Tipo: String 6

*basePrazoDiferenciado
** Tipo: String 6

*possuiRetencaoIss
** Tipo: String 6

*codigoCentroArmazenagemMatAlte
** Tipo: String 6

*filtroDataDirf
** Tipo: String 1

*tipoImovel
** Tipo: String 1

*listarIss
** Tipo: String 1

*diaVencimento
** Tipo: String 2

*limiteFaturamento
** Tipo: String 2

*grauRelacionamento
** Tipo: String 2

*sufixoCnae
** Tipo: String 3

*toleranciaVencimento
** Tipo: String 3

*nivelCredito
** Tipo: String 3

*listarDirf
** Tipo: Bool

*conveniada
** Tipo: Bool

*creditoLiberado
** Tipo: Bool

*percentualFrete
** Tipo: Float 3.4

*ean
** Tipo: Float 13.1

*percentualAcrescimoLimite
** Tipo: Float 8.6

*percentualAcrescimoPreco
** Tipo: Float 8.6

*utilizaPrazoDiferenciado
** Tipo: Float 11.2

*tgPadraoNfs
** Tipo: Float 11.2

*limiteCreditoMensal
** Tipo: Float 13.2

*optanteSimples
** Tipo: Float 13.2

*Usrempr1
** Tipo: String 20

*Usrempr2
** Tipo: String 20

*cnaeServico
** Tipo: String 20

*Usrempr4
** Tipo: Date

*valorFrete
** Tipo: Float 11.2
}}
 
   Se pin inválido: 
      O usuário não possui direitos suficientes para executar esta rotina. 
 
   Se nenhum registro encontrado: 
      A consulta não retornou nenhum registro.
{{VoltarInicio}}

== ListarEmpresasCompleto ==



*Parâmetros: 
{{#tree: minExpandLevel=2 |
*pin
** Obrigatório, Tipo: String 20

*codigoEmpresaInicial
** Tipo: String 6

*codigoEmpresaFinal
** Tipo: String 6

*nomeInicial
** Tipo: String 60

*nomeFinal
** Tipo: String 60

*fantasiaInicial
** Tipo: String 20

*fantasiaFinal
** Tipo: String 20

*pessoa
** Tipo: Bool

*codigoDivisaoinicial
** Tipo: String 2

*codigoDivisaoFinal
** Tipo: String 2

*codigoAtividadeInicial
** Tipo: String 3

*codigoAtividadeFinal
** Tipo: String 3

*cnpjCpfInicial
** Tipo: String 14

*cnpjCpfFinal
** Tipo: String 14

*municipioInicial
** Tipo: String 30

*municipioFinal
** Tipo: String 30

*ativo
** Tipo: Bool

*dataInicial
** Tipo: Date

*horaInicial
** Tipo: Time 6

*dataFinal
** Tipo: Date

*horaFinal
** Tipo: Time 6

*suprimirNivelFilhoVazio
}}
 
Retornos: 
   Se sucesso: 
{{#tree: minExpandLevel=4 |
*cadastroEmpresa
**empresas
***empresa
****codigo
***** Tipo: String 6
****nomeCompleto
***** Tipo: String 60
****contato
***** Tipo: String 30
****fantasia
***** Tipo: String 20
****pessoa
***** Tipo: Bool
****fone
***** Tipo: String 20
****faxFone
***** Tipo: String 20
****endereco
***** Tipo: String 40
****bairro
***** Tipo: String 20
****municipio
***** Tipo: String 30
****numero
****complemento
****uf
***** Tipo: String 2
****cnpjCpf
***** Tipo: String 14
****inscricao
***** Tipo: String 20
****tipoInscricaoEstadual
****conceito
*****codigoConceito
*****ordem
*****descricao
*****bloqueiaPedido
*****bloqueiaNfSaida
*****bloqueiaOrdem
*****bloqueiaNfEntrada
*****bloqueiaOrcamento
*****bloqueiaSolicitacao
****divisao
*****codigoDivisao
*****descricao
****aniversario
****cadastro
***** Tipo: Date
****indicacao
*****codigo
*****nomeCompleto
****representante
*****codigo
*****nomeCompleto
****contabilCliente
***** Tipo: String 8
****responsavel
*****codigo
*****nomeCompleto
****contabilFornecedor
***** Tipo: String 20
****condicaoPagamento
***** Tipo: String 3
****tipoPagamento
***** Tipo: String 2
****tipoOperacao
*****codigoTipoOperacao
*****descricao
*****codigoNatureza
*****descricaoNatureza
****tipoEmpresa
*****codigo
*****descricao
****atividade
*****codigo
*****descricao
****mercado
*****codigo
*****descricao
****usuarioModificacao
****enviarCarta
****tabelaDePreco
*****codigo
*****descricao
****agendaInterna
***** Tipo: String 6
****pais
*****codigo
*****descricao
*****codigoBacen
****centralizadora
*****codigo
*****nomeCompleto
****inscricaoMunicipal
***** Tipo: String 20
****suframa
***** Tipo: String 20
****tipoFrete
***** Tipo: String 1
****ultimaAtualizacao
****unidadeDeNegocio
*****codigo
*****descricao
****portadorPadrao
***** Tipo: String 3
****ativo
***** Tipo: Bool
****sessao
***** Tipo: Int 8
****contabilAdiantamentoCliente
***** Tipo: String 8
****contabilAdiantamentoFornecedor
***** Tipo: String 8
****centroArmazenagem
*****codigo
*****descricao
****indiceCredito
***** Tipo: String 5
****usuarioCriacao
***** Tipo: String 3
****dataModificacao
***** Tipo: Date
****regiaoEntrega
**** Tipo: String 3
****setor
*****codigo
*****descricao
****regimeTributario
***** Tipo: String 2
****prefixoCNAE
***** Tipo: String 6
****basePrazoDiferenciado
***** Tipo: String 6
****possuiRetencaoISS
***** Tipo: String 6
****centroArmazeMaterialAlternativo
*****codigo
*****descricao
****filtroDataDIRF
***** Tipo: String 1
****tipoImovel
***** Tipo: String 1
****listarISS
***** Tipo: String 1
****diaVencimento
***** Tipo: String 2
****limiteFaturamento
***** Tipo: String 2
****grauDeRelacionamento
***** Tipo: String 2
****sufixoCNAE
***** Tipo: String 3
****toleranciaVencimento
***** Tipo: String 3
****nivelDeCredito
**** Tipo: String 3
****creditoLiberado
***** Tipo: Bool
****cnaeServico
****contatos
****contatoEmpresa
*****sequenciaContato
*****pessoaContato
*****email
*****fone
*****recebeEmailNfe
*****recebeEmailCartaCobranca
*****recebeEmailCobranca
*****recebeEmailBoleto
*****rg
*****orgaoExpedidor
****email
****recebeEmailNfe
****recebeEmailCartaCobranca
****recebeEmailCobranca
****recebeEmailBoleto
****obsEmpresa
*****observacaoEmpresa
******sequencia
******tipoOBS
******observacao
****nif
****identificacaoSCP
****contabilClienteLongoPrazo
****boletoRetencao
****indicativoNif
*****Em branco=Nenhum, 1=Beneficiário com NIF, 2=Beneficiário dispensado do NIF, 3=País não exige NIF
****formaTributacao
****sobreFontePagadora
****cpfProdutorRural
}}
 
   Se pin inválido: 
      O usuário não possui direitos suficientes para executar esta rotina. 
 
   Se nenhum registro encontrado: 
      A consulta não retornou nenhum registro.
{{VoltarInicio}}

== ListarEmpresasPorRepresentante ==



*Parâmetros: 
{{#tree: minExpandLevel=2 |
*pin
** Obrigatório, Tipo: String 20

*codigoRepresentante
** Obrigatório, Tipo: String 6

*somenteAtivos
** Tipo: Bool
}}
 
Retornos: 
   Se sucesso: 
{{#tree: minExpandLevel=2 |
*codigoEmpresa
** Tipo: String 6

*nomeCompleto
** Tipo: String 60

*fantasia
** Tipo: String 20

*contato
** Tipo: String 30

*cnpjCpf
** Tipo: String 14

*fone
** Tipo: String 20

*faxFone
** Tipo: String 20

*endereco
** Tipo: String 40

*bairro
** Tipo: String 20

*municipio
** Tipo: String 30

*uf
** Tipo: String 2

*cep
** Tipo: Int 8

*inscrito
** Tipo: Bool

*inscricao
** Tipo: String 20

*conceito
** Tipo: String 1

*codigoDivisao
** Tipo: String 2

*descricaoDivisao
** Tipo: String 20

*dataNascimento
** Tipo: Date

*ultimoMovimento
** Tipo: Date

*cadastro
** Tipo: Date

*codigoIndicacao
** Tipo: String 6

*codigoRepresentante
** Tipo: String 6

*nomeCompletoRepresentante
** Tipo: String 60

*percentualComissaoBaixa
** Tipo: Float 3.2

*contabilCliente
** Tipo: String 8

*codigoResponsavel
** Tipo: String 6

*pessoa
** Tipo: Bool

*codigoContabilFornecedor
** Tipo: String 8

*codigoCondicaoPagamento
** Tipo: String 3

*codigoTipoPagamento
** Tipo: String 2

*codigoTipoOperacao
** Tipo: String 5

*irrfAcumulado
** Tipo: Float 13.2

*tipoEmpresa
** Tipo: String 2

*atividade
** Tipo: String 3

*funcionarios
** Tipo: Int 6

*faturamento
** Tipo: Float 13.2

*limiteCredito
** Tipo: Float 13.2

*codigoMercado
** Tipo: String 2

*codigoUsuarioModificacao
** Tipo: String 3

*enviarCarta
** Tipo: String 1

*tabelaPrecos
** Tipo: String 6

*agendaInterna
** Tipo: String 6

*codigoPais
** Tipo: String 3

*codigoCentralizadora
** Tipo: String 6

*atrasoMedio
** Tipo: Int 5

*numero
** Tipo: String 10

*complemento
** Tipo: String 15

*inscricaoMunicipal
** Tipo: String 20

*suframa
** Tipo: String 20

*tipoFrete
** Tipo: String 1

*percentualIndenizacao
** Tipo: Float 3.2

*percDescontoSugestaoItens
** Tipo: Float 3.2

*percentualDesconto2
** Tipo: Float 3.2

*jurosPadrao
** Tipo: Float 3.2

*ultimaAtualizacao
** Tipo: Date

*codigoUnidadeNegocio
** Tipo: String 3

*nomeCompletoUnidadeNegocio
** Tipo: String 60

*codigoPortadorPadrao
** Tipo: String 3

*ativo
** Tipo: Bool

*sessao
** Tipo: Int 8

*codigoContabilAdiantamentoCli
** Tipo: String 8

*codigoContabilAdiantamentoForn
** Tipo: String 8

*codigoCentroArmazenagem
** Tipo: String 4

*codigoIndiceCredito
** Tipo: String 5

*codigoUsuarioCriacao
** Tipo: String 3

*dataModificacao
** Tipo: Date

*codigoRegiaoEntrega
** Tipo: String 3

*dataValidadeCredito
** Tipo: Date

*codigoSetor
** Tipo: String 25

*codigoRegimeTributario
** Tipo: String 2

*ultimaConsultaCredito
** Tipo: Date

*validadeCobrancaAdmin
** Tipo: Date

*ultimaVenda
** Tipo: Date

*prefixoCnae
** Tipo: String 6

*basePrazoDiferenciado
** Tipo: String 6

*possuiRetencaoIss
** Tipo: String 6

*codigoCentroArmazenagemMatAlte
** Tipo: String 6

*filtroDataDirf
** Tipo: String 1

*tipoImovel
** Tipo: String 1

*listarIss
** Tipo: String 1

*diaVencimento
** Tipo: String 2

*limiteFaturamento
** Tipo: String 2

*grauRelacionamento
** Tipo: String 3

*sufixoCnae
** Tipo: String 3

*toleranciaVencimento
** Tipo: String 3

*nivelCredito
** Tipo: String 3

*listarDirf
** Tipo: Bool

*conveniada
** Tipo: Bool

*creditoLibefrado
** Tipo: Bool

*PercentualFrete
** Tipo: Float 3.4

*codigoEan
** Tipo: Float 13.1

*percentualAcrescimoLimite
** Tipo: Float 8.6

*percentualAcrescimoPreco
** Tipo: Float 8.6

*utilizaPrazoDiferenciado
** Tipo: Float 11.2

*tgPadraoNfs
** Tipo: Float 11.2

*limiteCreditoMensal
** Tipo: Float 13.2

*optanteSimples
** Tipo: Float 13.2

*Usrempr1
** Tipo: String 20

*Usrempr2
** Tipo: String 20

*cnaeServico
** Tipo: String 20

*Usrempr4
** Tipo: Date

*valorFrete
** Tipo: Float 1.2
}}
 
   Se pin inválido: 
      O usuário não possui direitos suficientes para executar esta rotina. 
 
   Se nenhum registro encontrado: 
      A consulta não retornou nenhum registro.
{{VoltarInicio}}

== ListarRepresentantesPorEmpresa ==



*Parâmetros: 
{{#tree: minExpandLevel=2 |
*pin
** Obrigatório, Tipo: String 20

*codigoEmpresa
** Obrigatório, Tipo: String 6
}}
 
Retornos: 
   Se sucesso: 
{{#tree: minExpandLevel=2 |
*codigoRepresentante
** Tipo: String 6

*nomeCompleto
** Tipo: String 60

*Fantasia
** Tipo: String 20

*Contato
** Tipo: String 30
}}
 
   Se pin inválido: 
      O usuário não possui direitos suficientes para executar esta rotina. 
 
   Se nenhum registro encontrado: 
      A consulta não retornou nenhum registro.
{{VoltarInicio}}

== ListarEmpresasPorCentralizadora ==



*Parâmetros: 
{{#tree: minExpandLevel=2 |
*pin
** Obrigatório, Tipo: String 20

*codigoCentralizadora
** Tipo: String 6
}}
 
Retornos: 
   Se sucesso: 
{{#tree: minExpandLevel=2 |
*codigoEmpresa
** Tipo: String 6

*nomeCompleto
** Tipo: String 60
}}
 
   Se pin inválido: 
      O usuário não possui direitos suficientes para executar esta rotina. 
 
   Se nenhum registro encontrado: 
      A consulta não retornou nenhum registro.
{{VoltarInicio}}

== Excluir ==



*Parâmetros: 
{{#tree: minExpandLevel=2 |

*pin
** Obrigatório, Tipo: String 20

*codigoEmpresa
** Obrigatório, Tipo: String 6
}}
 
Retornos: 
   Se sucesso: 
      idRegistro - ID que representa este registro na tabela de integração. 
 
   Se pin inválido: 
      O usuário não possui direitos suficientes para executar esta rotina.
{{VoltarInicio}}

GE Abrir Aplicação

2025-04-07T17:58:59Z

Alessandro.voto:

[[Utilidades/Diversos]] > [[GE_Utilidades|Utilidades]] > [[GE_Abrir Aplicação|Abrir Aplicação]]

A funcionalidade tem por objetivo facilitar o acesso a aplicações independentes ou seja que não dependem de toda a estrutura CIGAM para rodar, sendo assim é possível através do link aplicações indicar o nome e o caminho do ecf a ser aberto. 
 
As aplicações disponíveis para acesso são: ERP CIGAM, Atualização, Manutenção e Users Dump. Essas aplicações contemplam várias funcionalidades com recursos distintos visando atender as necessidades referentes ao ERP CIGAM. 
*ERP CIGAM
*[[GE - Como Fazer - Atualização CIGAM #Como abrir o CGAtualização? | Atualização]]
*[[GE_Manutenção|Manutenção]]
*[[GE_UsersDump|Users Dump]]
Esta aplicação tem por objetivo o carregamento de usuários/direitos do arquivo de segurança Magic para o CIGAM e a auditoria destes, dentro do mesmo recurso.

IN CIGAM Integrador

2025-03-14T11:54:16Z

Alessandro.voto: /* Tabela de integração e log */

{{VoltarPagina}}
[[Integrador]] > [[IN_CIGAM Integrador|Integrador padrão]]

Quando as aplicações estiverem obtendo dados do CIGAM via consumo do respectivo serviço ou da respectiva camada de objetos de banco de dados, os parâmetros de data e hora do controle de gravação dos registros serão solicitados. Dessa forma se torna possível filtrar os registros de acordo com a data e hora em que estes sofreram alterações. Quando não informados, todos os dados do respectivo cadastro serão retornados. Nenhum controle por flag de leitura ou de integração será controlado pelo CIGAM e caso seja necessário, tal controle será feito pelos aplicativos dos terceiros em suas tabelas.


Para integração deve-se informar parâmetros para a chave-única do cadastro para que se possa obter dados de apenas um registro (quando informado). O controle de acesso se feito através do parâmetro para a informação do PIN (que será detalhado mais adiante).


Quando as aplicações de terceiros estiverem enviando dados para o CIGAM, tais dados serão inseridos na tabela de integração caso tenham sido aceitos. A importação/processamento somente será feita quando o programa específico da Aplicação de Importação for executado. Caso o dado não seja aceito, nenhum registro será inserido na tabela de integração e apenas a mensagem de erro (com código do erro e descrição) será enviada ao chamador.


Para controle de existência de registros as camadas de consultas irão disponibilizar uma lista com todos os registros cadastrados na tabela. Essa lista conterá somente os campos chaves e com ela será possível que a aplicação do terceiro compare com sua base cadastrada para saber quais registros foram excluídos.


Caso a tabela tenha um grande número de registros ou se existem muitas exclusões, poderá ser criada uma trigger a qual consome o respectivo serviço a cada exclusão (cabe lembrar que a utilização de triggers interfere na performance da aplicação agravando-se ainda mais quando utilizada por requisições de webservices).

= Serviços disponíveis =

== Compras ==
*[[IN_CadastroRequisicaoMaterial.integrador|CadastroRequisicaoMaterial.integrador]]
*[[IN_CadastroItemRequisicaoMaterial.integrador|CadastroItemRequisicaoMaterial.integrador]]
*[[IN_CadastroGradeRequisicaoMaterial.integrador|CadastroGradeRequisicaoMaterial.integrador]]
*[[IN_EfetivacaoRequisicaoMaterial.integrador|EfetivacaoRequisicaoMaterial.integrador]]
*[[IN_CadastroSolicitacaoMaterial.integrador|CadastroSolicitacaoMaterial.integrador]]
*[[IN_CadastroItemSolicitacaoMaterial.integrador|CadastroItemSolicitacaoMaterial.integrador]]
*[[IN_CadastroGradeSolicitacaoMaterial.integrador|CadastroGradeSolicitacaoMaterial.integrador]]
*[[IN_CadastroPreNota.integrador|CadastroPreNota.integrador]]
*[[IN_CadastroNotaFiscal.integrador|CadastroNotaFiscal.integrador]]
*[[IN_CadastroOrdemCompra.integrador|CadastroOrdemCompra.integrador]]
*[[IN_CadastroItemOrdemCompra.integrador|CadastroItemOrdemCompra.integrador]]

== Configurador ==
*[[IN_CadastroCaracteristica.integrador|CadastroCaracteristica.integrador]]
*[[IN_CadastroCaracteristicaConfigurador.integrador|CadastroCaracteristicaConfigurador.integrador]]
*[[IN_CadastroConfigurador.integrador|CadastroConfigurador.integrador]]
*[[IN_CadastroConfiguradorProduto.integrador|CadastroConfiguradorProduto.integrador]]
*[[IN_CadastroConteudoCaracteristica.integrador|CadastroConteudoCaracteristica.integrador]]
*[[IN_CadastroIdentificador.integrador|CadastroIdentificador.integrador]]

== Estoque ==
*[[IN_CadastroBalanco.integrador|CadastroBalanco.integrador]]
*[[IN_CadastroCaracteristicasMateriaisTg.integrador|CadastroCaracteristicasMateriaisTg.integrador]]
*[[IN_CadastroCaracValidasParametros.integrador|CadastroCaracValidasParametros.integrador]]
*[[IN_CadastroCentroArmazenagem.integrador|CadastroCentroArmazenagem.integrador]]
*[[IN_CadastroClassificacaoFiscal.integrador|CadastroClassificacaoFiscal.integrador]]
*[[IN_CadastroComplementoMaterial.integrador|CadastroComplementoMaterial.integrador]]
*[[IN_CadastroEspecif1.integrador|CadastroEspecif1.integrador]]
*[[IN_CadastroEspecif2.integrador|CadastroEspecif2.integrador]]
*[[IN_CadastroEspecif3.integrador|CadastroEspecif3.integrador]]
*[[IN_CadastroEspecif4.integrador|CadastroEspecif4.integrador]]
*[[IN_CadastroEspecif5.integrador|CadastroEspecif5.integrador]]
*[[IN_CadastroEspecif6.integrador|CadastroEspecif6.integrador]]
*[[IN_CadastroGradeMovimento.integrador|CadastroGradeMovimento.integrador]]
*[[IN_CadastroGradePadrao.integrador|CadastroGradePadrao.integrador]]
*[[IN_CadastroGrupos.integrador|CadastroGrupos.integrador]]
*[[IN_CadastroInventarioEstoque.integrador|CadastroInventarioEstoque.integrador]]
*[[IN_CadastroInventarioItens.integrador|CadastroInventarioItens.integrador]]
*[[IN_CadastroListaMateriais.integrador|CadastroListaMateriais.integrador]]
*[[IN_CadastroMateriais.integrador|CadastroMateriais.integrador]]
*[[IN_CadastroMateriaisTg.integrador|CadastroMateriaisTg.integrador]]
*[[IN_CadastroMovimento.integrador|CadastroMovimento.integrador]]
*[[IN_CadastroMovimentoEstoque.integrador|CadastroMovimentoEstoque.integrador]]
*[[IN_CadastroNumeracaoGrade.integrador|CadastroNumeracaoGrade.integrador]]
*[[IN_CadastroParametrosPlanejamento.integrador|CadastroParametrosPlanejamento.integrador]]
*[[IN_CadastroRegraFiscal.integrador|CadastroRegraFiscal.integrador]]
*[[IN_CadastroRegraParametrosPlanejamento.integrador|CadastroRegraParametrosPlanejamento.integrador]]
*[[IN_CadastroSubGrupos.integrador|CadastroSubGrupos.integrador]]
*[[IN_CadastroUnidadeMedida.integrador|CadastroUnidadeMedida.integrador]]
*[[IN_CadastroPosicaoEstoque.integrador|CadastroPosicaoEstoque.integrador]]
*[[IN_ModificarPesosEVolume.integrador|ModificarPesosEVolume.integrador]]

== Faturamento ==
*[[IN_CancelamentoNotaFiscal.integrador|CancelamentoNotaFiscal.Integrador]]
*[[IN_CadastroCondicaoPagamento.integrador|CadastroCondicaoPagamento.Integrador]]

*[[IN_CadastroItensPedido.integrador|CadastroItensPedido.Integrador]]

*[[IN_CadastroNotaFiscal.integrador|CadastroNotaFiscal.Integrador]]
*[[IN_CadastroPedidos.integrador|CadastroPedidos.Integrador]]
*[[IN_CadastroPrazoPagamento.integrador|CadastroPrazoPagamento.Integrador]]

== Financeiro ==
*[[IN_CadastroContaGerencial.integrador|CadastroContaGerencial.integrador]]
*[[IN_CadastroContasFinanceiras.integrador|CadastroContasFinanceiras.integrador]]
*[[IN_CadastroContratos.integrador|CadastroContratos.integrador]]
*[[IN_CadastroHistoricos.integrador|CadastroHistoricos.integrador]]
*[[IN_CadastroLancamentos.integrador|CadastroLancamentos.integrador]]
*[[IN_CadastroObjetoContrato.integrador|CadastroObjetoContrato.integrador]]

*[[IN_CadastroPortadores.integrador|CadastroPortadores.integrador]]
*[[IN_CadastroTipoPagamento.integrador|CadastroTipoPagamento.integrador]]



== Genérico ==

*[[IN_CadastroCategoriasTg.integrador|CadastroCategoriasTg.integrador]]
*[[IN_CadastroColaboradores.integrador|CadastroColaboradores.integrador]]
*[[IN_CadastroContatosEmpresas.integrador|CadastroContatosEmpresas.integrador]]
*[[IN_CadastroControleTg.integrador|CadastroControleTg.integrador]]
*[[IN_CadastroElementosTg.integrador|CadastroElementosTg.integrador]]
*[[IN_CadastroEmpresas.integrador|CadastroEmpresas.integrador]]
*[[IN_CadastroEnderecosCobrancaEmpresas.integrador|CadastroEnderecosCobrancaEmpresas.integrador]]
*[[IN_CadastroEnderecosEntregaEmpresas.integrador|CadastroEnderecosEntregaEmpresas.integrador]]
*[[IN_CadastroEstados.integrador|CadastroEstados.integrador]]
*[[IN_CadastroMunicipios.integrador|CadastroMunicipios.integrador]]
*[[IN_CadastroObservacaoEmpresa.integrador|CadastroObservacaoEmpresa.integrador]]
*[[IN_CadastroPaises.integrador|CadastroPaises.integrador]]
*[[IN_CadastroRegraDesconto.integrador|CadastroRegraDesconto.integrador]]
*[[IN_CadastroTabelaPreco.integrador|CadastroTabelaPreco.integrador]]
*[[IN_CadastroTipoOperacao.integrador|CadastroTipoOperacao.integrador]]
*[[IN_Log.integrador|Log.integrador]]

== Projetos ==
* [[IN_CadastroProjeto.integrador|CadastroProjeto.integrador]]
* [[IN_CadastroTipoProjeto.integrador|CadastroTipoProjeto.integrador]]

= Estrutura dos registros =

A tabela de integração deve receber os registros a serem importados pelo CIGAM. Nessa tabela, todos os tipos de cadastros serão incluídos e um campo ‘Tipo’ irá identificar o tipo de registro/rotina que irá fazer a importação. 
   Exemplo:
 
      MATCAD Cadastro de materiais 
      EMPCAD Cadastro de empresas 
 
Essa tabela tem um grande número de campos para contemplar qualquer tipo de cadastro do CIGAM. Somente os campos de ID e tipo serão indexados. 
A camada de serviços é a porta de entrada para as integrações. Existirá um serviço para cada tipo de cadastro/registro. Nesse serviço, além dos parâmetros
necessários, existirá também o parâmetro PIN que identificará o usuário/aplicativo que está fazendo a requisição. 
Existirá um campo para controle do status do registro na tabela de integração. Esse controle será feito no registro máster quando houver relacionamento máster detalhe. Esse controle é necessário para que somente seja importado o relacionamento inteiro e evite que o programa de importação execute um ciclo exatamente no momento em que os dados estejam sendo inseridos na tabela
de integração. Logicamente, o status do registro máster será liberado somente após todos os registros de detalhe terem sido incluídos. Também existe a estratégia que o programa que faz a importação sempre inicie pelo registro máster, e nesse caso, inserindo-o por último na tabela de integração, também será garantia de integridade. 
Existirá um webservice para listagem da tabela de integração que permitirá a filtrar a consulta por ID da tabela, data da inclusão do registro ou por tipo do registro e ou ambos. Essa consulta auxilia as aplicações de terceiros a controlarem se tal registro integrado já foi importado.

== Validação de parâmetros ==

No momento da requisição do serviço, caso haja algum parâmetro definido como obrigatório e não informado, é retornada uma mensagem de erro com o nome do parâmetro.
Caso tenha mais de uma ocorrência, os demais nomes de parâmetros também serão listados. 
Para parâmetros que possuem dependência de outro parâmetro, é exibido um asterisco (<*>) após o nome.

== Tabela de integração e log ==

*'''Tabelas envolvidas:''' 
**Integração %GEINTEGRADOR% 
**Log de integração %GEINTEGRADORLOG% 
 
Todas as alterações de dados requisitadas para o CIGAM ficarão na tabela de integração até seu processamento pela Aplicação de Integração. Sempre que uma das camadas alterarem os dados dessa tabela será adicionada uma linha da tabela de log. 
Como a tabela de integração e log possuem campos com nomes genéricos a qualquer cadastro ou rotina do CIGAM, a consulta bem como a inclusão de dados deverá ser feita pelas respectivas camadas as quais apresentarão os nomes dos campos adequadamente. 
As tabelas de integração e log ficarão em um banco separado. Esse banco será acesso pelo Database CIGAM_INTEGRA em aplicações do CIGAM e pela Aplicação de
Integração (componente CGIntegrador.ecf) 
Se o banco de dados for diferente ao utilizado pelo CIGAM (inclusive se mudar apenas o database/usuário), deve-se informar uma connection string chamada INTEGRACAO no arquivo de configuração. 
 
Também deve ser informado o banco de dados nessa nova conexão no parâmetro providerName. 
   Exemplo: 
       <add name="CIGAM" connectionString="Server=servidor;Database=BD;User ID=USER;Password=SENHA; 
       <add name="INTEGRACAO" connectionString="Server=servidor;Database=BD;User ID=USER;Password=SENHA;" providerName="02"/> 
 
O código de banco de dados do CIGAM deve ser informado na configuração BANCO_DADOS da aplicação. 
   Exemplo: 
      <add key="BANCO_DADOS" value="03" />
 
Para registrar requisições provenientes de aplicativos de terceiros, é necessário utilizar o parâmetro chamado CGREQUISICAOWS. Já para registrar requisições de serviços específicos, deve-se empregar o parâmetro CGREQUISICAOWS_ seguido do tipo de registro desejado. Por exemplo, para registrar requisições relacionadas a cadastros de notas fiscais, o parâmetro seria GREQUISICAOWS_CADNF1. 
* Exemplo de aplicabilidade dentro do arquivo web.config na sessão settings ou quando existir, diretamente no arquivo settings.config: 
<add key="CGREQUISICAOWS" value="C:\cigam\Temp\"/> 
<add key="CGREQUISICAOWS_CADNF1" value="C:\cigam\Temp\NF\"/> 
Caso não seja necessário gravar nenhuma requisição em arquivo, nenhum dos parâmetros mencionados acima deve ser utilizado. 

==Registros correlatos ==

A tabela de integração poderá ter registros correlatos pendentes de importações, como por exemplo, pedidos versus itens versus grade do item. Neste caso quando o pedido for importado será feita uma verificação se existem itens para esse pedido. Da mesma forma, quando o item do pedido for importado será verificado se existe grade do item. Nesse ponto, somente os registros com status liberado serão avaliados e importados/recursados. 
Os registros correlatos que não estão liberados, não serão tratados e, portanto jamais serão reavaliados. Para evitar registros perdidos na tabela de integração, será
executada uma rotina de limpeza que irá excluir os registros com ID correlato cujo registro máster não esteja mais pendente de importação. Essa exclusão registrará um log específico.

== Segurança ==

Não será utilizado o cadastro de usuário nem de direitos do CIGAM, até porque as aplicações de terceiros não podem controlar adequadamente esses dados. 
O PIN irá identificar quem está fazendo a requisição e deve estar inserido no arquivo de configurações do ambiente do Web Service (seção <appSettings>). 
Conforme exemplo abaixo, as requisições com o PIN <XW@#25Qo> podem utilizar os serviços ‘CADMAT’ e ‘CADEMP’. Os demais <@#0Q1o2>, <W#12@Abfg> e <20020004> podem utilizar todos os serviços, pois não há restrição atribuída a eles. 
* Exemplo: 
** <appSettings> 
** <add key="pin" value="XW@#25Qo;@#0Q1o2;W#12@Abfg;20020004"/>
*** É indicado que o valor do PIN tenha uma complexidade alta visando a segurança das informações contidas nos ambientes integrados 
**<add key="XW@#25Qo" value="CADMAT;CADEMP"/>
 

= Requisição e resposta dos Webservices =

Serão suportadas as tecnologias SOAP e Rest/JSon sendo que nessa segunda opção os parâmetros devem ser enviados por POST e o nome do método junto na URL. As respostas dos serviços
também estarão disponíveis nessas duas tecnologias. 
Quando o retorno contiver mais de um registro, a exportação será feita com duas coleções (objetos), uma para as colunas e outra para os dados. Neste caso as colunas ganham cabeçalhos
nomeados para referenciar os dados (c1, c2...). 
A opção EXPORT_HEADERS pode ser inserida no arquivo de configurações do ambiente do Web Service (seção <appSettings>) para indicar se a exportação deve ocorrer
sempre usando os cabeçalhos ou não, independentemente da quantidade de registros. 
    Exemplo: 
       <appSettings> 
       <add key="EXPORT_HEADERS" value="N"/> 
É possível incluir no arquivo Settings. 
Quando o nome da coluna da tabela no banco de dados for diferente do nome utilizado no CIGAM/CGData, na coleção dos nomes de colunas existirá uma tag com essa identificação. 
Não serão exportados campos ainda não nomeados (exemplo: Campo31, Campo32...). Exceção: Campos de usuário que são os iniciados com nome <Usr>. 
No formato JSON será necessário atributar ambas as propriedades, pois não há como colocar um valor para a tag principal como no XML. Neste caso, o apelido da coluna deverá ficar na tag
<db_alias>. 
Como primeiro nó da árvore, em ambos os formatos será utilizado o valor da tradução do Nome Lógico da tabela exportada. As colunas serão agrupadas na coleção
<col> e os campos de cada registro na coleção <reg>. Os dados serão formatados com decodificação UTF-8. 
    Exemplos de resposta: 

<center><table style="width:85%" "line-height:100%">
<tr>
<td>XML</td>
<td>JSON</td>
</tr>
<tr>
<td>
<pre><esmateri>
<col>
<cd_material>c1</cd_material>
<descricao>c2</descricao>
<valor_imposto>c3</valor_imposto>
</col>
<reg>
<c1>001</c1>
<c2>Material Teste 1</c2>
<c3>10</c3>
</reg>
<reg>
<c1>002</c1>
<c2>Material Teste 2</c2>
<c3>20</c3>
</reg>
</esmateri>

</pre></td>

<td>
<pre>{
"col": [
{
"cd_empresa": "c1",
"descricao": "c2",
"valor_imposto": {
"db_column": "campo3",
"db_alias": "c3"
}
}
],
"esmateri": [
{
"c1": "001",
"c2": "Material Teste 1",
"c3": "10"
},
{
"c1": "002",
"c2": "Material Teste 2",
"c3": "20"
}
]</pre></td>
</tr>
</table></center>

Existe um validador para o padrão JSON em http://jsonlint.com 

== Tipos especiais ==

Alguns dados terão formatos especiais na requisições e respostas. 
 

<center><table width="700" border="0" cellspacing="0" cellpadding="7">
<tr valign="top">
<td style="background: #d9d9d9;" width="80">Tipo do dado</td>
<td style="background: #d9d9d9;" width="71">Formato</td>
<td style="background: #d9d9d9;" width="184">Máscara</td>
<td style="background: #d9d9d9;" width="99">Exemplo</td>
<td style="background: #d9d9d9;" width="89">Onde</td>
</tr>
<tr valign="top">
<td style="background: transparent;" width="80">Data</td>
<td style="background: transparent;" width="71">XML</td>
<td style="background: transparent;" width="184">DateTime (conforme ambiente em que o Serviço está rodando)</td>
<td style="background: transparent;" width="99">01-jan-2013</td>
<td style="background: transparent;" width="89">Requisição</td>
</tr>
<tr valign="top">
<td style="background: transparent;" width="80">Data</td>
<td style="background: transparent;" width="71">XML</td>
<td style="background: transparent;" width="184">dd/mm/yyyy</td>
<td style="background: transparent;" width="99">01/01/2013</td>
<td style="background: transparent;" width="89">Resposta</td>
</tr>
<tr valign="top">
<td style="background: transparent;" width="80">Data</td>
<td style="background: transparent;" width="71">JSON</td>
<td style="background: transparent;" width="184">dd/mm/yyyy
ou
dd-mmm-yyyy</td>
<td style="background: transparent;" width="99">01/12/2013
ou
01-dec-2013</td>
<td style="background: transparent;" width="89">Requisição e Resposta</td>
</tr>
<tr valign="top">
<td style="background: transparent;" width="80">Booleano</td>
<td style="background: transparent;" width="71">XML</td>
<td style="background: transparent;" width="184">Bool (conforme tipagem)</td>
<td style="background: transparent;" width="99">True</td>
<td style="background: transparent;" width="89">Requisição</td>
</tr>
<tr valign="top">
<td style="background: transparent;" width="80">Booleano</td>
<td style="background: transparent;" width="71">XML</td>
<td style="background: transparent;" width="184">True
ou
False</td>
<td style="background: transparent;" width="99">True
ou
False</td>
<td style="background: transparent;" width="89">Resposta</td>
</tr>
<tr valign="top">
<td style="background: transparent;" width="80">Booleano</td>
<td style="background: transparent;" width="71">JSON</td>
<td style="background: transparent;" width="184">TRUE,True,true
ou
FALSE,False,false</td>
<td style="background: transparent;" width="99">True
ou
false</td>
<td style="background: transparent;" width="89">Requisição</td>
</tr>
<tr valign="top">
<td style="background: transparent;" width="80">Booleano</td>
<td style="background: transparent;" width="71">JSON</td>
<td style="background: transparent;" width="184">True
ou
False</td>
<td style="background: transparent;" width="99">True
ou
False</td>
<td style="background: transparent;" width="89">Resposta</td>
</tr>
<tr valign="top">
<td style="background: transparent;" width="80">Time</td>
<td style="background: transparent;" width="71">XML e JSON</td>
<td style="background: transparent;" width="184">161050</td>
<td style="background: transparent;" width="99">161050</td>
<td style="background: transparent;" width="89">Requisição e Resposta</td>
</tr>
<tr valign="top">
<td style="background: transparent;" width="80">Numéricos</td>
<td style="background: transparent;" width="71">XML e JSON</td>
<td style="background: transparent;" width="184">Sem separador de milhar e com ponto (“.”) como separador decimal</td>
<td style="background: transparent;" width="99">150
120.00
1250.33222</td>
<td style="background: transparent;" width="89">Requisição e Resposta</td>
</tr>
</table></center>

Quando utilizar o formato XML, os valores enviados para parâmetros de tipos especiais, no serviço SOAP o próprio serviço garante o dado de entrada correto. Quando exportado irá seguir conforme a tabela anterior. 
Quando utilizar o formato JSON, para os campos do tipo data o dado terá que vir no formato conforme a tabela anterior e para campos do tipo booleano terá que vir um “true” (não importando a capitalização) para que seja verdadeiro, pois para qualquer outra coisa será considerado como falso. 
Para campos de dados do tipo hora, terão o dia com 24 horas e sem dois pontos “:” (HHMMSS)

== Configurações especiais do banco de dados ==


Para que os serviços acessem corretamente os dados do tipo Date e DateTime, é obrigatório que a sessão com o banco de dados permita a informação de filtros por datas no formato americano “dd-mmm-yyyy” Exemplo: 01-jan-2013, 20-feb-2013 e 12-oct-2013.
Para bancos de dados SQLServer essa parametrização já vem por padrão. 
Para bancos de dados Oracle esse parâmetro pode variar de acordo com o idioma do Sistema Operacional no momento da instalação. Neste caso, verifique se o parâmetro de sessão “nls_language” está definido como “AMERICAN”. Esse valor pode ser ajustado no Registro do Windows para que todas as sessões sejam inicializadas dessa forma. Observar também se o Web Server que hospeda os serviços está com o modo 32bits/x86 habilitado, pois neste caso também é necessário ajustar os “nls_language” do Client32 do Oracle.

== Validação do Integrador pelo IIS ==

Primeiramente para essa validação, é preciso acessar a pastas de instalação do Integrador (Webservices) e ajustar as configurações dos arquivos Settings.config e web.config, lembrando de remover o @ que vem por default com a implementação: 

[[Image: Integrador1.png|1000px|centro]] 
 
[[Image: Integrador2.png|600px|centro]] 
 
Para o arquivo web.config deve ser ajustado os campos de ConnectionString "CIGAM" e "INTEGRACAO" que podem ser gerados pelo programa CGConnectionString que se encontra no CIGAM_INSTAL ou também ser utilizada a mesma string informada na API e Portais, lembrando que no ProviderName 02 é SQL Server e 03 Oracle. '''Importante criptografar a string de conexão.''' 
 
[[Image: Integrador5.png|750px|centro]] 
 
Em seguida é necessário criar a pasta Bin dentro da estrutura de instalação do integrador com as DLL's (encontradas no CIGAM_INSTAL): 
<li>CIGAM.Ambiente;
<li>CIGAM.Extensions;
<li>CIGAM.Sgbd;
<li>CIGAM.Utils;
<li>CIGAM.Webservices; 
[[Image: Integrador7.png|750px|centro]] 
 
 
Feito isso, retornando ao IIS, no parte inferior é necessário alterar a forma de exibição para Content View, após isso selecionar o arquivo TesteBancoDados.ashx e clicar em Browse para abrir o navegador com a validação do Integrador. 
[[Image: Integrador6.png|900px|centro]] 
[[Image: Integrador8.png|900px|centro]] 

= Log =

A tabela de log é praticamente uma cópia da tabela de integração com a adição dos campos para a data e hora da ocorrência/execução. O processo de criação e registro dos Logs será feito da seguinte forma:
<ol type="a">
<li>O Webservice recebe a requisição e verifica se todos os parâmetros são válidos. Caso não sejam, retorna um erro ao usuário e não registra qualquer tipo de inserção na tabela de integração ou de log.</li>
<li>Se os parâmetros passados para o webservice forem válidos, insere na tabela de integração, retorna uma mensagem e sucesso ao usuário sem registrar log.</li>
<li>Quando o programa da aplicação de integração executar e importar o registro da tabela de integração, o log é criado com os dados importados (inclusive o usuário logado no CIGAM que fez a importação). Após isso, o registro da tabela de integração será apagado.</li>
<li>No log é um campo para saber se o registro foi importado ou recusado. Caso recursado, armazena também o código e a mensagem de erro. Isso se faz necessário para que os registros com erro não fiquem na tabela de integração.</li> 
<li>Após liberar os registros pendentes será registrado log. Se tentar liberar um registro inexistente será retornado um erro e não será registrado log. Não será testado se está sendo liberado um registro já liberado pois teria também que ser feito um controle para a liberação dos correlatos.</li></ol>
 
Em Genéricos/Pesquisas/Rotinas existe uma tela on-line para que o usuário/administrador/DBA possa visualizar a tabela de Log. 
A tabela de log não é indexada para ganho de performance. Se a tabela do log for grande, poderão ser criados os índices de acordo com as necessidades. 
Não é gerado log sobre as consultas de dados efetuadas. 
O log poderá ser limpo ou mantido apenas “n” dias conforme a necessidade do administrador do banco de dados (a limpeza será manual por segurança).

= Aplicação de Integração =

A camada de serviços e ou de banco de dados garantem “apenas” que o dado chegue até à tabela de integração. A importação dos dados é feita por um programa específico da aplicação de integração chamado [[GE_Integrador|Integrador]].

Ao indicar statusRegistro igual a pendente o registro enviado não será integrado ao ERP CIGAM até que tenha seu status igual a liberado. Sendo possível sua liberação através do método LiberarPendentes. Também é possível criar o registro com o status Liberado sem a necessidade de requisitar um novo método para liberação.

==Utilizando o retorno dos Serviços ==
=== Xml ===

Os serviços que utilizam o protocolo SOAP, tem como retorno uma String no formato Xml, para melhor visualização destes dados, está disponível na classe “Xml”, do namespace Cigam.Utils, um método estático chamado “XmlStringToDataTable”. Este retorna um objeto do tipo System.Data.DataTable. Segue abaixo um exemplo de implementação. 
 
[[Arquivo:IN_001.jpg|580×267px|Exemplo 1]]
 
Também pode ser utilizada a classe XmlDocument, do namespace System.Xml para fazer a manipulação dos dados. Segue abaixo um exemplo de implementação. 
 
[[Arquivo:IN 002.jpg|580×267px|Exemplo 2]]
 

=== Json ===

Os serviços que utilizam o protocolo REST, tem como retorno uma String no formato JSon, para trabalhar com estes dados, está disponível a classe “JSonDocument” no namespace Cigam.Utils. Esta classe fornece a interpretação da string retornada além de propriedades e métodos para manipulação dos dados. Seguem abaixo exemplos de como instanciar e alimentar a classe. 
 
   Exemplo 1: 
[[Arquivo:IN 003.jpg|580×267px|Exemplo 1]]
 
 
   Exemplo 2: 
[[Arquivo:IN 004.jpg|580×267px|Exemplo 2]]
 
 
   Exemplo 3: 
[[Arquivo:IN 005.jpg|580×267px|Exemplo 3]]
 
Esta classe também fornece uma propriedade contendo uma lista genérica que guarda objetos do tipo Cigam.Utils.JSonObject, e esta lista fornece informações sobre os registros da consulta, como o nome da coluna e o valor. Através desta classe também é possível obter o nome original das colunas, caso a consulta possua um cabeçalho de apelidos, ou saber se a consulta retornou exception, success ou query. Veja os exemplos abaixo: 
   Exemplo 1: 
[[Arquivo:IN 006.jpg|580×267px|Exemplo 1]]
 
   Exemplo 2: 
 
[[Arquivo:IN 007.jpg|580×267px|Exemplo 2]]

GE - Como Fazer - Integração CIGAM e WMS Fullsoft

2025-03-14T11:35:46Z

Alessandro.voto: /* Qual o Banco de dados homologado? */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Integração CIGAM e WMS Fullsoft]]

== Palavras-Chave ==
Integração CIGAM vs WMS FullSoft. Como Integrar CIGAM com WMS FullSoft. Warehouse Management System (WMS). Integração CIGAM e WMS.

= Como Fazer - Integração CIGAM e WMS Fullsoft =
= Quais são os tipos de materiais suportados entre CIGAM x WMS Fullsoft? =

Permite que sejam utilizados materiais simples e com controle de lote. É possível também ter o controle de Materiais com Configurador de Produto.


'''Não escopo:''' Grade, Especificações Independentes ou Estoque e Números de Série.

= Qual o Banco de dados homologado?=

Homologado somente em banco de dados Microsoft SQL Server.

=Módulos necessários=
* '''[[Suprimentos]]:''' [[ES_Gestão de Materiais|Gestão de Materiais]], [[CO_Compras|Compras]] e [[CO_Requisições de Materiais|Requisições de Materiais]]
* '''[[FA_Faturamento/Pedido|Faturamento/Pedido]]:''' [[FA_Pedidos|Pedidos]] e [[FA_Nota Fiscal|Nota Fiscal]]
* '''[[GE_Genéricos|Genéricos]]:''' [[Integrador]]
* '''[[PC_Programação e Controle de Produção|Programação e Controle de Produção]]:''' Somente quando houver Indústria

=Módulos/Funcionalidades não escopo=
* [[CL_Gestão de Lojas|Gestão de Lojas]]: [[CL_Orçamento|Orçamento]] e [[CL_Orçamento por Controle|Orçamento por Controle]]
* [[GM_Gestão de Serviços|Gestão de Serviços]]: [[GM_Movimentos_Ordem de Serviço|Ordens de Serviço]] com vínculos de Materiais
* [[CO_Devolução de Entradas|Devolução de Entradas]] e [[FA_Devolução de Saídas|Saídas]]
* Faturamento Parcial

=Quais documentos podem ser utilizados entre CIGAM x WMS Fullsoft?=
* Notas Fiscais de Entrada
* Separação de Pedidos
* Separação de Entregas
* Separação de Requisições de Materiais
* Balanço de Estoque


'''Importante:''' Qualquer funcionalidade não mencionada é considerada como não escopo e deve sempre ser avaliada com equipe técnica.

=Como é realizada a Integração?=

A integração entre CIGAM x WMS FULLSOFT é realizada através de Web Service.


Web Service é uma forma de comunicação entre sistemas, a qual permite integrar dados padronizados entre ambos. Como meio de comunicação são utilizadas mensagens no formato '''XML'''.


Desta forma, é realizado via um '''HTTP''' pela internet, ou seja, é um link compartilhado entre ambos para receber e enviar o '''XML'''.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoft.png|850px|center|Integração CIGAM vs WMS Fullsoft]]

=Serviços/Métodos para Integração WMS Fullsoft=

Será disponibilizado um link ao cliente, o qual estará desta forma:

<pre>
https://cliente.cigam.cloud/WebServicesProd/Integrador/nome_do_webservice
</pre>


Após a informação [...]Integrador/[...], ou seja, depois da “/” (barra) indica que deve ser informado o '''nome do webservice'''.


São '''6 WebServices''' que podem vinculados a este link:

<pre>
CadastroBalanco.integrador.asmx
CadastroEmpresas.integrador.asmx
CadastroItemRequisicaoMaterial.integrador.asmx
CadastroMaterais.integrador.asmx
CadastroMovimentos.integrador.asmx
CadastroPedidos.integrador.asmx
</pre>


Dentro de cada um deles, haverá os '''métodos''', ou seja, as '''funções''' que este '''webservices''' pode realizar nesta integração.


Para o correto funcionamento dos '''Serviços''' e junto a eles os '''Métodos''', são necessários cadastros de '''COLEÇÕES'''.

{| class="wikitable" style="margin:auto;width:90%"
|-
! Serviço (WebService) !! Método
|-
| CadastroBalanco.integrador.asmx || Cadastrar
|-
| CadastroEmpresas.integrador.asmx || ListarTransportadoras
|-
| rowspan="2" | CadastroItemRequisicaoMaterial.integrador.asmx
| ListarItensRequisicoesSeparacao
|-
| ApontamentoSeparacaoItemRequisicao
|-
| rowspan="6" | CadastroMateriais.integrador.asmx
| ListarItensConferencia
|-
| ListarItensFaturamento
|-
| ListarItensFaturamento
|-
| ListarCodigoBarrasItensSeparacao
|-
| ListarCodigoBarrasItensConferencia
|-
| ListarCodigoBarrasItensFaturamento
|-
| rowspan="10" | CadastroMovimentos.integrador.asmx
| ListarOPsConferencia
|-
| ListarNFsConferencia
|-
| ApontamentoConferencia
|-
| ApontamentoConferenciaLote
|-
| ApontamentoSeparacao
|-
| ApontamentoSeparacaoLote
|-
| ConfirmarRecebimentoOP
|-
| ListarAvulsosConferencia
|-
| ListarAvulsosConferencia
|-
| ListarRetornoBeneficiamentoConferencia
|-
| rowspan="10" | CadastroPedidos.integrador.asmx
| ListarPedidosSeparacao
|-
| ListarPedidosSeparacao
|-
| ApontamentoSeparacaoPedido
|-
| ApontamentoInicioSeparacaoItemPedido
|-
| ApontamentoSeparacaoItemPedido
|-
| ApontamentoCancelamentoPedido
|-
| ListarEntregasSeparacao
|-
| ApontamentoSeparacaoEntrega
|-
| DevolucaoSeparacaoEntrega
|-
| DevolucaoSeparacaoEntregaParcial
|}

=O que são as Coleções?=

As '''Coleções''' são parâmetros para que o método possa executar a comunicação corretamente e padronizada.

* Exemplo do Serviço: CadastroMateriais + Método: ListarItensConferencia + '''Coleção''': MACF


No exemplo citado, o '''MACF''' – Itens para Conferência, refere-se que ao executar o Serviço + Método trará todos os itens que são disponibilizados para que seja realizada a Conferência.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoft1.png|550px|center|Integração CIGAM vs WMS Fullsoft 1]]

== Cadastro de Coleções - CIGAM ==

As COLEÇÕES são a única maneira de padronizar as informações de envio (CIGAM) e retorno (WMS FULLSOFT).


Nas COLEÇÕES é onde se cadastra quais informações serão enviadas ao WMS FULLSFOT, são elas:

* Materiais
* Controles
* Centros de Armazenagem
* Clientes
* Tipos de Operação
* Unidade de Negócio


Para realizar os cadastros de COLEÇÕES, deve-se acessar o CIGAM no módulo [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Coleções|Coleções]].


Nesta tela, todos os cadastros devem ser realizados conforme as regras e padrões definidos para a respectiva regra de negócio e de acordo com os webservices estabelecidos.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadColecoes.png|850px|center|Integração CIGAM vs WMS Fullsoft - Coleções]]

== Cadastro de Coleções - Regras Padronizadas ==

Para que se tenha um cadastro correto de [[GE_Coleções|Coleções]] é necessário entender os principais cadastros a serem utilizados:

* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Unidade_de_Negócio|Unidade de Negócio]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Controles|Controles]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Centro_de_Armazenagem|Centro de Armazenagem]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Materiais|Materiais]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Tipos_de_Operações|Tipos de Operações]]
* [[GE_-_Como_Fazer_-_Integração_CIGAM_e_WMS_Fullsoft#Clientes,_Empresas_e_Transportadoras|Clientes]]

===Unidade de Negócio===

Deve ser avaliado quais Unidades de Negócio serão integradas com o WMS.


As Unidades desta escolha deverão ser cadastradas na Coleção: '''UNIW'''

===Controles===

Para os Controles a serem integrados com o WMS devem ter duas distinções: 


1. Para '''PEDIDOS''' devem ser separados em '''6 Coleções''': 

* '''CPPE''' - Controle de Pedidos Pendentes
* '''CPPS''' - Controle de Pedidos Liberados para Separação de Pedidos
* '''CPPI''' - Controle de Pedidos para Separações Iniciadas
* '''CPFA''' - Controle de Pedidos para Separações Finalizadas
* '''CPPC''' - Controle de Pedidos que podem ser Cancelados pelo WMS
* '''CPSZ''' - Controle de Pedidos que não podem ser Separados

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadControlesPedido.png|750px|center|Integração CIGAM vs WMS Fullsoft - Controles Pedido]]


2. Para '''REQUISIÇÕES DE MATERIAIS''' devem ser separados em '''3 Coleções''':

* '''CPRS''' - Controle para Requisição de Materiais Liberada ao WMS
* '''CPRP''' - Controle para Requisição de Materiais Separadas WMS
* '''CPRP''' - Controle para Req. de Mat. que não podem ser Separadas

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadControlesRequisicoes.png|650px|center|Integração CIGAM vs WMS Fullsoft - Controles Requisições]]


'''Observações Importantes referente aos Controles:'''

:Há a Coleção '''CPSP''' - Situação para itens pedidos para separação parcial.

:Funcionalidade a qual não é prevista na Integração.

:É importante que clientes que utilizam faturamento parcial, ao implementarem o WMS Fullsoft, realizem uma customização dessa funcionalidade tanto no CIGAM quanto no WMS Fullsoft.

:No CIGAM, é possível realizar o faturamento parcial, ou seja, um pedido pode ser faturado inúmeras vezes, enquanto houver saldo disponível. Quando há integração com o WMS Fullsoft, após o envio dos dados (número do pedido), ele será recebido e devolvido apenas uma única vez. Isso significa que, no WMS Fullsoft, não é possível separar o mesmo pedido múltiplas vezes.

:Após o início do processamento, o WMS Fullsoft só retornará as informações ao CIGAM quando o pedido estiver finalizado. Dessa forma, não é possível devolver um saldo menor do que o enviado pelo CIGAM. A quantidade devolvida deve ser exatamente a mesma enviada, garantindo a integridade do pedido para o cliente final.

===Centro de Armazenagem===

Para os Centros de Armazenagem devem ser separados em '''4 Coleções''':

* '''CACF''' - Centro de Armazenagem Recebimento
* '''CASP''' - Centro de Armazenagem Estoque Principal
* '''CAFA''' - Centro de Armazenagem para Faturamento
* '''CAAV''' - Centro de Armazenagem para itens Avariados

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftCadCentrosdeArmazenagem.png|750px|center|Integração CIGAM vs WMS Fullsoft - Centros de Armazenagem]]

===Materiais===

Para os '''Materiais''' devem ser separados em '''3 Coleções''':

* '''MACF''' - Materiais WMS (para conferência)
* '''MASP''' - Materiais WMS (para separação)
* '''MAFA''' - Materiais WMS (para faturamento)


'''Observação:''' Quando há '''Configurador de Produto''' e houver um código de barras para cada '''Identificador''' deverá ser realizado o cadastro de outras '''3 Coleções''':

* '''TGBC''' - Códigos de barras de itens para conferência
* '''TGBS''' - Códigos de barras de itens para separação
* '''TGBF''' - Códigos de barras de itens para faturamento


'''Importante:'''

:Mesmo quando o não houver a utilização do Configurador de Produto estas Coleções devem ser cadastradas a nível de Coleção sem informações adicionais, irão servir apenas a nível integridade em passar por estes dados e encontrar informações vazias.

===Tipos de Operações===

Para os '''Tipos de Operações''' devem ser separados em '''4 Coleções''':

* '''TOTC''' - Tipo de Operação para Movimentos de Recebimento
* '''TOTF''' - Tipo de Operação para Movimentos de Separação de Ped.
* '''TOAV''' - Tipo de Operação de Movimentos de Transf. Avariados
* '''TOTP''' - Tipo de Operação de Movimentos de Transf. Requisições


Todos os Tipos de Operação devem ter como característica serem com espécie de estoque de transferência e com correlato de entrada, para que possam ser removidos do WMS FULLSOFT e gerar a movimentação no CIGAM, mantendo assim, o histórico e integridade dos movimentos de estoque.

===Clientes, Empresas e Transportadoras===

Para os '''Clientes, Empresas, Transportadoras''' e todos cadastros em relação a [[GE_Empresas/Pessoas|Empresas/Pessoas]] no CIGAM, devem ser separados por '''3 Coleções''':

* '''EMCL''' - Clientes e Outros
* '''EMTR''' - Transportadoras
* '''EMFO''' - Fornecedores

===Ocorrências de Produção===

Para que seja possível Endereçar as Ordens de Produção, devem ser vinculadas a '''Coleção – OPSP''' as ocorrências que devem ser enviadas ao WMS Fullsoft.

* '''EMCL''' - Clientes e Outros
* '''EMTR''' - Transportadoras
* '''EMFO''' - Fornecedores

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftFluxoGeral.png|750px|center|Integração CIGAM vs WMS Fullsoft - Fluxo Geral]]

=Balanço e Inventários=
==Parâmetros do Serviço responsável pelo Inventário==

O retorno dos dados oriundos da FULLSOFT no Serviço devem respeitar os seguintes campos grifados em vermelho.


As tags, "statusRegistro" e "sequencia" conforme anexo devem ser '''FIXOS''' "'''L'''" e "'''1'''".

* [[WMS_CadastroBalanco.integrador]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftInventarioParametros.png|750px|center|Integração CIGAM vs WMS Fullsoft - Inventario - Parâmetros]]

==Parâmetros WMS==

Para que o CIGAM receba informações de Estoque conforme Unidade de Negócio, deve ser parametrizado no WMS Fullsoft no programa '''WF9011'''.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftInventarioParametrosWMS.png|850px|center|Integração CIGAM vs WMS Fullsoft - Inventario - Parâmetros WMS]]


'''Importante:'''

:As informações de Inventário/Balanço virão do SINC (sincronizador do WMS Fullsoft). O CIGAM só irá receber as informações depois que for finalizado no SINC, ou seja, somente depois que a houver o "commit" pelo SINC.

:Isso garante que o CIGAM não irá receber as informações gradativamente pela integração.

==Painel Integrador CIGAM==

Ao realizar Pesquisas no CIGAM, será possível visualizar as informações recebidas, neste caso o BALANÇO/INVENTÁRIO oriundo do WMS, o qual gerou dados na Tabela '''GEINTEGR'''.

* [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Pesquisas|Pesquisas]] > [[GE_Pesquisas_Rotinas|Rotinas]] > [[GE_Painel Integrador|Painel Integrador]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftInventarioPainelIntegrador.png|850px|center|Integração CIGAM vs WMS Fullsoft - Inventario - Painel Integrador]]

==Integrador CIGAM==

Após finalizada a contagem no WMS, deve ser ligado o [[GE_Integrador|Integrador CIGAM]] com a opção "'''Balanços'''". Assim os balanços liberados pelo WMS poderão ser integrados ao CIGAM.

* [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Rotinas|Rotinas]] > [[GE_Rotinas_EDI|EDI]] > [[GE_Rotinas_EDI_Recebe|Recebe]] > [[GE_Integrador|Integrador]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftIntegradorCIGAM.png|750px|center|Integração CIGAM vs WMS Fullsoft - Integrador CIGAM]]

==Balanço do Estoque - Rotina CIGAM==

Após a geração do Integrador CIGAM, as informações serão populadas na tela de Balanço com informações oriundas do WMS.

* [[Suprimentos]] > [[ES_Gestão de Materiais|Gestão de Materiais]] > [[ES_Rotinas|Rotinas]] > [[ES_Rotinas_Operacionais|Operacionais]] > [[Es_Balanço|Balanço]] > [[ES_Balanço apurado|Balanço apurado]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftBalancoEstoqueCIGAM.png|750px|center|Integração CIGAM vs WMS Fullsoft - Balanço de Estoque - CIGAM]]

==Divergência de Balanço CIGAM==

Sendo assim, após receber as informações via tela de [[ES_Balanço apurado|Balanço Apurado]], para espelhar os Estoques poderá ser utilizada a rotina [[ES_Divergências de Balanço|Divergências de Balanço]].

* [[Suprimentos]] > [[ES_Gestão de Materiais|Gestão de Materiais]] > [[ES_Rotinas|Rotinas]] > [[ES_Rotinas_Operacionais|Operacionais]] > [[Es_Balanço|Balanço]] > [[ES_Divergências de Balanço|Divergências de Balanço]]

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftDivergenciaBalancoCIGAM.png|750px|center|Integração CIGAM vs WMS Fullsoft - Divergência de Balanço - CIGAM]]


É importante utilizar tipos de operações exclusivos para entradas e saídas a fins de ter histórico das informações de movimentações de estoque e entender a razão das divergências de estoque.

=Requisição de Materiais=
==Como Fazer Requisição de Materiais==

Avaliação do Estoque antes de separar a Requisição pelo WMS:

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoPesquisaEstoque.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição - Pesquisa de Materiais]]


'''Requisição de Materiais:''' Na Requisição ao WMS está sendo solicitado para que sejam transferidas 50 Unidades para o CA 999. A requisição já está no Controle "'''Liberado WM'''".

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoMaterial.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição de Materiais]]

 
[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftFluxoRequisicaoMaterial.png|850px|center|Integração CIGAM vs WMS Fullsoft - Requisição de Materiais]]

==Serviços==
===ListarItensRequisicoesSeparacao===

Para conseguir identificar o XML enviado ao WMS, deve ser executado via CGWebserviceInvoker este serviço: ListarItensRequisicoesSeparacao

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftServicosListarItens.png|550px|center|Integração CIGAM vs WMS Fullsoft - Serviços - ListarItensRequisicoesSeparacao]]

===ApontamentoSeparacaoItemRequisicao===

Para realizar a separação da Requisição deve-se utilizar do método "ApontamentoSeparacaoItemRequisicao" onde conforme os parâmetros irá receber os dados de retorno, com base nos dados de envio. Desta forma, gerando assim as movimentações.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftServicosApontamentoSeparacaoItemRequisicao.png|550px|center|Integração CIGAM vs WMS Fullsoft - Serviços - ApontamentoSeparacaoItemRequisicao]]


Gerando assim as movimentações corretamente conforme a Requisição de Materiais.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftServicosApontamentoSeparacaoItemRequisicao2.png|750px|center|Integração CIGAM vs WMS Fullsoft - Serviços - ApontamentoSeparacaoItemRequisicao]]


Desta forma, a Requisição troca o Controle para Separada e o item ficará como Atendido:

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoAtendida.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição Atendida]]


Mantendo os Estoque conforme necessidade.

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftRequisicaoAtendidaEstoque.png|750px|center|Integração CIGAM vs WMS Fullsoft - Requisição Atendida - Estoque]]

=OSs de Sugestão ao Produto=
==OS 857372/39 - Movimento de Avaria==

Atualmente o método '''MovimentoAvaria''' não contempla '''Lotes'''.
Devido a todos os outros Serviços ter como realizar o controle de Lotes também. Sugestão:

[[Image:ComoFazer_IntegracaoCIGAMvsFullSoftSugestao.png|550px|center|Integração CIGAM vs WMS Fullsoft - OSs de Sugestão]]

=FAQs Relacionadas=
*[[Como devo acionar quando existir ocorrências de informações incoerentes na integração com WMS?]]
*[[Como identificar o porquê não houve troca de controle no CIGAM após cancelamento no WMS?]]
*[[Como proceder ao identificar um erro de saída sem saldo?]]
*[[Como proceder a leitura de uma Ordem de Produção que está tendo lentidão a ser passada para o Coletor?]]
*[[Como proceder quando o Cigam não está fazendo movimentação de saldo quando uma requisição é separada no WMS?]]
*[[Como proceder quando o material novo não aparece para o WMS?]]
*[[Nota/Pedido não está aparecendo, o que fazer?]]
*[[Ordem de Produção (OP) não está aparecendo, o que fazer?]]
*[[XML está com erro de retorno, o que avaliar?]]
*[[Como realizar contagem de Estoque pelo WMS?]]
*[[Como ativar o log no WMS?]]
*[[Como cancelar o Pedido pelo WMS?]]
*[[Pedido cancelado, não é possível realizar a separação?]]
*[[Divergência na Nota Fiscal de Entrada, o que fazer?]]

GM Cadastros Versões

2025-03-10T11:21:10Z

Alessandro.voto: /* Campos */

[[Serviços]] > [[GM_Gestão de Serviços|Gestão de Serviços]] > [[GM_Pesquisas|Pesquisas]] > [[GM_Pesquisas_Cadastros|Cadastros]] > [[GM__Cadastros_Versões|Versões]]
<div align="justify">
A pesquisa de versões pode ser utilizada em programas a fim de selecionar o registro desejado e também através de menu para simples consulta aos dados.
[[Arquivo:pesquisaddeversoesgs.png|750x500px|semmoldura|centro|Pesquisa de Versões]]

== Campos ==
* '''Versão:''' Identificação da versão do produto.
* '''Release:''' Código identificador da release.
* '''Observação:''' Informações adicionais sobre a versão.
* '''Corte:''' Data de Corte da versão.
* '''Previsão:''' Previsão de liberação da versão.
* '''Liberação:''' Data efetiva da liberação da versão. <ref group="Versão 250505" name="multiple">Liberado a partir da OS 898493/1.</ref>
* '''Possui Pkg:''' Checkbox visual indicando se a versão possui um package associado. <ref group="Versão 250505" name="multiple">Liberado a partir da OS 898493/1.</ref>

== Botões ==
* '''[[Botão Confirmar|Confirmar]]:''' Ao clicar, o sistema avança para o próximo registro. Se não houver próximo registro, o modo de criação será ativado, salvando o registro.
* '''[[Botão Cancelar|Cancelar]]:''' Cancela a operação e sai da tela de registros sem salvar informações.
* '''Package:''' Chama o programa de Package. Caso exista um Package para a versão cadastrada, o botão deverá aparecer em '''negrito''' e o campo '''Possui Pkg''' ficará marcado. <ref group="Versão 250505" name="multiple">Liberado a partir da OS 898493/1.</ref>
{{VoltarInicio}}

== Versões ==
=== Versão 250505 ===
<references group="Versão 250505"/>

GE Auditor de Ambiente

2025-03-10T11:18:54Z

Alessandro.voto: /* Etapa "Resultados" */

{{VoltarPagina}}

[[Utilidades/Diversos]] > [[GE_Acesso rápido|Acesso rápido]] > [[GE Auditor de Ambiente|Auditor de Ambiente]]
 

O '''Auditor de Ambiente''' oferece ao usuário uma ferramenta robusta para realizar auditorias de conformidade no ambiente. Ele verifica elementos essenciais ao correto funcionamento do sistema, como:
:* Estrutura de objetos do banco de dados.

:* Outros itens necessários para a operação do sistema.

'''Acesso ao Auditor de Ambientes:'''
Para acessar o Auditor de Ambiente, utilize o recurso de '''Acesso Rápido''' por meio das seguintes opções:
:* Atalho: '''F11'''.
:* Ícone: '''Raio''' no menu principal.

[[Arquivo:Auditor1.jpg|600px|centro|auditor1]]

=As etapas do processo são:=
== Etapa “O que deseja auditar?” ==
Nessa etapa, o usuário define os itens a serem auditados, com as seguintes opções disponíveis:

:* ❑ '''Selecionar verificações individualmente.'''
::Permite personalizar a seleção das verificações desejadas, de acordo com áreas, módulos e tipos de objetos.
:* ❑ '''Tabelas (existência, estrutura e índices):'''
::Compara a estrutura das tabelas da versão em execução com a estrutura no banco de dados (BD) do ambiente selecionado. A análise considera os seguintes aspectos para as tabelas:
::* Existência das tabelas.
::* Estrutura das tabelas.
::* Índices associados às tabelas.
:* ❑ '''Compilação de objetos de banco de dados:'''
::Realiza auditoria nos objetos do banco de dados, verificando:
::* Se pertencem ao produto ou são customizados.
::* A ausência de objetos essenciais.
::* A necessidade de recompilar objetos descompilados.
:* ❑ '''Arquivos da instalação:''' <ref group="Versão 250505" name="multiple">Liberado a partir da OS 898493/1.</ref>
::Verifica os arquivos da instalação, comparando-os com os arquivos do pacote oficial da versão para identificar possíveis divergências.

:'''Observação:'''
:Ao selecionar a opção “'''Selecionar verificações individualmente'''”, caso alguma outra opção tenha sido marcada, será desmarcada automaticamente.

==Etapa “Verificação”==
Essa etapa é ativada apenas quando a opção “Selecionar verificações individualmente” está marcada.
* Selecione as verificações desejadas:
:O sistema permite a seleção personalizada das verificações a serem realizadas. A seleção é organizada em dois níveis:
::* '''Primeiro nível:''' Representa as áreas.
::* '''Segundo nível:''' Corresponde aos módulos dentro dessas áreas.

* Tipos de objetos a serem verificados:
:* Quando a seleção é feita na primeira tela do Auditor, todos os tipos de objetos são automaticamente incluídos na verificação.
:* Caso a seleção ocorra na tela de seleção individual, o usuário pode escolher manualmente os tipos de objetos que deseja verificar.
{{VoltarInicio}}

==Etapa “Preparado para iniciar”==
Nesta etapa, o sistema aguarda a confirmação do usuário para prosseguir com a operação. Ao clicar no botão "Avançar", a execução da rotina será iniciada conforme as configurações selecionadas.

==Etapa “Executando”==
Nesta etapa, ocorre a execução da auditoria conforme a opção selecionada anteriormente. As verificações realizadas incluem:
:* '''Tabelas da versão x Tabelas no BD:'''
:: Verifica se as tabelas definidas na versão estão presentes no banco de dados.
:* '''Campos das tabelas x Campos no BD:'''
::Compara os campos das tabelas da versão com os campos das tabelas no banco de dados, avaliando a conformidade.
:* '''Índices das tabelas x Índices no BD:'''
::Analisa os índices relacionados às tabelas, considerando:
::* Quantidade total de índices;
::* Nomes dos índices;
::* Elementos que compõem cada índice.
:* '''Índices customizados:'''
::Identifica índices existentes no banco de dados que não fazem parte da estrutura oficial da tabela, ou seja, que foram criados como customizações.
:* '''Objetos cadastrados via XML:'''
::Compara os objetos definidos em arquivos XML com os existentes no ambiente atual, avaliando eventuais discrepâncias.
:* '''Objetos descompilados:'''
::Identifica e avalia objetos descompilados na versão, destacando aqueles que precisam de atenção para correção ou atualização.
:* '''Arquivos da instalação:''' <ref group="Versão 250505" name="multiple">Liberado a partir da OS 898493/1.</ref>
::Compara os arquivos presentes na instalação, com aos arquivos oficiais do pacote da versão, avaliando eventuais divergências.

==Etapa "Resultados"==
Nessa tela, são exibidas as tabelas e objetos de banco de dados avaliados conforme a seleção do usuário, apresentando as seguintes informações:
: ✔ Tabelas (existência, estrutura e índices) 
:* '''Tabela:''' Nome "Magic" da tabela (exemplo: Tipo Pagamento).
:* '''Nome lógico:''' Nome lógico da tabela (exemplo: %GFTIPOPAGTO%).
:* '''Nome BD:''' Nome da tabela no banco de dados (exemplo: GFTIPOPA).
:* '''Situação:''' Status conforme avaliação realizada pela rotina, com as seguintes possibilidades:
:** '''Ok:''' Tudo está em conformidade.
:** '''Aviso:''' Há divergências menores.
:** '''Erro:''' Divergências significativas encontradas.
::Quando a situação for "Aviso" ou "Erro", o botão '''Detalhar''' exibirá informações detalhadas sobre as divergências.

:: Funcionalidades adicionais para tabelas: 
::* '''Ordenação:''' Todas as colunas descritas podem ser utilizadas para ordenar os registros exibidos.

::* '''Botão "Ajustar índices":'''
::** Ajusta os índices que não estão criados corretamente no banco de dados.
::** Disponível apenas para usuários do tipo Supervisor ou membros do grupo SUPERVISOR. <ref group="Versão 221107.c" name="221107.c">Liberado a partir da OS 373456/410.</ref> e <ref group="Versão 230502" name="v230502">Liberado a partir da OS 373456/410.</ref>.
::** '''Importante:''' Essa opção deve ser executada somente quando o usuário logado for o único utilizando o CIGAM.
::* '''Botão "Gerar Script":''' Gera um arquivo com extensão '''.txt''' contendo os scripts dos índices a serem ajustados.
:::'''Nota:''' Em casos de inconformidades nas tabelas, é necessário executar a rotina '''Atualiza Tabelas''', conforme as orientações disponíveis na documentação [[GE - Como Fazer - Atualizar tabelas|Atualizar tabelas]]. 
------------
: ✔ Compilação de objetos de banco de dados 
:* '''Nome do objeto:''' Nome do objeto (exemplo: CG_VW_COLABORADORES).
:* '''Tipo de objeto:'''
:** Triggers (*.trg)
:** Types especifications (*.tps)
:** Functions (*.fnc)
:** Sequence scripts (*.sqc)
:** Types (*.typ)
:** Views (*.vew)
:** Packages (*.pck)
:** Procedures (*.prc)
:* '''Situação:''' Status conforme avaliação realizada pela rotina, com as seguintes possibilidades:
:** '''Ok:''' Objeto em conformidade.
:** '''Não encontrado:''' Objeto ausente no banco de dados.
:** '''Descompilado:''' Objeto não sincronizado ou com erros de compilação.
:** '''Customizado/Não produto:''' Alterado pelo cliente ou fora do padrão do produto.

:: Funcionalidades adicionais para os objetos: 
::* '''Botão "Compilar objetos":''' Compila os objetos que não foram sincronizados durante a atualização.
::* '''Botão "Exportar para CSV":''' Gera um arquivo delimitado com os dados na ordem apresentada na tela.
------------
: ✔ Arquivos da instalação <ref group="Versão 250505" name="multiple">Liberado a partir da OS 898493/1.</ref> 
:* '''Arquivo:''' Nome do arquivo presente na instalação que está sendo auditada.
:* '''Caminho:''' Local onde o arquivo se encontra.
:* '''Situação:''' Status conforme avaliação realizada pela rotina, com as seguintes possibilidades:
:** '''Ok:''' O arquivo do pacote da versão está presente na instalação e em conformidade.
:** '''Aviso:''' O arquivo não foi encontrado na instalação. Exclusivo para os arquivos da pasta Scripts.
:** '''Divergência:''' O arquivo não foi encontrado na instalação ou está presente na instalação e está diferente do arquivo da versão.
::Quando a situação for "Aviso" ou "Divergência", o botão '''Detalhar''' exibirá informações detalhadas sobre a divergência.
::'''Nota:''' Os arquivos verificados pelo Auditor de Ambiente são os que estão nas pastas listadas abaixo, juntamente com suas respectivas subpastas:
:::* %CIGAM_INSTAL% (pasta raiz da instalação)
:::* %CIGAM_INSTAL%Apoio\
:::* %CIGAM_INSTAL%Cab\
:::* %CIGAM_INSTAL%Scripts\
{{VoltarInicio}}

=Quais as verificações de índices que são executadas?=
A partir da <ref group="Versão 221107.c" name="221107.c">Liberado a partir da OS 373456/410.</ref> e <ref group="Versão 230502" name="v230502">Liberado a partir da OS 373456/410.</ref>, a coluna "Situação" apresenta a opção "'''Detalhes'''". Ao clicar nela, uma janela é exibida contendo o resultado das verificações realizadas na tabela. 
 
As verificações de índices incluem:
:*'''Existência dos índices:''' Confirma se todos os índices especificados nas tabelas da versão estão devidamente criados no banco de dados.
:*'''Conformidade dos índices:''' Verifica se os índices das tabelas possuem todos os elementos configurados corretamente, conforme definido nas tabelas da versão.

Caso alguma dessas condições não seja atendida, as seguintes situações podem ser apresentadas em "'''Situação - Detalhes'''":
:*'''Índice não encontrado:''' Indica que o índice especificado não existe no banco de dados.
:*'''Ordenação incorreta:''' Informa que o índice foi localizado, mas a ordenação dos elementos não está conforme o esperado, detalhando qual deveria ser a ordem correta.

== Versões ==
=== Versão 221107 Patch 'c' ===
<references group="Versão 221107.c"/>
=== Versão 230502 ===
<references group="Versão 230502"/>
=== Versão 250505 ===
<references group="Versão 250505"/>

GE Auditor de Ambiente

2025-03-10T11:14:38Z

Alessandro.voto: /* Etapa “O que deseja auditar?” */

{{VoltarPagina}}

[[Utilidades/Diversos]] > [[GE_Acesso rápido|Acesso rápido]] > [[GE Auditor de Ambiente|Auditor de Ambiente]]
 

O '''Auditor de Ambiente''' oferece ao usuário uma ferramenta robusta para realizar auditorias de conformidade no ambiente. Ele verifica elementos essenciais ao correto funcionamento do sistema, como:
:* Estrutura de objetos do banco de dados.

:* Outros itens necessários para a operação do sistema.

'''Acesso ao Auditor de Ambientes:'''
Para acessar o Auditor de Ambiente, utilize o recurso de '''Acesso Rápido''' por meio das seguintes opções:
:* Atalho: '''F11'''.
:* Ícone: '''Raio''' no menu principal.

[[Arquivo:Auditor1.jpg|600px|centro|auditor1]]

=As etapas do processo são:=
== Etapa “O que deseja auditar?” ==
Nessa etapa, o usuário define os itens a serem auditados, com as seguintes opções disponíveis:

:* ❑ '''Selecionar verificações individualmente.'''
::Permite personalizar a seleção das verificações desejadas, de acordo com áreas, módulos e tipos de objetos.
:* ❑ '''Tabelas (existência, estrutura e índices):'''
::Compara a estrutura das tabelas da versão em execução com a estrutura no banco de dados (BD) do ambiente selecionado. A análise considera os seguintes aspectos para as tabelas:
::* Existência das tabelas.
::* Estrutura das tabelas.
::* Índices associados às tabelas.
:* ❑ '''Compilação de objetos de banco de dados:'''
::Realiza auditoria nos objetos do banco de dados, verificando:
::* Se pertencem ao produto ou são customizados.
::* A ausência de objetos essenciais.
::* A necessidade de recompilar objetos descompilados.
:* ❑ '''Arquivos da instalação:''' <ref group="Versão 250505" name="multiple">Liberado a partir da OS 898493/1.</ref>
::Verifica os arquivos da instalação, comparando-os com os arquivos do pacote oficial da versão para identificar possíveis divergências.

:'''Observação:'''
:Ao selecionar a opção “'''Selecionar verificações individualmente'''”, caso alguma outra opção tenha sido marcada, será desmarcada automaticamente.

==Etapa “Verificação”==
Essa etapa é ativada apenas quando a opção “Selecionar verificações individualmente” está marcada.
* Selecione as verificações desejadas:
:O sistema permite a seleção personalizada das verificações a serem realizadas. A seleção é organizada em dois níveis:
::* '''Primeiro nível:''' Representa as áreas.
::* '''Segundo nível:''' Corresponde aos módulos dentro dessas áreas.

* Tipos de objetos a serem verificados:
:* Quando a seleção é feita na primeira tela do Auditor, todos os tipos de objetos são automaticamente incluídos na verificação.
:* Caso a seleção ocorra na tela de seleção individual, o usuário pode escolher manualmente os tipos de objetos que deseja verificar.
{{VoltarInicio}}

==Etapa “Preparado para iniciar”==
Nesta etapa, o sistema aguarda a confirmação do usuário para prosseguir com a operação. Ao clicar no botão "Avançar", a execução da rotina será iniciada conforme as configurações selecionadas.

==Etapa “Executando”==
Nesta etapa, ocorre a execução da auditoria conforme a opção selecionada anteriormente. As verificações realizadas incluem:
:* '''Tabelas da versão x Tabelas no BD:'''
:: Verifica se as tabelas definidas na versão estão presentes no banco de dados.
:* '''Campos das tabelas x Campos no BD:'''
::Compara os campos das tabelas da versão com os campos das tabelas no banco de dados, avaliando a conformidade.
:* '''Índices das tabelas x Índices no BD:'''
::Analisa os índices relacionados às tabelas, considerando:
::* Quantidade total de índices;
::* Nomes dos índices;
::* Elementos que compõem cada índice.
:* '''Índices customizados:'''
::Identifica índices existentes no banco de dados que não fazem parte da estrutura oficial da tabela, ou seja, que foram criados como customizações.
:* '''Objetos cadastrados via XML:'''
::Compara os objetos definidos em arquivos XML com os existentes no ambiente atual, avaliando eventuais discrepâncias.
:* '''Objetos descompilados:'''
::Identifica e avalia objetos descompilados na versão, destacando aqueles que precisam de atenção para correção ou atualização.
:* '''Arquivos da instalação:''' <ref group="Versão 250505" name="multiple">Liberado a partir da OS 898493/1.</ref>
::Compara os arquivos presentes na instalação, com aos arquivos oficiais do pacote da versão, avaliando eventuais divergências.

==Etapa "Resultados"==
Nessa tela, são exibidas as tabelas e objetos de banco de dados avaliados conforme a seleção do usuário, apresentando as seguintes informações:
: ✔ Tabelas (existência, estrutura e índices) 
:* '''Tabela:''' Nome "Magic" da tabela (exemplo: Tipo Pagamento).
:* '''Nome lógico:''' Nome lógico da tabela (exemplo: %GFTIPOPAGTO%).
:* '''Nome BD:''' Nome da tabela no banco de dados (exemplo: GFTIPOPA).
:* '''Situação:''' Status conforme avaliação realizada pela rotina, com as seguintes possibilidades:
:** '''Ok:''' Tudo está em conformidade.
:** '''Aviso:''' Há divergências menores.
:** '''Erro:''' Divergências significativas encontradas.
::Quando a situação for "Aviso" ou "Erro", o botão '''Detalhar''' exibirá informações detalhadas sobre as divergências.

:: Funcionalidades adicionais para tabelas: 
::* '''Ordenação:''' Todas as colunas descritas podem ser utilizadas para ordenar os registros exibidos.

::* '''Botão "Ajustar índices":'''
::** Ajusta os índices que não estão criados corretamente no banco de dados.
::** Disponível apenas para usuários do tipo Supervisor ou membros do grupo SUPERVISOR. <ref group="Versão 221107.c" name="221107.c">Liberado a partir da OS 373456/410.</ref> e <ref group="Versão 230502" name="v230502">Liberado a partir da OS 373456/410.</ref>.
::** '''Importante:''' Essa opção deve ser executada somente quando o usuário logado for o único utilizando o CIGAM.
::* '''Botão "Gerar Script":''' Gera um arquivo com extensão '''.txt''' contendo os scripts dos índices a serem ajustados.
:::'''Nota:''' Em casos de inconformidades nas tabelas, é necessário executar a rotina '''Atualiza Tabelas''', conforme as orientações disponíveis na documentação [[GE - Como Fazer - Atualizar tabelas|Atualizar tabelas]]. 
------------
: ✔ Compilação de objetos de banco de dados 
:* '''Nome do objeto:''' Nome do objeto (exemplo: CG_VW_COLABORADORES).
:* '''Tipo de objeto:'''
:** Triggers (*.trg)
:** Types especifications (*.tps)
:** Functions (*.fnc)
:** Sequence scripts (*.sqc)
:** Types (*.typ)
:** Views (*.vew)
:** Packages (*.pck)
:** Procedures (*.prc)
:* '''Situação:''' Status conforme avaliação realizada pela rotina, com as seguintes possibilidades:
:** '''Ok:''' Objeto em conformidade.
:** '''Não encontrado:''' Objeto ausente no banco de dados.
:** '''Descompilado:''' Objeto não sincronizado ou com erros de compilação.
:** '''Customizado/Não produto:''' Alterado pelo cliente ou fora do padrão do produto.

:: Funcionalidades adicionais para os objetos: 
::* '''Botão "Compilar objetos":''' Compila os objetos que não foram sincronizados durante a atualização.
::* '''Botão "Exportar para CSV":''' Gera um arquivo delimitado com os dados na ordem apresentada na tela.
------------
: ✔ Arquivos da instalação <ref group="Versão 250505" name="multiple">Liberado a partir da OS 898493/1.</ref> 
:* '''Arquivo:''' Nome do arquivo presente na instalação que está sendo auditado.
:* '''Caminho:''' Local onde o arquivo está armazenado na pasta da instalação.
:* '''Situação:''' Status conforme avaliação realizada pela rotina, com as seguintes possibilidades:
:** '''Ok:''' O arquivo do pacote da versão está presente na instalação e em conformidade.
:** '''Aviso:''' O arquivo não foi encontrado na instalação. Exclusivo para os arquivos da pasta Scripts.
:** '''Divergência:''' O arquivo não foi encontrado na instalação ou está presente na instalação, mas está diferente do arquivo da versão.
::Quando a situação for "Aviso" ou "Divergência", o botão '''Detalhar''' exibirá informações detalhadas sobre a divergência.
::'''Nota:''' Os arquivos verificados pelo Auditor de Ambiente são os que estão nas pastas listadas abaixo, juntamente com suas respectivas subpastas:
:::* %CIGAM_INSTAL% (pasta raiz da instalação)
:::* %CIGAM_INSTAL%Apoio\
:::* %CIGAM_INSTAL%Cab\
:::* %CIGAM_INSTAL%Scripts\
{{VoltarInicio}}

=Quais as verificações de índices que são executadas?=
A partir da <ref group="Versão 221107.c" name="221107.c">Liberado a partir da OS 373456/410.</ref> e <ref group="Versão 230502" name="v230502">Liberado a partir da OS 373456/410.</ref>, a coluna "Situação" apresenta a opção "'''Detalhes'''". Ao clicar nela, uma janela é exibida contendo o resultado das verificações realizadas na tabela. 
 
As verificações de índices incluem:
:*'''Existência dos índices:''' Confirma se todos os índices especificados nas tabelas da versão estão devidamente criados no banco de dados.
:*'''Conformidade dos índices:''' Verifica se os índices das tabelas possuem todos os elementos configurados corretamente, conforme definido nas tabelas da versão.

Caso alguma dessas condições não seja atendida, as seguintes situações podem ser apresentadas em "'''Situação - Detalhes'''":
:*'''Índice não encontrado:''' Indica que o índice especificado não existe no banco de dados.
:*'''Ordenação incorreta:''' Informa que o índice foi localizado, mas a ordenação dos elementos não está conforme o esperado, detalhando qual deveria ser a ordem correta.

== Versões ==
=== Versão 221107 Patch 'c' ===
<references group="Versão 221107.c"/>
=== Versão 230502 ===
<references group="Versão 230502"/>
=== Versão 250505 ===
<references group="Versão 250505"/>

GE - Como Fazer - Configuração de Envio de E-mail no CIGAM

2025-02-18T19:06:48Z

Alessandro.voto: /* Quais são as configurações para parametrizar o envio de e-mail pelo CIGAM? */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM|Configuração de Envio de E-mail no CIGAM]]



= Configuração de envio e email pelo Sistema CIGAM =
O uso de envio de e-mail pelo Sistema Cigam requer informações fornecidas pelo cliente, parametrizações de máquina e configurações de sistema para o correto funcionamento. 

== Quais são as informações de Envio de E-mail para parametrização?==
As informações são geralmente repassadas pelo próprio cliente ou sua T.I. As informações são: 
⦁ Qual é o servidor de e-mail e respectiva porta? 
⦁ Qual é a conta de e-mail do usuário? 
⦁ Qual é a senha de e-mail do usuário? 
⦁ É utilizado algum método de segurança, como SSL (Secure Sockets Layer)? 

== Quais as parametrizações de Envio de E-mail de máquina? ==
O Framework .Net precisa estar devidamente instalado e com suas permissões. Para saber como parametrizar o .Net verificar o documento “[[GE - Como Fazer - Instalação do .Net|Como Fazer - Instalação do .Net]]”. 
{{VoltarInicio}}

== Quais são as configurações para parametrizar o envio de e-mail pelo CIGAM? ==
*As configurações do sistema CIGAM envolvidas são: 
** [[GE - AM - 338 - Opção para envio de e-mail]] 
** [[GE - AM - 545 - Auto-assinatura a ser anexada no envio de e-mail]]
** [[GE - AM - 692 - Servidor de e-mail]]
** [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** [[GE - AM - 1495 - Solicitar confirmação de leitura para e-mails enviados]]
** [[GE - AM - 2077 - Não enviar cópia para o remetente do e-mail]]
** [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** [[GF - GE - 2709 - E-mail do remetente para envio de Boleto]]
** [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]
** [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

== Qual é o cadastro a ser feito? ==
Para o envio de e-mail, é necessário existir um cadastro do usuário sendo opcional a informação do e-mail vinculado a ele. 
<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref> Caso conste informado e-mail no cadastro, esse será considerado somente se a configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] não constar informada. 
Para ser possível o envio de e-mail é necessário que uma das opções conste com o usuário para o login do servidor de e-mail. Seja ele a configuração ou o cadastro de usuário, quando informado nas duas opções acima mencionadas, será respeitado sempre o que estiver informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]]. 
 
O cadastro de usuário e seu e-mail (opcional) é feito através do programa Usuários - Grupos e Direitos
*Utilidades / Diversos
**Parâmetros
***Usuários
****Usuário - Grupos Direitos 

É possível além do e-mail (opcional), informar a Unidade de Negócio (opcional) caso queira reforçar a unidade que pertence o usuário. 
 
Após realizado o cadastro ou eventual modificação, o ajuste só será validado na próxima sessão para isso preciso sair do sistema e entrar novamente para carregar as parametrizações ou então acessar a área onde consta o perfil do usuário e clicar na opção Carregar Parâmetros.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção SmtpClient? ==
SMTP - (Protocolo de Transferência de Correio Simples é o protocolo padrão de envio de mensagens de correio eletrônico através da Internet entre dois dispositivos computacionais). 
Para que seja possível o envio de email via SmtpClient é necessário ter as seguintes configurações parametrizadas:
* E-mail informado no cadastro do usuário 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''SmtpClient'''
* [[GE - AM - 692 - Servidor de e-mail]]
** Indicado o servidor de e-mail seguido por ‘:’ e a porta liberada para envio de e-mail. 
**Se não informado o número da porta o sistema irá realizar o envio de e-mail pela porta padrão: 25 correspondente aos e-mails que serão utilizados para o envio. 
**Para obter as informações servidor e porta para envio de e-mail acesse uma ferramenta de envio de e-mail que esteja configurada (Ex.: Outlook) e busque pelas informações nas propriedades da conta. 
* [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** Opcional deixar a senha já informada para envio direto do e-mail, caso não seja informada pedirá a senha na hora do envio.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada quando o servidor de envio de e-mail utilizado exigir o usuário + o domínio completo para a autenticação (Ex: conta@dominio.com.br). Quando essa configuração estiver desmarcada só será considerado o informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] ou no cadastro de usuário até o caractere @.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP

* '''IMPORTANTE:''' A partir de 30 de maio de 2022, alguns servidores não autorizaram mais o uso de apps ou dispositivos de terceiros que exigem apenas nome de usuário e senha para fazer login na conta, sendo assim indicamos a aplicação da verificação em duas etapas nas contas a serem utilizadas e a utilização de senhas de app, sendo obrigatória para acesso do email no CIGAM a utilização da senha de app. 
* Ao aplicar a senha de APP no CIGAM não será exigido autenticação em duas etapas devido a composição da senha fornecida pelo provedor basta informar ela na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou individualmente a cada envio que esse ocorrerá normalmente. 
** Para configuração de senhas de app consulte a documentação do seu servidor de e-mail, procurando por '''senhas de APP''' ou '''gerenciamento de senhas de APP''', ou siga as informações abaixo.

{{VoltarInicio}}

=== Como criar uma senha de aplicativo ===
====Senha de aplicativo Gmail====
Ao seguir esses passos, você poderá configurar corretamente uma senha de aplicativo no Gmail para ser utilizada com o CIGAM, garantindo que o envio de e-mails via SMTP funcione adequadamente sem a necessidade de usar sua senha principal da conta do Google. 
 
Para configurar uma senha de aplicativo no Gmail, especialmente quando você está utilizando o servidor de envio SMTP e a opção está informada como SmtpClient na configuração [[GE - AM - 338 - Opção para envio de e-mail]], acesse [https://support.google.com/accounts/answer/185833?hl=pt-BR Criar e usar senhas de app] e siga os passos. 
 
Ao acessar, deverá ser informado para qual tipo de app será utilizado, neste caso será "E-mail" e posteriormente será informado para qual tipo de dispositivo.
 
[[Image: envioemailCigam5.png|550px|centro]]
 
Ao clicar em gerar, será gerada uma senha para o dispositivo. Acesse o menu [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Configurações|Configurações]] para informar na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] a senha gerada.
 
[[Image: envioemailCigam6.png|550px|centro]]

====Senha de aplicativo Outlook====
Servidor de envios Office365, será necessário habilitar a Senha de Aplicativo: 
[https://account.live.com/proofs/manage/additional?mkt=pt-BR&refd=account.microsoft.com&refp=security Acesso direto conta Pessoal] 
[https://mysignins.microsoft.com/security-info Acesso diretor conta Profissional - Administrado por Exchange]
 
[[Image: envioemailCigam12.png|750px|centro]]
 
Inserir uma validação com: E-mail ou Telefone:
 
[[Image: envioemailCigam13.png|300px|centro]]
 
Ativar a verificação em duas etapas:
 
[[Image: envioemailCigam14.png|750px|centro]]
 
Após ativar, irá aparecer a opção Senha de Aplicativo, sendo necessária a criação e inserção na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]].
 
[[Image: envioemailCigam15.png|750px|centro]]
 
Caso a Senha de Aplicativo não esteja habilitada, será necessário ativar a Autenticação Multifator(MFA) dentro do [https://admin.exchange.microsoft.com Exchange do Office365].
 
[[Image: envioemailCigam9.png|750px|centro]]
 
Deve-se verificar se a autenticação SMTP está ativa. Somente o Administrador poderá verificar.
 
[[Image: envioemailCigam7.png|350px|centro]]
{{VoltarInicio}}

====Validação Kinghost====
O provedor Kinghost quando utilizado em ambiente nuvem como: FWC ou Nuvem CIGAM, necessitam que seja realizada a parametrização do SMTPI no provedor, assim como o ajuste do SMTP no CIGAM. 
 
[https://king.host/wiki/artigo/como-ativar-o-smtp-internacional/ Como ativar SMTPI Kinghost]

== Como configurar para utilização de envio através da opção Gmail API? ==
Gmail API - (Para usuários do Gmail, a API do Gmail é a melhor opção para acesso autorizado aos dados do Gmail de um usuário. Isso não armazena nenhum dos e-mails no banco de dados de terceiros, proporcionando mais segurança e privacidade aos seus e-mails. A API do Gmail é usada para interagir com as caixas de entrada e configurações do Gmail dos usuários e oferece suporte a várias linguagens de programação populares). 
 
O envio de email via CIGAM através do Gmail API devem ser autorizadas via credenciais do OAuth 2.0. 
Essa funcionalidade exige a utilização de um token de autorização de acesso ao qual deve ser criado através da console de APIs Google - '''[[https://support.google.com/googleapi/answer/6158849/?hl=en&authuser=1| Configurando o OAuth 2.0]]'''.

*As configurações do sistema CIGAM envolvidas são: 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''Gmail API'''
* [[GE - AM - 692 - Servidor de e-mail]]
** smtp.gmail.com:587 
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]
**Pressione F5 e na tela de Cadastro de credenciais, informe o conteúdo do arquivo feito download anteriormente ou clique em ‘Importar’ conforme a configuração feita para obter o token de autorização via console de APIs Google e confirme.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada para o funcionamento do envio via Gmail API
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via Gmail API

* '''Importante:''' Caso não haja informação nas configurações necessárias para validar credenciais, ao enviar o e-mail será aberta uma tela para colocar as informações necessárias.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção OAuth? ==
A partir da <ref group="Versão 241007">Liberado a partir da OS 373456/716.</ref>, a configuração [[GE - AM - 338 - Opção para envio de e-mail]] agora inclui a possibilidade de enviar e-mails utilizando o protocolo OAuth.
:'''OAuth''' refere-se ao processo de envio de e-mails em que a autenticação é feita utilizando o protocolo OAuth (Open Authorization). 
<blockquote>
OAuth é um padrão de autorização que permite que aplicativos acessem recursos, como contas de e-mail, em nome de um usuário, sem precisar saber a senha do usuário. Em vez disso, OAuth utiliza tokens de acesso temporários que autorizam a aplicação a realizar operações, como o envio de e-mails, de forma segura e controlada. 
 
Quando um aplicativo envia e-mails usando OAuth, ele primeiro solicita a autorização do usuário para acessar sua conta de e-mail. Uma vez autorizado, o aplicativo recebe um token de acesso, que pode ser usado para autenticar futuras requisições, como o envio de e-mails. Este método é amplamente adotado por provedores de e-mail como Google (Gmail), Microsoft (Outlook), e outros, por oferecer maior segurança, pois reduz o risco de comprometimento de senhas e permite que os usuários revoguem o acesso a qualquer momento.
</blockquote>

===Envio de e-mail via Office 365===
:O envio de e-mails pelo CIGAM via 'Office 365' deve ser autenticado usando as credenciais do OAuth 2.0. Essa funcionalidade requer a criação e utilização de um token de autorização, que deve ser gerado através da console de administração do Office 365 - [[Como configurar autenticação Office 365 OAuth 2.0]]. Este token garante acesso seguro e permite que o CIGAM envie e-mails em nome do usuário sem a necessidade de expor senhas, aumentando a segurança no processo de comunicação.

'''As configurações do sistema CIGAM envolvidas são:''' 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção: '''OAuth'''

* [[GE - AM - 3233 - OAuth para envio de e-mail]]
** Opção: Informar o Id do cadastro da parametrização desejada
::::Cadastro de parâmetros OAuth
:::::001.1 - Office 365 OAuth 2.0

* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.

* [[GE - AM - 3074 - E-mail do sistema]]

* [[GE - AM - 3075 - Senha do e-mail do sistema]]

* [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]

* [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

:'''Importante:''' A autenticação será realizada sempre com base no remetente do e-mail, que pode variar conforme a rotina utilizada.

===Envio de e-mail com OAuth utilizando o SendGrid===
:O '''SendGrid''' é uma plataforma de envio de e-mails, desenvolvida por terceiros, que atua como intermediário entre uma aplicação e os servidores de e-mail dos destinatários. Essa plataforma oferece recursos como autenticação, monitoramento e alta entregabilidade, e pode ser integrada a aplicações utilizando autenticação via protocolo OAuth para acessar suas APIs.

Antes de iniciar as parametrizações, é necessário realizar o download dos arquivos conforme link abaixo e colocá-los no local da instalação do CIGAM, dentro da pasta 'Cab\Exclusivo'. Exemplo: %CIGAM_INSTAL%\Cab\Exclusivo\EnvioEmailCustomizado\. 
Clique para baixar o pacote de arquivos para a versão CIGAM11 [https://www.cigam.com.br/wiki/images/a/a2/EnvioEmailCustomizado.zip EnvioEmailCustomizado.zip]. 
Clique para baixar o pacote de arquivos para a versão CIGAM e10 [https://www.cigam.com.br/wiki/images/2/20/EnvioEmailCustomizadoUniPaaS.zip EnvioEmailCustomizadoUniPaaS.zip]. 
'''Observação:''' para ambientes com a versão CIGAM e10, após realizar o download do arquivo compactado, certifique-se de deixar a pasta com o nome '''EnvioEmailCustomizado'''.

:'''As parametrizações do sistema CIGAM envolvidas são:''' 
: Cadastros e configurações.
: O [[GE Usuário - Grupos e Direitos|cadastro do usuário]] deve estar com o endereço de e-mail devidamente preenchido. Este será utilizado como remetente dos e-mails enviados.
: A configuração '[[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]', permite variar o e-mail do remetente conforme a Unidade de Negócio ativa. Quando informada, terá prioridade sobre o e-mail no cadastrado do usuário. 
:No arquivo MAGIC.INI ou no seu arquivo de adendo, se for o caso, devem ser adicionados na sessão [MAGIC_LOGICAL_NAMES] os nomes lógicos listados abaixo.
:EX_CK02176TSI = S
:EX_CK02176TSICabPrg = EE00003
:EX_CK02176TSICab = *%CIGAM_INSTAL%Cab\Exclusivo\EnvioEmailCustomizado\Cab\EnvioEmailCustomizado.ecf
:EX_SENDGRID_APIKEY =
:EX_EMAIL_CUSTOMIZADO = S

IMPORTANTE: na tradução do nome lógico EX_SENDGRID_APIKEY deve ser informada a chave conforme a parametrização do SendGrid realizada pelo cliente. Veja [[GE - Como Fazer - Como integrar o SendGrid|como integrar o SendGrid]].

{{VoltarInicio}}

== Como utilizar ferramentas que necessitam de senhas com mais de 30 caracteres? ==
A utilização de um servidor de relay de e-mail (SMTP Relay) para envio de e-mails é uma solução eficaz em cenários nos quais é necessário lidar com serviços que requerem senhas longas, como o SendGrid ou Amazon Web Services (AWS). Isso pode ser especialmente útil quando se lida com autenticações complexas ou senhas/tokens longos para serviços de e-mail ou outros serviços que utilizam e-mail para comunicação. 
#'''Autenticação pelo SMTP Relay:''' Ao configurar um servidor de relay de e-mail, o servidor assume a responsabilidade de autenticar-se com o serviço de e-mail (por exemplo, SendGrid ou AWS) em nome do sistema que está enviando os e-mails (neste caso, o CIGAM). Isso significa que o CIGAM não precisa lidar diretamente com senhas/tokens longos, tornando a autenticação mais segura e gerenciável.
#'''Implementação:''' A implementação de um servidor de relay de e-mail é responsabilidade do departamento de TI do cliente ou de uma empresa de TI terceirizada, se for esse o caso. A configuração envolve definir as credenciais de autenticação para o serviço de relay, configurar as regras de envio de e-mail e direcionar o CIGAM para usar o servidor de relay.
#'''Considerações de Segurança:''' Certifique-se de que o servidor de relay de e-mail seja adequadamente seguro e mantenha as boas práticas de segurança para proteger as credenciais armazenadas. Além disso, considere a implementação de autenticação em dois fatores (2FA) para aumentar a segurança.

= Envio de e-mail usuários externos =
<ref group="Versão 220404.c"> Liberado a partir da OS 373456/391. </ref> Os e-mails a serem enviados via portais respeitam as mesmas configurações aplicadas diretamente no desktop, os usuários sempre devem possuir um cadastro no CIGAM e seu e-mail no cadastro de usuários. 
* Para que seja possível o envio de e-mail para usuários externos deve ter as seguintes parametrizações: 
** Ter configurado no sistema o envio de e-mail conforme orientações acima
** Informação na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] se optar por não informar a senha de e-mail a cada acesso ao portal.
Sendo assim onde existir a implementação da funcionalidade, caso a configuração: [[GE - AM - 904 - Senha para login no servidor de e-mail]] não conste informada para o usuário será exibida uma tela para que seja possível indicar a senha para login no servidor de e-mail e consequentemente fazer o envio. Essas informações serão aplicadas até o próximo acesso sem necessidade de informar novamente.
{{VoltarInicio}}

=Manuais Referenciados=
*[[Configurações e parametrizações para envio de e-mail através do Cigam]]

= Versão 220404 =
=== Patch "c" ===
<references group="Versão 220404.c"/>
= Versão 221107 =
=== Patch "c" ===
<references group="Versão 221107.c"/>
= Versão 241007 =
<references group="Versão 241007"/>

Configurações e parametrizações para envio de e-mail através do Cigam

2025-02-18T19:01:43Z

Alessandro.voto: /* Quais as configurações pertinentes para o envio de documentos eletrônicos */

[[FAQ_CIGAM]] > [[FAQ_Utilidades/Diversos]] > [[FAQ_Ambiente|Ambiente]] > [[Configurações e parametrizações para envio de e-mail através do Cigam]]
 


==Palavras-Chave==
CIGAM não envia E-mail. Email. Cliente não estão recebendo e-mails. E-mails não estão sendo enviados. Clientes não estão recebendo os XMLs das Notas Fiscais. Cliente não está recebendo os e-mails das Notas Fiscais.

= Você já tentou enviar e-mail a partir das teclas Ctrl+E do seu teclado? =
Se você está tentando enviar um e-mail por meio de alguma rotina do CIGAM e ele não está sendo enviado, siga os passos abaixo para realizar um teste de envio:
# '''Abra qualquer tela do sistema.'''
# '''Pressione Ctrl+E no seu teclado.'''
## Isso abrirá a tela para envio de e-mail.
# '''Preencha os campos necessários:'''
## '''Destinatário:''' Insira o endereço de e-mail do destinatário.
## '''Assunto:''' Insira um assunto para o e-mail.
## '''Conteúdo:''' Escreva uma mensagem de teste.
# '''Clique em "Enviar".'''
 
[[Image: envioemailCigam10.png|650px|centro]]
 
Se, após realizar este teste, o e-mail não for enviado, siga os passos indicados abaixo para avaliação. 
 
;'''Passo 1:'''
<blockquote>
Se, ao tentar enviar o e-mail, uma mensagem de erro for gerada, verifique o endereço de e-mail parametrizado no seu usuário, ou seja, o usuário que está tentando realizar o envio. 
 
Para verificar, siga os passos abaixo:
# Acesse o menu [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE Usuário - Grupos e Direitos|Usuário - Grupos e Direitos]].
# Localize o usuário que deseja avaliar.
# Observe o e-mail associado a este usuário.

Por exemplo, para avaliar o usuário "A00 - Supervisor", verifique se o e-mail está correto e atualizado.
 
[[Image: envioemailCigam1.png|750px|centro]]
</blockquote>

;'''Passo 2:'''
<blockquote>
'''Observação:''' Este exemplo aborda a avaliação pertinente ao provedor de e-mail Gmail. No entanto, cada provedor pode ter características próprias, como o uso de SSL e configurações de SMTP/Porta. Portanto, podem ser necessárias avaliações diferente de acordo com o provedor de e-mail utilizado. 
 
É essencial validar as configurações de e-mail através do menu [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Configurações|Configurações]]. As configurações a serem verificadas são as seguintes:
# '''Método de envio SMTP''' na configuração [[GE - AM - 338 - Opção para envio de e-mail]].
# '''Configuração [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]:''' Verifique se o e-mail utiliza SSL/TLS.
# '''Configuração [[GE - AM - 692 - Servidor de e-mail]]:''' Certifique-se de que o SMTP e a Porta estão configurados corretamente.
# '''Configuração [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]:''' Deixe esta opção Ativa.
# '''Configuração [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]:''' Deixe esta opção Ativa.
# '''Configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]]:''' Deve ser o mesmo e-mail cadastrado para o usuário, validado anteriormente.
# '''Configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]]:''' Insira a senha do e-mail configurado na [[GE - AM - 903 - Usuário para login no servidor de e-mail]].
# ''Clique aqui para ver todas as configurações referente ao envio de e-mail: [[GE_-_Como_Fazer_-_Configura%C3%A7%C3%A3o_de_Envio_de_E-mail_no_CIGAM#Quais_s%C3%A3o_as_configura%C3%A7%C3%B5es_para_parametrizar_o_envio_de_e-mail_pelo_CIGAM?|Envio de e-mail]]''
</blockquote>

Caso o problema persista, siga os passos abaixo: 
* '''Valide as credenciais:'''
** Acesse o e-mail utilizando as credenciais inseridas no sistema para garantir que o e-mail e a senha estão corretos.
* '''Verifique as configurações do servidor de envio de e-mail:'''
** '''Gmail:''' Confirme as configurações de SMTP e porta específicas do Gmail.
** '''Outlook:''' Confirme as configurações de SMTP e porta específicas do Outlook.
** '''Kinghost:''' Confirme as configurações de SMTP e porta específicas do Kinghost.
{{VoltarInicio}}

= Você está utilizando o CIGAMe10 e mais ninguém envia e-mail? =
Se a resposta for sim, pode ser que seja necessário registrar as DLL’s do CIGAM, solicitamos que entrem em contato com o suporte. 
 
Somente poderá enviar e-mail, se estiver na versão do CIGAMe10 181221.x ou superior.

= Quais as configurações pertinentes para o envio de documentos eletrônicos =
*Configuração [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]: Inserir o e-mail para documentos legais.
** Opcional
*Configuração [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]: Inserir a senha para documentos legais.
** Opcional
*Configuração [[GF - GE - 2709 - E-mail do remetente para envio de Boleto]]: Inserir o e-mail para envio de boletos.
** Opcional

= Como informar uma configuração por usuário? =
<center>
<li style="display: inline-block; vertical-align: center;"> [[File:envioemailCigam2.png|thumb|none|750px|'''Observação:''' Quando o texto da configuração estiver em negrito, indica que há informação cadastrada dentro da configuração, variando por usuário.]] </li>
</center>
 
<center>
<li style="display: inline-block; vertical-align: center;"> [[File:envioemailCigam3.png|thumb|none|750px|Nesses casos, devemos validar as configurações "Por usuário". Para consultar, acesse o botão <Por Usuário> da configuração.]] </li>
</center>
{{VoltarInicio}}

= Como realizar a remoção da senha da configuração 904 e/ou 2787 =
Para remover uma senha das configurações 904 e/ou 2787, siga os seguintes passos:

<gallery widths=400px heights=300px>
File:Email-1.png|1- Acesse o menu [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Configurações|Configurações]]
File:Email-3.png|2- Acessar em modo de modificação - Por usuário
File:Email-5.png|3- Exclusão do registro (Por usuário) através do 'F3'
File:Email-6.png|4- Inclusão do registro através do 'F4' - Novo Usuário
File:Email-7.png|5- Acessar o registro Dado através do 'F5' - Nova Senha
</gallery>
:'''Observação:''' Caso deseje alterar a configuração da capa, será necessário acionar o suporte caso não se tenha conhecimento da senha anterior.
{{VoltarInicio}}


='''Manuais Referenciados'''=
*[[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM]]

GE - Como Fazer - Configuração de Envio de E-mail no CIGAM

2025-02-14T12:43:46Z

Alessandro.voto: /* Envio de e-mail com OAuth utilizando o SendGrid */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM|Configuração de Envio de E-mail no CIGAM]]



= Configuração de envio e email pelo Sistema CIGAM =
O uso de envio de e-mail pelo Sistema Cigam requer informações fornecidas pelo cliente, parametrizações de máquina e configurações de sistema para o correto funcionamento. 

== Quais são as informações de Envio de E-mail para parametrização?==
As informações são geralmente repassadas pelo próprio cliente ou sua T.I. As informações são: 
⦁ Qual é o servidor de e-mail e respectiva porta? 
⦁ Qual é a conta de e-mail do usuário? 
⦁ Qual é a senha de e-mail do usuário? 
⦁ É utilizado algum método de segurança, como SSL (Secure Sockets Layer)? 

== Quais as parametrizações de Envio de E-mail de máquina? ==
O Framework .Net precisa estar devidamente instalado e com suas permissões. Para saber como parametrizar o .Net verificar o documento “[[GE - Como Fazer - Instalação do .Net|Como Fazer - Instalação do .Net]]”. 
{{VoltarInicio}}

== Quais são as configurações para parametrizar o envio de e-mail pelo CIGAM? ==
*As configurações do sistema CIGAM envolvidas são: 
** [[GE - AM - 338 - Opção para envio de e-mail]] 
** [[GE - AM - 545 - Auto-assinatura a ser anexada no envio de e-mail]]
** [[GE - AM - 692 - Servidor de e-mail]]
** [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** [[GE - AM - 1495 - Solicitar confirmação de leitura para e-mails enviados]]
** [[GE - AM - 2077 - Não enviar cópia para o remetente do e-mail]]
** [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]
** [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

== Qual é o cadastro a ser feito? ==
Para o envio de e-mail, é necessário existir um cadastro do usuário sendo opcional a informação do e-mail vinculado a ele. 
<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref> Caso conste informado e-mail no cadastro, esse será considerado somente se a configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] não constar informada. 
Para ser possível o envio de e-mail é necessário que uma das opções conste com o usuário para o login do servidor de e-mail. Seja ele a configuração ou o cadastro de usuário, quando informado nas duas opções acima mencionadas, será respeitado sempre o que estiver informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]]. 
 
O cadastro de usuário e seu e-mail (opcional) é feito através do programa Usuários - Grupos e Direitos
*Utilidades / Diversos
**Parâmetros
***Usuários
****Usuário - Grupos Direitos 

É possível além do e-mail (opcional), informar a Unidade de Negócio (opcional) caso queira reforçar a unidade que pertence o usuário. 
 
Após realizado o cadastro ou eventual modificação, o ajuste só será validado na próxima sessão para isso preciso sair do sistema e entrar novamente para carregar as parametrizações ou então acessar a área onde consta o perfil do usuário e clicar na opção Carregar Parâmetros.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção SmtpClient? ==
SMTP - (Protocolo de Transferência de Correio Simples é o protocolo padrão de envio de mensagens de correio eletrônico através da Internet entre dois dispositivos computacionais). 
Para que seja possível o envio de email via SmtpClient é necessário ter as seguintes configurações parametrizadas:
* E-mail informado no cadastro do usuário 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''SmtpClient'''
* [[GE - AM - 692 - Servidor de e-mail]]
** Indicado o servidor de e-mail seguido por ‘:’ e a porta liberada para envio de e-mail. 
**Se não informado o número da porta o sistema irá realizar o envio de e-mail pela porta padrão: 25 correspondente aos e-mails que serão utilizados para o envio. 
**Para obter as informações servidor e porta para envio de e-mail acesse uma ferramenta de envio de e-mail que esteja configurada (Ex.: Outlook) e busque pelas informações nas propriedades da conta. 
* [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** Opcional deixar a senha já informada para envio direto do e-mail, caso não seja informada pedirá a senha na hora do envio.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada quando o servidor de envio de e-mail utilizado exigir o usuário + o domínio completo para a autenticação (Ex: conta@dominio.com.br). Quando essa configuração estiver desmarcada só será considerado o informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] ou no cadastro de usuário até o caractere @.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP

* '''IMPORTANTE:''' A partir de 30 de maio de 2022, alguns servidores não autorizaram mais o uso de apps ou dispositivos de terceiros que exigem apenas nome de usuário e senha para fazer login na conta, sendo assim indicamos a aplicação da verificação em duas etapas nas contas a serem utilizadas e a utilização de senhas de app, sendo obrigatória para acesso do email no CIGAM a utilização da senha de app. 
* Ao aplicar a senha de APP no CIGAM não será exigido autenticação em duas etapas devido a composição da senha fornecida pelo provedor basta informar ela na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou individualmente a cada envio que esse ocorrerá normalmente. 
** Para configuração de senhas de app consulte a documentação do seu servidor de e-mail, procurando por '''senhas de APP''' ou '''gerenciamento de senhas de APP''', ou siga as informações abaixo.

{{VoltarInicio}}

=== Como criar uma senha de aplicativo ===
====Senha de aplicativo Gmail====
Ao seguir esses passos, você poderá configurar corretamente uma senha de aplicativo no Gmail para ser utilizada com o CIGAM, garantindo que o envio de e-mails via SMTP funcione adequadamente sem a necessidade de usar sua senha principal da conta do Google. 
 
Para configurar uma senha de aplicativo no Gmail, especialmente quando você está utilizando o servidor de envio SMTP e a opção está informada como SmtpClient na configuração [[GE - AM - 338 - Opção para envio de e-mail]], acesse [https://support.google.com/accounts/answer/185833?hl=pt-BR Criar e usar senhas de app] e siga os passos. 
 
Ao acessar, deverá ser informado para qual tipo de app será utilizado, neste caso será "E-mail" e posteriormente será informado para qual tipo de dispositivo.
 
[[Image: envioemailCigam5.png|550px|centro]]
 
Ao clicar em gerar, será gerada uma senha para o dispositivo. Acesse o menu [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Configurações|Configurações]] para informar na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] a senha gerada.
 
[[Image: envioemailCigam6.png|550px|centro]]

====Senha de aplicativo Outlook====
Servidor de envios Office365, será necessário habilitar a Senha de Aplicativo: 
[https://account.live.com/proofs/manage/additional?mkt=pt-BR&refd=account.microsoft.com&refp=security Acesso direto conta Pessoal] 
[https://mysignins.microsoft.com/security-info Acesso diretor conta Profissional - Administrado por Exchange]
 
[[Image: envioemailCigam12.png|750px|centro]]
 
Inserir uma validação com: E-mail ou Telefone:
 
[[Image: envioemailCigam13.png|300px|centro]]
 
Ativar a verificação em duas etapas:
 
[[Image: envioemailCigam14.png|750px|centro]]
 
Após ativar, irá aparecer a opção Senha de Aplicativo, sendo necessária a criação e inserção na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]].
 
[[Image: envioemailCigam15.png|750px|centro]]
 
Caso a Senha de Aplicativo não esteja habilitada, será necessário ativar a Autenticação Multifator(MFA) dentro do [https://admin.exchange.microsoft.com Exchange do Office365].
 
[[Image: envioemailCigam9.png|750px|centro]]
 
Deve-se verificar se a autenticação SMTP está ativa. Somente o Administrador poderá verificar.
 
[[Image: envioemailCigam7.png|350px|centro]]
{{VoltarInicio}}

====Validação Kinghost====
O provedor Kinghost quando utilizado em ambiente nuvem como: FWC ou Nuvem CIGAM, necessitam que seja realizada a parametrização do SMTPI no provedor, assim como o ajuste do SMTP no CIGAM. 
 
[https://king.host/wiki/artigo/como-ativar-o-smtp-internacional/ Como ativar SMTPI Kinghost]

== Como configurar para utilização de envio através da opção Gmail API? ==
Gmail API - (Para usuários do Gmail, a API do Gmail é a melhor opção para acesso autorizado aos dados do Gmail de um usuário. Isso não armazena nenhum dos e-mails no banco de dados de terceiros, proporcionando mais segurança e privacidade aos seus e-mails. A API do Gmail é usada para interagir com as caixas de entrada e configurações do Gmail dos usuários e oferece suporte a várias linguagens de programação populares). 
 
O envio de email via CIGAM através do Gmail API devem ser autorizadas via credenciais do OAuth 2.0. 
Essa funcionalidade exige a utilização de um token de autorização de acesso ao qual deve ser criado através da console de APIs Google - '''[[https://support.google.com/googleapi/answer/6158849/?hl=en&authuser=1| Configurando o OAuth 2.0]]'''.

*As configurações do sistema CIGAM envolvidas são: 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''Gmail API'''
* [[GE - AM - 692 - Servidor de e-mail]]
** smtp.gmail.com:587 
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]
**Pressione F5 e na tela de Cadastro de credenciais, informe o conteúdo do arquivo feito download anteriormente ou clique em ‘Importar’ conforme a configuração feita para obter o token de autorização via console de APIs Google e confirme.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada para o funcionamento do envio via Gmail API
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via Gmail API

* '''Importante:''' Caso não haja informação nas configurações necessárias para validar credenciais, ao enviar o e-mail será aberta uma tela para colocar as informações necessárias.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção OAuth? ==
A partir da <ref group="Versão 241007">Liberado a partir da OS 373456/716.</ref>, a configuração [[GE - AM - 338 - Opção para envio de e-mail]] agora inclui a possibilidade de enviar e-mails utilizando o protocolo OAuth.
:'''OAuth''' refere-se ao processo de envio de e-mails em que a autenticação é feita utilizando o protocolo OAuth (Open Authorization). 
<blockquote>
OAuth é um padrão de autorização que permite que aplicativos acessem recursos, como contas de e-mail, em nome de um usuário, sem precisar saber a senha do usuário. Em vez disso, OAuth utiliza tokens de acesso temporários que autorizam a aplicação a realizar operações, como o envio de e-mails, de forma segura e controlada. 
 
Quando um aplicativo envia e-mails usando OAuth, ele primeiro solicita a autorização do usuário para acessar sua conta de e-mail. Uma vez autorizado, o aplicativo recebe um token de acesso, que pode ser usado para autenticar futuras requisições, como o envio de e-mails. Este método é amplamente adotado por provedores de e-mail como Google (Gmail), Microsoft (Outlook), e outros, por oferecer maior segurança, pois reduz o risco de comprometimento de senhas e permite que os usuários revoguem o acesso a qualquer momento.
</blockquote>

===Envio de e-mail via Office 365===
:O envio de e-mails pelo CIGAM via 'Office 365' deve ser autenticado usando as credenciais do OAuth 2.0. Essa funcionalidade requer a criação e utilização de um token de autorização, que deve ser gerado através da console de administração do Office 365 - [[Como configurar autenticação Office 365 OAuth 2.0]]. Este token garante acesso seguro e permite que o CIGAM envie e-mails em nome do usuário sem a necessidade de expor senhas, aumentando a segurança no processo de comunicação.

'''As configurações do sistema CIGAM envolvidas são:''' 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção: '''OAuth'''

* [[GE - AM - 3233 - OAuth para envio de e-mail]]
** Opção: Informar o Id do cadastro da parametrização desejada
::::Cadastro de parâmetros OAuth
:::::001.1 - Office 365 OAuth 2.0

* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.

* [[GE - AM - 3074 - E-mail do sistema]]

* [[GE - AM - 3075 - Senha do e-mail do sistema]]

* [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]

* [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

:'''Importante:''' A autenticação será realizada sempre com base no remetente do e-mail, que pode variar conforme a rotina utilizada.

===Envio de e-mail com OAuth utilizando o SendGrid===
:O '''SendGrid''' é uma plataforma de envio de e-mails, desenvolvida por terceiros, que atua como intermediário entre uma aplicação e os servidores de e-mail dos destinatários. Essa plataforma oferece recursos como autenticação, monitoramento e alta entregabilidade, e pode ser integrada a aplicações utilizando autenticação via protocolo OAuth para acessar suas APIs.

Antes de iniciar as parametrizações, é necessário realizar o download dos arquivos conforme link abaixo e colocá-los no local da instalação do CIGAM, dentro da pasta 'Cab\Exclusivo'. Exemplo: %CIGAM_INSTAL%\Cab\Exclusivo\EnvioEmailCustomizado\. 
Clique para baixar o pacote de arquivos para a versão CIGAM11 [https://www.cigam.com.br/wiki/images/a/a2/EnvioEmailCustomizado.zip EnvioEmailCustomizado.zip]. 
Clique para baixar o pacote de arquivos para a versão CIGAM e10 [https://www.cigam.com.br/wiki/images/2/20/EnvioEmailCustomizadoUniPaaS.zip EnvioEmailCustomizadoUniPaaS.zip]. 
'''Observação:''' para ambientes com a versão CIGAM e10, após realizar o download do arquivo compactado, certifique-se de deixar a pasta com o nome '''EnvioEmailCustomizado'''.

:'''As parametrizações do sistema CIGAM envolvidas são:''' 
: Cadastros e configurações.
: O [[GE Usuário - Grupos e Direitos|cadastro do usuário]] deve estar com o endereço de e-mail devidamente preenchido. Este será utilizado como remetente dos e-mails enviados.
: A configuração '[[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]', permite variar o e-mail do remetente conforme a Unidade de Negócio ativa. Quando informada, terá prioridade sobre o e-mail no cadastrado do usuário. 
:No arquivo MAGIC.INI ou no seu arquivo de adendo, se for o caso, devem ser adicionados na sessão [MAGIC_LOGICAL_NAMES] os nomes lógicos listados abaixo.
:EX_CK02176TSI = S
:EX_CK02176TSICabPrg = EE00003
:EX_CK02176TSICab = *%CIGAM_INSTAL%Cab\Exclusivo\EnvioEmailCustomizado\Cab\EnvioEmailCustomizado.ecf
:EX_SENDGRID_APIKEY =
:EX_EMAIL_CUSTOMIZADO = S

IMPORTANTE: na tradução do nome lógico EX_SENDGRID_APIKEY deve ser informada a chave conforme a parametrização do SendGrid realizada pelo cliente. Veja [[GE - Como Fazer - Como integrar o SendGrid|como integrar o SendGrid]].

{{VoltarInicio}}

== Como utilizar ferramentas que necessitam de senhas com mais de 30 caracteres? ==
A utilização de um servidor de relay de e-mail (SMTP Relay) para envio de e-mails é uma solução eficaz em cenários nos quais é necessário lidar com serviços que requerem senhas longas, como o SendGrid ou Amazon Web Services (AWS). Isso pode ser especialmente útil quando se lida com autenticações complexas ou senhas/tokens longos para serviços de e-mail ou outros serviços que utilizam e-mail para comunicação. 
#'''Autenticação pelo SMTP Relay:''' Ao configurar um servidor de relay de e-mail, o servidor assume a responsabilidade de autenticar-se com o serviço de e-mail (por exemplo, SendGrid ou AWS) em nome do sistema que está enviando os e-mails (neste caso, o CIGAM). Isso significa que o CIGAM não precisa lidar diretamente com senhas/tokens longos, tornando a autenticação mais segura e gerenciável.
#'''Implementação:''' A implementação de um servidor de relay de e-mail é responsabilidade do departamento de TI do cliente ou de uma empresa de TI terceirizada, se for esse o caso. A configuração envolve definir as credenciais de autenticação para o serviço de relay, configurar as regras de envio de e-mail e direcionar o CIGAM para usar o servidor de relay.
#'''Considerações de Segurança:''' Certifique-se de que o servidor de relay de e-mail seja adequadamente seguro e mantenha as boas práticas de segurança para proteger as credenciais armazenadas. Além disso, considere a implementação de autenticação em dois fatores (2FA) para aumentar a segurança.

= Envio de e-mail usuários externos =
<ref group="Versão 220404.c"> Liberado a partir da OS 373456/391. </ref> Os e-mails a serem enviados via portais respeitam as mesmas configurações aplicadas diretamente no desktop, os usuários sempre devem possuir um cadastro no CIGAM e seu e-mail no cadastro de usuários. 
* Para que seja possível o envio de e-mail para usuários externos deve ter as seguintes parametrizações: 
** Ter configurado no sistema o envio de e-mail conforme orientações acima
** Informação na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] se optar por não informar a senha de e-mail a cada acesso ao portal.
Sendo assim onde existir a implementação da funcionalidade, caso a configuração: [[GE - AM - 904 - Senha para login no servidor de e-mail]] não conste informada para o usuário será exibida uma tela para que seja possível indicar a senha para login no servidor de e-mail e consequentemente fazer o envio. Essas informações serão aplicadas até o próximo acesso sem necessidade de informar novamente.
{{VoltarInicio}}

=Manuais Referenciados=
*[[Configurações e parametrizações para envio de e-mail através do Cigam]]

= Versão 220404 =
=== Patch "c" ===
<references group="Versão 220404.c"/>
= Versão 221107 =
=== Patch "c" ===
<references group="Versão 221107.c"/>
= Versão 241007 =
<references group="Versão 241007"/>

GE - Como Fazer - Configuração de Envio de E-mail no CIGAM

2025-02-14T12:26:11Z

Alessandro.voto: /* Envio de e-mail com OAuth utilizando o SendGrid */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM|Configuração de Envio de E-mail no CIGAM]]



= Configuração de envio e email pelo Sistema CIGAM =
O uso de envio de e-mail pelo Sistema Cigam requer informações fornecidas pelo cliente, parametrizações de máquina e configurações de sistema para o correto funcionamento. 

== Quais são as informações de Envio de E-mail para parametrização?==
As informações são geralmente repassadas pelo próprio cliente ou sua T.I. As informações são: 
⦁ Qual é o servidor de e-mail e respectiva porta? 
⦁ Qual é a conta de e-mail do usuário? 
⦁ Qual é a senha de e-mail do usuário? 
⦁ É utilizado algum método de segurança, como SSL (Secure Sockets Layer)? 

== Quais as parametrizações de Envio de E-mail de máquina? ==
O Framework .Net precisa estar devidamente instalado e com suas permissões. Para saber como parametrizar o .Net verificar o documento “[[GE - Como Fazer - Instalação do .Net|Como Fazer - Instalação do .Net]]”. 
{{VoltarInicio}}

== Quais são as configurações para parametrizar o envio de e-mail pelo CIGAM? ==
*As configurações do sistema CIGAM envolvidas são: 
** [[GE - AM - 338 - Opção para envio de e-mail]] 
** [[GE - AM - 545 - Auto-assinatura a ser anexada no envio de e-mail]]
** [[GE - AM - 692 - Servidor de e-mail]]
** [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** [[GE - AM - 1495 - Solicitar confirmação de leitura para e-mails enviados]]
** [[GE - AM - 2077 - Não enviar cópia para o remetente do e-mail]]
** [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]
** [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

== Qual é o cadastro a ser feito? ==
Para o envio de e-mail, é necessário existir um cadastro do usuário sendo opcional a informação do e-mail vinculado a ele. 
<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref> Caso conste informado e-mail no cadastro, esse será considerado somente se a configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] não constar informada. 
Para ser possível o envio de e-mail é necessário que uma das opções conste com o usuário para o login do servidor de e-mail. Seja ele a configuração ou o cadastro de usuário, quando informado nas duas opções acima mencionadas, será respeitado sempre o que estiver informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]]. 
 
O cadastro de usuário e seu e-mail (opcional) é feito através do programa Usuários - Grupos e Direitos
*Utilidades / Diversos
**Parâmetros
***Usuários
****Usuário - Grupos Direitos 

É possível além do e-mail (opcional), informar a Unidade de Negócio (opcional) caso queira reforçar a unidade que pertence o usuário. 
 
Após realizado o cadastro ou eventual modificação, o ajuste só será validado na próxima sessão para isso preciso sair do sistema e entrar novamente para carregar as parametrizações ou então acessar a área onde consta o perfil do usuário e clicar na opção Carregar Parâmetros.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção SmtpClient? ==
SMTP - (Protocolo de Transferência de Correio Simples é o protocolo padrão de envio de mensagens de correio eletrônico através da Internet entre dois dispositivos computacionais). 
Para que seja possível o envio de email via SmtpClient é necessário ter as seguintes configurações parametrizadas:
* E-mail informado no cadastro do usuário 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''SmtpClient'''
* [[GE - AM - 692 - Servidor de e-mail]]
** Indicado o servidor de e-mail seguido por ‘:’ e a porta liberada para envio de e-mail. 
**Se não informado o número da porta o sistema irá realizar o envio de e-mail pela porta padrão: 25 correspondente aos e-mails que serão utilizados para o envio. 
**Para obter as informações servidor e porta para envio de e-mail acesse uma ferramenta de envio de e-mail que esteja configurada (Ex.: Outlook) e busque pelas informações nas propriedades da conta. 
* [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** Opcional deixar a senha já informada para envio direto do e-mail, caso não seja informada pedirá a senha na hora do envio.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada quando o servidor de envio de e-mail utilizado exigir o usuário + o domínio completo para a autenticação (Ex: conta@dominio.com.br). Quando essa configuração estiver desmarcada só será considerado o informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] ou no cadastro de usuário até o caractere @.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP

* '''IMPORTANTE:''' A partir de 30 de maio de 2022, alguns servidores não autorizaram mais o uso de apps ou dispositivos de terceiros que exigem apenas nome de usuário e senha para fazer login na conta, sendo assim indicamos a aplicação da verificação em duas etapas nas contas a serem utilizadas e a utilização de senhas de app, sendo obrigatória para acesso do email no CIGAM a utilização da senha de app. 
* Ao aplicar a senha de APP no CIGAM não será exigido autenticação em duas etapas devido a composição da senha fornecida pelo provedor basta informar ela na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou individualmente a cada envio que esse ocorrerá normalmente. 
** Para configuração de senhas de app consulte a documentação do seu servidor de e-mail, procurando por '''senhas de APP''' ou '''gerenciamento de senhas de APP''', ou siga as informações abaixo.

{{VoltarInicio}}

=== Como criar uma senha de aplicativo ===
====Senha de aplicativo Gmail====
Ao seguir esses passos, você poderá configurar corretamente uma senha de aplicativo no Gmail para ser utilizada com o CIGAM, garantindo que o envio de e-mails via SMTP funcione adequadamente sem a necessidade de usar sua senha principal da conta do Google. 
 
Para configurar uma senha de aplicativo no Gmail, especialmente quando você está utilizando o servidor de envio SMTP e a opção está informada como SmtpClient na configuração [[GE - AM - 338 - Opção para envio de e-mail]], acesse [https://support.google.com/accounts/answer/185833?hl=pt-BR Criar e usar senhas de app] e siga os passos. 
 
Ao acessar, deverá ser informado para qual tipo de app será utilizado, neste caso será "E-mail" e posteriormente será informado para qual tipo de dispositivo.
 
[[Image: envioemailCigam5.png|550px|centro]]
 
Ao clicar em gerar, será gerada uma senha para o dispositivo. Acesse o menu [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Configurações|Configurações]] para informar na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] a senha gerada.
 
[[Image: envioemailCigam6.png|550px|centro]]

====Senha de aplicativo Outlook====
Servidor de envios Office365, será necessário habilitar a Senha de Aplicativo: 
[https://account.live.com/proofs/manage/additional?mkt=pt-BR&refd=account.microsoft.com&refp=security Acesso direto conta Pessoal] 
[https://mysignins.microsoft.com/security-info Acesso diretor conta Profissional - Administrado por Exchange]
 
[[Image: envioemailCigam12.png|750px|centro]]
 
Inserir uma validação com: E-mail ou Telefone:
 
[[Image: envioemailCigam13.png|300px|centro]]
 
Ativar a verificação em duas etapas:
 
[[Image: envioemailCigam14.png|750px|centro]]
 
Após ativar, irá aparecer a opção Senha de Aplicativo, sendo necessária a criação e inserção na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]].
 
[[Image: envioemailCigam15.png|750px|centro]]
 
Caso a Senha de Aplicativo não esteja habilitada, será necessário ativar a Autenticação Multifator(MFA) dentro do [https://admin.exchange.microsoft.com Exchange do Office365].
 
[[Image: envioemailCigam9.png|750px|centro]]
 
Deve-se verificar se a autenticação SMTP está ativa. Somente o Administrador poderá verificar.
 
[[Image: envioemailCigam7.png|350px|centro]]
{{VoltarInicio}}

====Validação Kinghost====
O provedor Kinghost quando utilizado em ambiente nuvem como: FWC ou Nuvem CIGAM, necessitam que seja realizada a parametrização do SMTPI no provedor, assim como o ajuste do SMTP no CIGAM. 
 
[https://king.host/wiki/artigo/como-ativar-o-smtp-internacional/ Como ativar SMTPI Kinghost]

== Como configurar para utilização de envio através da opção Gmail API? ==
Gmail API - (Para usuários do Gmail, a API do Gmail é a melhor opção para acesso autorizado aos dados do Gmail de um usuário. Isso não armazena nenhum dos e-mails no banco de dados de terceiros, proporcionando mais segurança e privacidade aos seus e-mails. A API do Gmail é usada para interagir com as caixas de entrada e configurações do Gmail dos usuários e oferece suporte a várias linguagens de programação populares). 
 
O envio de email via CIGAM através do Gmail API devem ser autorizadas via credenciais do OAuth 2.0. 
Essa funcionalidade exige a utilização de um token de autorização de acesso ao qual deve ser criado através da console de APIs Google - '''[[https://support.google.com/googleapi/answer/6158849/?hl=en&authuser=1| Configurando o OAuth 2.0]]'''.

*As configurações do sistema CIGAM envolvidas são: 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''Gmail API'''
* [[GE - AM - 692 - Servidor de e-mail]]
** smtp.gmail.com:587 
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]
**Pressione F5 e na tela de Cadastro de credenciais, informe o conteúdo do arquivo feito download anteriormente ou clique em ‘Importar’ conforme a configuração feita para obter o token de autorização via console de APIs Google e confirme.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada para o funcionamento do envio via Gmail API
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via Gmail API

* '''Importante:''' Caso não haja informação nas configurações necessárias para validar credenciais, ao enviar o e-mail será aberta uma tela para colocar as informações necessárias.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção OAuth? ==
A partir da <ref group="Versão 241007">Liberado a partir da OS 373456/716.</ref>, a configuração [[GE - AM - 338 - Opção para envio de e-mail]] agora inclui a possibilidade de enviar e-mails utilizando o protocolo OAuth.
:'''OAuth''' refere-se ao processo de envio de e-mails em que a autenticação é feita utilizando o protocolo OAuth (Open Authorization). 
<blockquote>
OAuth é um padrão de autorização que permite que aplicativos acessem recursos, como contas de e-mail, em nome de um usuário, sem precisar saber a senha do usuário. Em vez disso, OAuth utiliza tokens de acesso temporários que autorizam a aplicação a realizar operações, como o envio de e-mails, de forma segura e controlada. 
 
Quando um aplicativo envia e-mails usando OAuth, ele primeiro solicita a autorização do usuário para acessar sua conta de e-mail. Uma vez autorizado, o aplicativo recebe um token de acesso, que pode ser usado para autenticar futuras requisições, como o envio de e-mails. Este método é amplamente adotado por provedores de e-mail como Google (Gmail), Microsoft (Outlook), e outros, por oferecer maior segurança, pois reduz o risco de comprometimento de senhas e permite que os usuários revoguem o acesso a qualquer momento.
</blockquote>

===Envio de e-mail via Office 365===
:O envio de e-mails pelo CIGAM via 'Office 365' deve ser autenticado usando as credenciais do OAuth 2.0. Essa funcionalidade requer a criação e utilização de um token de autorização, que deve ser gerado através da console de administração do Office 365 - [[Como configurar autenticação Office 365 OAuth 2.0]]. Este token garante acesso seguro e permite que o CIGAM envie e-mails em nome do usuário sem a necessidade de expor senhas, aumentando a segurança no processo de comunicação.

'''As configurações do sistema CIGAM envolvidas são:''' 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção: '''OAuth'''

* [[GE - AM - 3233 - OAuth para envio de e-mail]]
** Opção: Informar o Id do cadastro da parametrização desejada
::::Cadastro de parâmetros OAuth
:::::001.1 - Office 365 OAuth 2.0

* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.

* [[GE - AM - 3074 - E-mail do sistema]]

* [[GE - AM - 3075 - Senha do e-mail do sistema]]

* [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]

* [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

:'''Importante:''' A autenticação será realizada sempre com base no remetente do e-mail, que pode variar conforme a rotina utilizada.

===Envio de e-mail com OAuth utilizando o SendGrid===
:O '''SendGrid''' é uma plataforma de envio de e-mails, desenvolvida por terceiros, que atua como intermediário entre uma aplicação e os servidores de e-mail dos destinatários. Essa plataforma oferece recursos como autenticação, monitoramento e alta entregabilidade, e pode ser integrada a aplicações utilizando autenticação via protocolo OAuth para acessar suas APIs.

Antes de iniciar as parametrizações, é necessário realizar o download dos arquivos conforme link abaixo e colocá-los no local da instalação do CIGAM, dentro da pasta 'Cab\Exclusivo'. Exemplo: %CIGAM_INSTAL%\Cab\Exclusivo\EnvioEmailCustomizado\. 
Clique para baixar o pacote de arquivos para a versão CIGAM11 [https://www.cigam.com.br/wiki/images/a/a2/EnvioEmailCustomizado.zip EnvioEmailCustomizado.zip]. 
Clique para baixar o pacote de arquivos para a versão CIGAM e10 [https://www.cigam.com.br/wiki/images/2/20/EnvioEmailCustomizadoUniPaaS.zip EnvioEmailCustomizadoUniPaaS.zip].

:'''As parametrizações do sistema CIGAM envolvidas são:''' 
: Cadastros e configurações.
: O [[GE Usuário - Grupos e Direitos|cadastro do usuário]] deve estar com o endereço de e-mail devidamente preenchido. Este será utilizado como remetente dos e-mails enviados.
: A configuração '[[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]', permite variar o e-mail do remetente conforme a Unidade de Negócio ativa. Quando informada, terá prioridade sobre o e-mail no cadastrado do usuário. 
:No arquivo MAGIC.INI ou no seu arquivo de adendo, se for o caso, devem ser adicionados na sessão [MAGIC_LOGICAL_NAMES] os nomes lógicos listados abaixo.
:EX_CK02176TSI = S
:EX_CK02176TSICabPrg = EE00003
:EX_CK02176TSICab = *%CIGAM_INSTAL%Cab\Exclusivo\EnvioEmailCustomizado\Cab\EnvioEmailCustomizado.ecf
:EX_SENDGRID_APIKEY =
:EX_EMAIL_CUSTOMIZADO = S

IMPORTANTE: na tradução do nome lógico EX_SENDGRID_APIKEY deve ser informada a chave conforme a parametrização do SendGrid realizada pelo cliente. Veja [[GE - Como Fazer - Como integrar o SendGrid|como integrar o SendGrid]].

{{VoltarInicio}}

== Como utilizar ferramentas que necessitam de senhas com mais de 30 caracteres? ==
A utilização de um servidor de relay de e-mail (SMTP Relay) para envio de e-mails é uma solução eficaz em cenários nos quais é necessário lidar com serviços que requerem senhas longas, como o SendGrid ou Amazon Web Services (AWS). Isso pode ser especialmente útil quando se lida com autenticações complexas ou senhas/tokens longos para serviços de e-mail ou outros serviços que utilizam e-mail para comunicação. 
#'''Autenticação pelo SMTP Relay:''' Ao configurar um servidor de relay de e-mail, o servidor assume a responsabilidade de autenticar-se com o serviço de e-mail (por exemplo, SendGrid ou AWS) em nome do sistema que está enviando os e-mails (neste caso, o CIGAM). Isso significa que o CIGAM não precisa lidar diretamente com senhas/tokens longos, tornando a autenticação mais segura e gerenciável.
#'''Implementação:''' A implementação de um servidor de relay de e-mail é responsabilidade do departamento de TI do cliente ou de uma empresa de TI terceirizada, se for esse o caso. A configuração envolve definir as credenciais de autenticação para o serviço de relay, configurar as regras de envio de e-mail e direcionar o CIGAM para usar o servidor de relay.
#'''Considerações de Segurança:''' Certifique-se de que o servidor de relay de e-mail seja adequadamente seguro e mantenha as boas práticas de segurança para proteger as credenciais armazenadas. Além disso, considere a implementação de autenticação em dois fatores (2FA) para aumentar a segurança.

= Envio de e-mail usuários externos =
<ref group="Versão 220404.c"> Liberado a partir da OS 373456/391. </ref> Os e-mails a serem enviados via portais respeitam as mesmas configurações aplicadas diretamente no desktop, os usuários sempre devem possuir um cadastro no CIGAM e seu e-mail no cadastro de usuários. 
* Para que seja possível o envio de e-mail para usuários externos deve ter as seguintes parametrizações: 
** Ter configurado no sistema o envio de e-mail conforme orientações acima
** Informação na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] se optar por não informar a senha de e-mail a cada acesso ao portal.
Sendo assim onde existir a implementação da funcionalidade, caso a configuração: [[GE - AM - 904 - Senha para login no servidor de e-mail]] não conste informada para o usuário será exibida uma tela para que seja possível indicar a senha para login no servidor de e-mail e consequentemente fazer o envio. Essas informações serão aplicadas até o próximo acesso sem necessidade de informar novamente.
{{VoltarInicio}}

=Manuais Referenciados=
*[[Configurações e parametrizações para envio de e-mail através do Cigam]]

= Versão 220404 =
=== Patch "c" ===
<references group="Versão 220404.c"/>
= Versão 221107 =
=== Patch "c" ===
<references group="Versão 221107.c"/>
= Versão 241007 =
<references group="Versão 241007"/>

GE - Como Fazer - Como integrar o SendGrid

2025-02-14T12:19:47Z

Alessandro.voto: /* Como habilitar o uso do SendGrid para envio de e-mails? */

{{VoltarPagina}}
 
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Como integrar o SendGrid]]

==Observações importantes==
:* '''Limites do plano gratuito:''' permite enviar até 100 e-mails por dia.
:* '''Boas práticas:''' siga as políticas de uso do SendGrid para evitar bloqueios (por exemplo, não enviar spam).
:* '''Site oficial:''' consulte [https://sendgrid.com/en-us SendGrid] para mais detalhes.

==Como habilitar o uso do SendGrid para envio de e-mails?==
A integração do SendGrid com uma aplicação, como o CIGAM, envolve as seguintes etapas principais:

:'''1. Criar uma conta no SendGrid'''
::* Acesse o site do SendGrid .
::* Registre-se ou faça login na sua conta.
::* Após o login, acesse o painel de administração.

:'''2. Configurar uma API Key no SendGrid'''
:A API Key é utilizada para autenticar as requisições do seu sistema à plataforma SendGrid.
::* No painel do SendGrid, vá até '''Settings > API Keys'''.
::* Clique em '''Create API Key'''.
::* Dê um nome para a chave, selecione as permissões necessárias (geralmente '''Full Access''') e clique em '''Create & View'''.
::* Salve a chave gerada, pois ela será utilizada na configuração do sistema.

:'''3. Autenticação do remetente'''
::* No painel do SendGrid, vá até '''Settings > Sender Authentication'''.
::* Defina o tipo de identidade do remetente desejado'''.

:'''4. Configurar o sistema CIGAM'''
::*Vide: [[GE_-_Como_Fazer_-_Configura%C3%A7%C3%A3o_de_Envio_de_E-mail_no_CIGAM#Envio_de_e-mail_com_OAuth_utilizando_o_SendGrid|Envio de e-mail com OAuth utilizando o SendGrid]]

:'''5. Testar o envio de e-mails'''
:Após configurar o sistema:
::# Certifique-se de que o '''SendGrid API Key''' foi registrado corretamente.
::# Realize um teste de envio de e-mail diretamente do sistema configurado.
::# Verifique no painel do SendGrid, na aba '''Activity''', se os e-mails estão sendo enviados e entregues corretamente.

= Página referenciada=
* [[GE_-_Como_Fazer_-_Configura%C3%A7%C3%A3o_de_Envio_de_E-mail_no_CIGAM#Envio_de_e-mail_com_OAuth_utilizando_o_SendGrid|Envio de e-mail com OAuth utilizando o SendGrid]]

GE - Como Fazer - Como integrar o SendGrid

2025-02-14T11:53:45Z

Alessandro.voto: /* Observações importantes */

{{VoltarPagina}}
 
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Como integrar o SendGrid]]

==Observações importantes==
:* '''Limites do plano gratuito:''' permite enviar até 100 e-mails por dia.
:* '''Boas práticas:''' siga as políticas de uso do SendGrid para evitar bloqueios (por exemplo, não enviar spam).
:* '''Site oficial:''' consulte [https://sendgrid.com/en-us SendGrid] para mais detalhes.

==Como habilitar o uso do SendGrid para envio de e-mails?==
A integração do SendGrid com uma aplicação, como o CIGAM, envolve as seguintes etapas principais:

:'''1. Criar uma conta no SendGrid'''
::* Acesse o site do SendGrid .
::* Registre-se ou faça login na sua conta.
::* Após o login, acesse o painel de administração.

:'''2. Configurar uma API Key no SendGrid'''
:A API Key é utilizada para autenticar as requisições do seu sistema à plataforma SendGrid.
::* No painel do SendGrid, vá até '''Settings > API Keys'''.
::* Clique em '''Create API Key'''.
::* Dê um nome para a chave, selecione as permissões necessárias (geralmente '''Full Access''') e clique em '''Create & View'''.
::* Salve a chave gerada, pois ela será utilizada na configuração do sistema.

:'''3. Configurar o sistema CIGAM'''
::*Vide: [[GE_-_Como_Fazer_-_Configura%C3%A7%C3%A3o_de_Envio_de_E-mail_no_CIGAM#Envio_de_e-mail_com_OAuth_utilizando_o_SendGrid|Envio de e-mail com OAuth utilizando o SendGrid]]

:'''4. Testar o envio de e-mails'''
:Após configurar o sistema:
::# Certifique-se de que o '''SendGrid API Key''' foi registrado corretamente.
::# Realize um teste de envio de e-mail diretamente do sistema configurado.
::# Verifique no painel do SendGrid, na aba '''Activity''', se os e-mails estão sendo enviados e entregues corretamente.

= Página referenciada=
* [[GE_-_Como_Fazer_-_Configura%C3%A7%C3%A3o_de_Envio_de_E-mail_no_CIGAM#Envio_de_e-mail_com_OAuth_utilizando_o_SendGrid|Envio de e-mail com OAuth utilizando o SendGrid]]

GE - Como Fazer - Configuração de Envio de E-mail no CIGAM

2025-02-13T17:57:09Z

Alessandro.voto: /* Envio de e-mail com OAuth utilizando o SendGrid */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM|Configuração de Envio de E-mail no CIGAM]]



= Configuração de envio e email pelo Sistema CIGAM =
O uso de envio de e-mail pelo Sistema Cigam requer informações fornecidas pelo cliente, parametrizações de máquina e configurações de sistema para o correto funcionamento. 

== Quais são as informações de Envio de E-mail para parametrização?==
As informações são geralmente repassadas pelo próprio cliente ou sua T.I. As informações são: 
⦁ Qual é o servidor de e-mail e respectiva porta? 
⦁ Qual é a conta de e-mail do usuário? 
⦁ Qual é a senha de e-mail do usuário? 
⦁ É utilizado algum método de segurança, como SSL (Secure Sockets Layer)? 

== Quais as parametrizações de Envio de E-mail de máquina? ==
O Framework .Net precisa estar devidamente instalado e com suas permissões. Para saber como parametrizar o .Net verificar o documento “[[GE - Como Fazer - Instalação do .Net|Como Fazer - Instalação do .Net]]”. 
{{VoltarInicio}}

== Quais são as configurações para parametrizar o envio de e-mail pelo CIGAM? ==
*As configurações do sistema CIGAM envolvidas são: 
** [[GE - AM - 338 - Opção para envio de e-mail]] 
** [[GE - AM - 545 - Auto-assinatura a ser anexada no envio de e-mail]]
** [[GE - AM - 692 - Servidor de e-mail]]
** [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** [[GE - AM - 1495 - Solicitar confirmação de leitura para e-mails enviados]]
** [[GE - AM - 2077 - Não enviar cópia para o remetente do e-mail]]
** [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]
** [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

== Qual é o cadastro a ser feito? ==
Para o envio de e-mail, é necessário existir um cadastro do usuário sendo opcional a informação do e-mail vinculado a ele. 
<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref> Caso conste informado e-mail no cadastro, esse será considerado somente se a configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] não constar informada. 
Para ser possível o envio de e-mail é necessário que uma das opções conste com o usuário para o login do servidor de e-mail. Seja ele a configuração ou o cadastro de usuário, quando informado nas duas opções acima mencionadas, será respeitado sempre o que estiver informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]]. 
 
O cadastro de usuário e seu e-mail (opcional) é feito através do programa Usuários - Grupos e Direitos
*Utilidades / Diversos
**Parâmetros
***Usuários
****Usuário - Grupos Direitos 

É possível além do e-mail (opcional), informar a Unidade de Negócio (opcional) caso queira reforçar a unidade que pertence o usuário. 
 
Após realizado o cadastro ou eventual modificação, o ajuste só será validado na próxima sessão para isso preciso sair do sistema e entrar novamente para carregar as parametrizações ou então acessar a área onde consta o perfil do usuário e clicar na opção Carregar Parâmetros.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção SmtpClient? ==
SMTP - (Protocolo de Transferência de Correio Simples é o protocolo padrão de envio de mensagens de correio eletrônico através da Internet entre dois dispositivos computacionais). 
Para que seja possível o envio de email via SmtpClient é necessário ter as seguintes configurações parametrizadas:
* E-mail informado no cadastro do usuário 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''SmtpClient'''
* [[GE - AM - 692 - Servidor de e-mail]]
** Indicado o servidor de e-mail seguido por ‘:’ e a porta liberada para envio de e-mail. 
**Se não informado o número da porta o sistema irá realizar o envio de e-mail pela porta padrão: 25 correspondente aos e-mails que serão utilizados para o envio. 
**Para obter as informações servidor e porta para envio de e-mail acesse uma ferramenta de envio de e-mail que esteja configurada (Ex.: Outlook) e busque pelas informações nas propriedades da conta. 
* [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** Opcional deixar a senha já informada para envio direto do e-mail, caso não seja informada pedirá a senha na hora do envio.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada quando o servidor de envio de e-mail utilizado exigir o usuário + o domínio completo para a autenticação (Ex: conta@dominio.com.br). Quando essa configuração estiver desmarcada só será considerado o informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] ou no cadastro de usuário até o caractere @.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP

* '''IMPORTANTE:''' A partir de 30 de maio de 2022, alguns servidores não autorizaram mais o uso de apps ou dispositivos de terceiros que exigem apenas nome de usuário e senha para fazer login na conta, sendo assim indicamos a aplicação da verificação em duas etapas nas contas a serem utilizadas e a utilização de senhas de app, sendo obrigatória para acesso do email no CIGAM a utilização da senha de app. 
* Ao aplicar a senha de APP no CIGAM não será exigido autenticação em duas etapas devido a composição da senha fornecida pelo provedor basta informar ela na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou individualmente a cada envio que esse ocorrerá normalmente. 
** Para configuração de senhas de app consulte a documentação do seu servidor de e-mail, procurando por '''senhas de APP''' ou '''gerenciamento de senhas de APP''', ou siga as informações abaixo.

{{VoltarInicio}}

=== Como criar uma senha de aplicativo ===
====Senha de aplicativo Gmail====
Ao seguir esses passos, você poderá configurar corretamente uma senha de aplicativo no Gmail para ser utilizada com o CIGAM, garantindo que o envio de e-mails via SMTP funcione adequadamente sem a necessidade de usar sua senha principal da conta do Google. 
 
Para configurar uma senha de aplicativo no Gmail, especialmente quando você está utilizando o servidor de envio SMTP e a opção está informada como SmtpClient na configuração [[GE - AM - 338 - Opção para envio de e-mail]], acesse [https://support.google.com/accounts/answer/185833?hl=pt-BR Criar e usar senhas de app] e siga os passos. 
 
Ao acessar, deverá ser informado para qual tipo de app será utilizado, neste caso será "E-mail" e posteriormente será informado para qual tipo de dispositivo.
 
[[Image: envioemailCigam5.png|550px|centro]]
 
Ao clicar em gerar, será gerada uma senha para o dispositivo. Acesse o menu [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Configurações|Configurações]] para informar na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] a senha gerada.
 
[[Image: envioemailCigam6.png|550px|centro]]

====Senha de aplicativo Outlook====
Servidor de envios Office365, será necessário habilitar a Senha de Aplicativo: 
[https://account.live.com/proofs/manage/additional?mkt=pt-BR&refd=account.microsoft.com&refp=security Acesso direto conta Pessoal] 
[https://mysignins.microsoft.com/security-info Acesso diretor conta Profissional - Administrado por Exchange]
 
[[Image: envioemailCigam12.png|750px|centro]]
 
Inserir uma validação com: E-mail ou Telefone:
 
[[Image: envioemailCigam13.png|300px|centro]]
 
Ativar a verificação em duas etapas:
 
[[Image: envioemailCigam14.png|750px|centro]]
 
Após ativar, irá aparecer a opção Senha de Aplicativo, sendo necessária a criação e inserção na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]].
 
[[Image: envioemailCigam15.png|750px|centro]]
 
Caso a Senha de Aplicativo não esteja habilitada, será necessário ativar a Autenticação Multifator(MFA) dentro do [https://admin.exchange.microsoft.com Exchange do Office365].
 
[[Image: envioemailCigam9.png|750px|centro]]
 
Deve-se verificar se a autenticação SMTP está ativa. Somente o Administrador poderá verificar.
 
[[Image: envioemailCigam7.png|350px|centro]]
{{VoltarInicio}}

====Validação Kinghost====
O provedor Kinghost quando utilizado em ambiente nuvem como: FWC ou Nuvem CIGAM, necessitam que seja realizada a parametrização do SMTPI no provedor, assim como o ajuste do SMTP no CIGAM. 
 
[https://king.host/wiki/artigo/como-ativar-o-smtp-internacional/ Como ativar SMTPI Kinghost]

== Como configurar para utilização de envio através da opção Gmail API? ==
Gmail API - (Para usuários do Gmail, a API do Gmail é a melhor opção para acesso autorizado aos dados do Gmail de um usuário. Isso não armazena nenhum dos e-mails no banco de dados de terceiros, proporcionando mais segurança e privacidade aos seus e-mails. A API do Gmail é usada para interagir com as caixas de entrada e configurações do Gmail dos usuários e oferece suporte a várias linguagens de programação populares). 
 
O envio de email via CIGAM através do Gmail API devem ser autorizadas via credenciais do OAuth 2.0. 
Essa funcionalidade exige a utilização de um token de autorização de acesso ao qual deve ser criado através da console de APIs Google - '''[[https://support.google.com/googleapi/answer/6158849/?hl=en&authuser=1| Configurando o OAuth 2.0]]'''.

*As configurações do sistema CIGAM envolvidas são: 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''Gmail API'''
* [[GE - AM - 692 - Servidor de e-mail]]
** smtp.gmail.com:587 
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]
**Pressione F5 e na tela de Cadastro de credenciais, informe o conteúdo do arquivo feito download anteriormente ou clique em ‘Importar’ conforme a configuração feita para obter o token de autorização via console de APIs Google e confirme.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada para o funcionamento do envio via Gmail API
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via Gmail API

* '''Importante:''' Caso não haja informação nas configurações necessárias para validar credenciais, ao enviar o e-mail será aberta uma tela para colocar as informações necessárias.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção OAuth? ==
A partir da <ref group="Versão 241007">Liberado a partir da OS 373456/716.</ref>, a configuração [[GE - AM - 338 - Opção para envio de e-mail]] agora inclui a possibilidade de enviar e-mails utilizando o protocolo OAuth.
:'''OAuth''' refere-se ao processo de envio de e-mails em que a autenticação é feita utilizando o protocolo OAuth (Open Authorization). 
<blockquote>
OAuth é um padrão de autorização que permite que aplicativos acessem recursos, como contas de e-mail, em nome de um usuário, sem precisar saber a senha do usuário. Em vez disso, OAuth utiliza tokens de acesso temporários que autorizam a aplicação a realizar operações, como o envio de e-mails, de forma segura e controlada. 
 
Quando um aplicativo envia e-mails usando OAuth, ele primeiro solicita a autorização do usuário para acessar sua conta de e-mail. Uma vez autorizado, o aplicativo recebe um token de acesso, que pode ser usado para autenticar futuras requisições, como o envio de e-mails. Este método é amplamente adotado por provedores de e-mail como Google (Gmail), Microsoft (Outlook), e outros, por oferecer maior segurança, pois reduz o risco de comprometimento de senhas e permite que os usuários revoguem o acesso a qualquer momento.
</blockquote>

===Envio de e-mail via Office 365===
:O envio de e-mails pelo CIGAM via 'Office 365' deve ser autenticado usando as credenciais do OAuth 2.0. Essa funcionalidade requer a criação e utilização de um token de autorização, que deve ser gerado através da console de administração do Office 365 - [[Como configurar autenticação Office 365 OAuth 2.0]]. Este token garante acesso seguro e permite que o CIGAM envie e-mails em nome do usuário sem a necessidade de expor senhas, aumentando a segurança no processo de comunicação.

'''As configurações do sistema CIGAM envolvidas são:''' 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção: '''OAuth'''

* [[GE - AM - 3233 - OAuth para envio de e-mail]]
** Opção: Informar o Id do cadastro da parametrização desejada
::::Cadastro de parâmetros OAuth
:::::001.1 - Office 365 OAuth 2.0

* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.

* [[GE - AM - 3074 - E-mail do sistema]]

* [[GE - AM - 3075 - Senha do e-mail do sistema]]

* [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]

* [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

:'''Importante:''' A autenticação será realizada sempre com base no remetente do e-mail, que pode variar conforme a rotina utilizada.

===Envio de e-mail com OAuth utilizando o SendGrid===
:O '''SendGrid''' é uma plataforma de envio de e-mails, desenvolvida por terceiros, que atua como intermediário entre uma aplicação e os servidores de e-mail dos destinatários. Essa plataforma oferece recursos como autenticação, monitoramento e alta entregabilidade, e pode ser integrada a aplicações utilizando autenticação via protocolo OAuth para acessar suas APIs.

Antes de iniciar as parametrizações, é necessário realizar o download dos arquivos conforme link abaixo e colocá-los no local da instalação do CIGAM, dentro da pasta 'Cab\Exclusivo'. Exemplo: %CIGAM_INSTAL%\Cab\Exclusivo\EnvioEmailCustomizado\. 
Clique para baixar o pacote de arquivos para a versão CIGAM11 [https://www.cigam.com.br/wiki/images/a/a2/EnvioEmailCustomizado.zip EnvioEmailCustomizado.zip]. 
Clique para baixar o pacote de arquivos para a versão CIGAM e10 [https://www.cigam.com.br/wiki/images/a/a2/EnvioEmailCustomizado.zip EnvioEmailCustomizadoUniPaaS.zip].

:'''As parametrizações do sistema CIGAM envolvidas são:''' 
: Cadastros e configurações.
: O cadastro do usuário deve estar com o endereço de e-mail devidamente preenchido. Este será utilizado como remetente dos e-mails enviados.
: A configuração 'GE - AM - 2169 - E-mail do remetente variando por unidade de negócio', permite variar o e-mail do remetente conforme a Unidade de Negócio ativa. Quando informada, terá prioridade sobre o e-mail no cadastrado do usuário. 
:No arquivo MAGIC.INI ou no seu arquivo de adendo, se for o caso, devem ser adicionados na sessão [MAGIC_LOGICAL_NAMES] os nomes lógicos listados abaixo.
:EX_CK02176TSI = S
:EX_CK02176TSICabPrg = EE00003
:EX_CK02176TSICab = *%CIGAM_INSTAL%Cab\Exclusivo\EnvioEmailCustomizado\Cab\EnvioEmailCustomizado.ecf
:EX_SENDGRID_APIKEY =
:EX_EMAIL_CUSTOMIZADO = S

IMPORTANTE: na tradução do nome lógico EX_SENDGRID_APIKEY deve ser informada a chave conforme a parametrização do SendGrid realizada pelo cliente. Veja [[GE - Como Fazer - Como integrar o SendGrid|como integrar o SendGrid]].

{{VoltarInicio}}

== Como utilizar ferramentas que necessitam de senhas com mais de 30 caracteres? ==
A utilização de um servidor de relay de e-mail (SMTP Relay) para envio de e-mails é uma solução eficaz em cenários nos quais é necessário lidar com serviços que requerem senhas longas, como o SendGrid ou Amazon Web Services (AWS). Isso pode ser especialmente útil quando se lida com autenticações complexas ou senhas/tokens longos para serviços de e-mail ou outros serviços que utilizam e-mail para comunicação. 
#'''Autenticação pelo SMTP Relay:''' Ao configurar um servidor de relay de e-mail, o servidor assume a responsabilidade de autenticar-se com o serviço de e-mail (por exemplo, SendGrid ou AWS) em nome do sistema que está enviando os e-mails (neste caso, o CIGAM). Isso significa que o CIGAM não precisa lidar diretamente com senhas/tokens longos, tornando a autenticação mais segura e gerenciável.
#'''Implementação:''' A implementação de um servidor de relay de e-mail é responsabilidade do departamento de TI do cliente ou de uma empresa de TI terceirizada, se for esse o caso. A configuração envolve definir as credenciais de autenticação para o serviço de relay, configurar as regras de envio de e-mail e direcionar o CIGAM para usar o servidor de relay.
#'''Considerações de Segurança:''' Certifique-se de que o servidor de relay de e-mail seja adequadamente seguro e mantenha as boas práticas de segurança para proteger as credenciais armazenadas. Além disso, considere a implementação de autenticação em dois fatores (2FA) para aumentar a segurança.

= Envio de e-mail usuários externos =
<ref group="Versão 220404.c"> Liberado a partir da OS 373456/391. </ref> Os e-mails a serem enviados via portais respeitam as mesmas configurações aplicadas diretamente no desktop, os usuários sempre devem possuir um cadastro no CIGAM e seu e-mail no cadastro de usuários. 
* Para que seja possível o envio de e-mail para usuários externos deve ter as seguintes parametrizações: 
** Ter configurado no sistema o envio de e-mail conforme orientações acima
** Informação na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] se optar por não informar a senha de e-mail a cada acesso ao portal.
Sendo assim onde existir a implementação da funcionalidade, caso a configuração: [[GE - AM - 904 - Senha para login no servidor de e-mail]] não conste informada para o usuário será exibida uma tela para que seja possível indicar a senha para login no servidor de e-mail e consequentemente fazer o envio. Essas informações serão aplicadas até o próximo acesso sem necessidade de informar novamente.
{{VoltarInicio}}

=Manuais Referenciados=
*[[Configurações e parametrizações para envio de e-mail através do Cigam]]

= Versão 220404 =
=== Patch "c" ===
<references group="Versão 220404.c"/>
= Versão 221107 =
=== Patch "c" ===
<references group="Versão 221107.c"/>
= Versão 241007 =
<references group="Versão 241007"/>

GE - Como Fazer - Como integrar o SendGrid

2025-02-12T17:05:49Z

Alessandro.voto: /* Como integrar o SendGrid para envio de e-mails? */

{{VoltarPagina}}
 
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Como integrar o SendGrid]]

==Observações importantes==
:* '''Limites do plano gratuito:''' permite enviar até 100 e-mails por dia.
:* '''Boas práticas:''' siga as políticas de uso do SendGrid para evitar bloqueios (por exemplo, não enviar spam).
:* '''Site oficial:''' consulte a [https://www.twilio.com/docs/sendgrid documentação do SendGrid] para mais detalhes e exemplos de integração.

==Como habilitar o uso do SendGrid para envio de e-mails?==
A integração do SendGrid com uma aplicação, como o CIGAM, envolve as seguintes etapas principais:

:'''1. Criar uma conta no SendGrid'''
::* Acesse o site do SendGrid .
::* Registre-se ou faça login na sua conta.
::* Após o login, acesse o painel de administração.

:'''2. Configurar uma API Key no SendGrid'''
:A API Key é utilizada para autenticar as requisições do seu sistema à plataforma SendGrid.
::* No painel do SendGrid, vá até '''Settings > API Keys'''.
::* Clique em '''Create API Key'''.
::* Dê um nome para a chave, selecione as permissões necessárias (geralmente '''Full Access''') e clique em '''Create & View'''.
::* Salve a chave gerada, pois ela será utilizada na configuração do sistema.

:'''3. Configurar o sistema CIGAM'''
::*Vide: [[GE_-_Como_Fazer_-_Configura%C3%A7%C3%A3o_de_Envio_de_E-mail_no_CIGAM#Envio_de_e-mail_com_OAuth_utilizando_o_SendGrid|Envio de e-mail com OAuth utilizando o SendGrid]]

:'''4. Testar o envio de e-mails'''
:Após configurar o sistema:
::# Certifique-se de que o '''SendGrid API Key''' foi registrado corretamente.
::# Realize um teste de envio de e-mail diretamente do sistema configurado.
::# Verifique no painel do SendGrid, na aba '''Activity''', se os e-mails estão sendo enviados e entregues corretamente.

= Página referenciada=
* [[GE_-_Como_Fazer_-_Configura%C3%A7%C3%A3o_de_Envio_de_E-mail_no_CIGAM#Envio_de_e-mail_com_OAuth_utilizando_o_SendGrid|Envio de e-mail com OAuth utilizando o SendGrid]]

GE - Como Fazer - Como integrar o SendGrid

2025-02-12T16:58:54Z

Alessandro.voto: /* Observações importantes */

{{VoltarPagina}}
 
[[categoria:Como_Fazer_Utilidades/Diversos]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Como integrar o SendGrid]]

==Observações importantes==
:* '''Limites do plano gratuito:''' permite enviar até 100 e-mails por dia.
:* '''Boas práticas:''' siga as políticas de uso do SendGrid para evitar bloqueios (por exemplo, não enviar spam).
:* '''Site oficial:''' consulte a [https://www.twilio.com/docs/sendgrid documentação do SendGrid] para mais detalhes e exemplos de integração.

==Como integrar o SendGrid para envio de e-mails?==
A integração do SendGrid com uma aplicação, como o CIGAM, envolve as seguintes etapas principais:

:'''1. Criar uma conta no SendGrid'''
::* Acesse o site do SendGrid.
::* Registre-se ou faça login na sua conta.
::* Após o login, acesse o painel de administração.

:'''2. Configurar uma API Key no SendGrid'''
:A API Key é utilizada para autenticar as requisições do seu sistema à plataforma SendGrid.
::* No painel do SendGrid, vá até '''Settings > API Keys'''.
::* Clique em '''Create API Key'''.
::* Dê um nome para a chave, selecione as permissões necessárias (geralmente '''Full Access''') e clique em '''Create & View'''.
::* Salve a chave gerada, pois ela será utilizada na configuração do sistema.

:'''3. Configurar o sistema CIGAM'''
::*Vide: [[GE_-_Como_Fazer_-_Configura%C3%A7%C3%A3o_de_Envio_de_E-mail_no_CIGAM#Envio_de_e-mail_com_OAuth_utilizando_o_SendGrid|Envio de e-mail com OAuth utilizando o SendGrid]]

:'''4. Testar o envio de e-mails'''
:Após configurar o sistema:
::# Certifique-se de que o '''SendGrid API Key''' foi registrado corretamente.
::# Realize um teste de envio de e-mail diretamente do sistema configurado.
::# Verifique no painel do SendGrid, na aba '''Activity''', se os e-mails estão sendo enviados e entregues corretamente.

= Página referenciada=
* [[GE_-_Como_Fazer_-_Configura%C3%A7%C3%A3o_de_Envio_de_E-mail_no_CIGAM#Envio_de_e-mail_com_OAuth_utilizando_o_SendGrid|Envio de e-mail com OAuth utilizando o SendGrid]]

GE - Como Fazer - Configuração de Envio de E-mail no CIGAM

2025-02-12T16:43:38Z

Alessandro.voto: /* Envio de e-mail com OAuth utilizando o SendGrid */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM|Configuração de Envio de E-mail no CIGAM]]



= Configuração de envio e email pelo Sistema CIGAM =
O uso de envio de e-mail pelo Sistema Cigam requer informações fornecidas pelo cliente, parametrizações de máquina e configurações de sistema para o correto funcionamento. 

== Quais são as informações de Envio de E-mail para parametrização?==
As informações são geralmente repassadas pelo próprio cliente ou sua T.I. As informações são: 
⦁ Qual é o servidor de e-mail e respectiva porta? 
⦁ Qual é a conta de e-mail do usuário? 
⦁ Qual é a senha de e-mail do usuário? 
⦁ É utilizado algum método de segurança, como SSL (Secure Sockets Layer)? 

== Quais as parametrizações de Envio de E-mail de máquina? ==
O Framework .Net precisa estar devidamente instalado e com suas permissões. Para saber como parametrizar o .Net verificar o documento “[[GE - Como Fazer - Instalação do .Net|Como Fazer - Instalação do .Net]]”. 
{{VoltarInicio}}

== Quais são as configurações para parametrizar o envio de e-mail pelo CIGAM? ==
*As configurações do sistema CIGAM envolvidas são: 
** [[GE - AM - 338 - Opção para envio de e-mail]] 
** [[GE - AM - 545 - Auto-assinatura a ser anexada no envio de e-mail]]
** [[GE - AM - 692 - Servidor de e-mail]]
** [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** [[GE - AM - 1495 - Solicitar confirmação de leitura para e-mails enviados]]
** [[GE - AM - 2077 - Não enviar cópia para o remetente do e-mail]]
** [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]
** [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

== Qual é o cadastro a ser feito? ==
Para o envio de e-mail, é necessário existir um cadastro do usuário sendo opcional a informação do e-mail vinculado a ele. 
<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref> Caso conste informado e-mail no cadastro, esse será considerado somente se a configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] não constar informada. 
Para ser possível o envio de e-mail é necessário que uma das opções conste com o usuário para o login do servidor de e-mail. Seja ele a configuração ou o cadastro de usuário, quando informado nas duas opções acima mencionadas, será respeitado sempre o que estiver informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]]. 
 
O cadastro de usuário e seu e-mail (opcional) é feito através do programa Usuários - Grupos e Direitos
*Utilidades / Diversos
**Parâmetros
***Usuários
****Usuário - Grupos Direitos 

É possível além do e-mail (opcional), informar a Unidade de Negócio (opcional) caso queira reforçar a unidade que pertence o usuário. 
 
Após realizado o cadastro ou eventual modificação, o ajuste só será validado na próxima sessão para isso preciso sair do sistema e entrar novamente para carregar as parametrizações ou então acessar a área onde consta o perfil do usuário e clicar na opção Carregar Parâmetros.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção SmtpClient? ==
SMTP - (Protocolo de Transferência de Correio Simples é o protocolo padrão de envio de mensagens de correio eletrônico através da Internet entre dois dispositivos computacionais). 
Para que seja possível o envio de email via SmtpClient é necessário ter as seguintes configurações parametrizadas:
* E-mail informado no cadastro do usuário 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''SmtpClient'''
* [[GE - AM - 692 - Servidor de e-mail]]
** Indicado o servidor de e-mail seguido por ‘:’ e a porta liberada para envio de e-mail. 
**Se não informado o número da porta o sistema irá realizar o envio de e-mail pela porta padrão: 25 correspondente aos e-mails que serão utilizados para o envio. 
**Para obter as informações servidor e porta para envio de e-mail acesse uma ferramenta de envio de e-mail que esteja configurada (Ex.: Outlook) e busque pelas informações nas propriedades da conta. 
* [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** Opcional deixar a senha já informada para envio direto do e-mail, caso não seja informada pedirá a senha na hora do envio.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada quando o servidor de envio de e-mail utilizado exigir o usuário + o domínio completo para a autenticação (Ex: conta@dominio.com.br). Quando essa configuração estiver desmarcada só será considerado o informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] ou no cadastro de usuário até o caractere @.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP

* '''IMPORTANTE:''' A partir de 30 de maio de 2022, alguns servidores não autorizaram mais o uso de apps ou dispositivos de terceiros que exigem apenas nome de usuário e senha para fazer login na conta, sendo assim indicamos a aplicação da verificação em duas etapas nas contas a serem utilizadas e a utilização de senhas de app, sendo obrigatória para acesso do email no CIGAM a utilização da senha de app. 
* Ao aplicar a senha de APP no CIGAM não será exigido autenticação em duas etapas devido a composição da senha fornecida pelo provedor basta informar ela na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou individualmente a cada envio que esse ocorrerá normalmente. 
** Para configuração de senhas de app consulte a documentação do seu servidor de e-mail, procurando por '''senhas de APP''' ou '''gerenciamento de senhas de APP''', ou siga as informações abaixo.

{{VoltarInicio}}

=== Como criar uma senha de aplicativo ===
====Senha de aplicativo Gmail====
Ao seguir esses passos, você poderá configurar corretamente uma senha de aplicativo no Gmail para ser utilizada com o CIGAM, garantindo que o envio de e-mails via SMTP funcione adequadamente sem a necessidade de usar sua senha principal da conta do Google. 
 
Para configurar uma senha de aplicativo no Gmail, especialmente quando você está utilizando o servidor de envio SMTP e a opção está informada como SmtpClient na configuração [[GE - AM - 338 - Opção para envio de e-mail]], acesse [https://support.google.com/accounts/answer/185833?hl=pt-BR Criar e usar senhas de app] e siga os passos. 
 
Ao acessar, deverá ser informado para qual tipo de app será utilizado, neste caso será "E-mail" e posteriormente será informado para qual tipo de dispositivo.
 
[[Image: envioemailCigam5.png|550px|centro]]
 
Ao clicar em gerar, será gerada uma senha para o dispositivo. Acesse o menu [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Configurações|Configurações]] para informar na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] a senha gerada.
 
[[Image: envioemailCigam6.png|550px|centro]]

====Senha de aplicativo Outlook====
Servidor de envios Office365, será necessário habilitar a Senha de Aplicativo: 
[https://account.live.com/proofs/manage/additional?mkt=pt-BR&refd=account.microsoft.com&refp=security Acesso direto conta Pessoal] 
[https://mysignins.microsoft.com/security-info Acesso diretor conta Profissional - Administrado por Exchange]
 
[[Image: envioemailCigam12.png|750px|centro]]
 
Inserir uma validação com: E-mail ou Telefone:
 
[[Image: envioemailCigam13.png|300px|centro]]
 
Ativar a verificação em duas etapas:
 
[[Image: envioemailCigam14.png|750px|centro]]
 
Após ativar, irá aparecer a opção Senha de Aplicativo, sendo necessária a criação e inserção na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]].
 
[[Image: envioemailCigam15.png|750px|centro]]
 
Caso a Senha de Aplicativo não esteja habilitada, será necessário ativar a Autenticação Multifator(MFA) dentro do [https://admin.exchange.microsoft.com Exchange do Office365].
 
[[Image: envioemailCigam9.png|750px|centro]]
 
Deve-se verificar se a autenticação SMTP está ativa. Somente o Administrador poderá verificar.
 
[[Image: envioemailCigam7.png|350px|centro]]
{{VoltarInicio}}

====Validação Kinghost====
O provedor Kinghost quando utilizado em ambiente nuvem como: FWC ou Nuvem CIGAM, necessitam que seja realizada a parametrização do SMTPI no provedor, assim como o ajuste do SMTP no CIGAM. 
 
[https://king.host/wiki/artigo/como-ativar-o-smtp-internacional/ Como ativar SMTPI Kinghost]

== Como configurar para utilização de envio através da opção Gmail API? ==
Gmail API - (Para usuários do Gmail, a API do Gmail é a melhor opção para acesso autorizado aos dados do Gmail de um usuário. Isso não armazena nenhum dos e-mails no banco de dados de terceiros, proporcionando mais segurança e privacidade aos seus e-mails. A API do Gmail é usada para interagir com as caixas de entrada e configurações do Gmail dos usuários e oferece suporte a várias linguagens de programação populares). 
 
O envio de email via CIGAM através do Gmail API devem ser autorizadas via credenciais do OAuth 2.0. 
Essa funcionalidade exige a utilização de um token de autorização de acesso ao qual deve ser criado através da console de APIs Google - '''[[https://support.google.com/googleapi/answer/6158849/?hl=en&authuser=1| Configurando o OAuth 2.0]]'''.

*As configurações do sistema CIGAM envolvidas são: 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''Gmail API'''
* [[GE - AM - 692 - Servidor de e-mail]]
** smtp.gmail.com:587 
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]
**Pressione F5 e na tela de Cadastro de credenciais, informe o conteúdo do arquivo feito download anteriormente ou clique em ‘Importar’ conforme a configuração feita para obter o token de autorização via console de APIs Google e confirme.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada para o funcionamento do envio via Gmail API
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via Gmail API

* '''Importante:''' Caso não haja informação nas configurações necessárias para validar credenciais, ao enviar o e-mail será aberta uma tela para colocar as informações necessárias.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção OAuth? ==
A partir da <ref group="Versão 241007">Liberado a partir da OS 373456/716.</ref>, a configuração [[GE - AM - 338 - Opção para envio de e-mail]] agora inclui a possibilidade de enviar e-mails utilizando o protocolo OAuth.
:'''OAuth''' refere-se ao processo de envio de e-mails em que a autenticação é feita utilizando o protocolo OAuth (Open Authorization). 
<blockquote>
OAuth é um padrão de autorização que permite que aplicativos acessem recursos, como contas de e-mail, em nome de um usuário, sem precisar saber a senha do usuário. Em vez disso, OAuth utiliza tokens de acesso temporários que autorizam a aplicação a realizar operações, como o envio de e-mails, de forma segura e controlada. 
 
Quando um aplicativo envia e-mails usando OAuth, ele primeiro solicita a autorização do usuário para acessar sua conta de e-mail. Uma vez autorizado, o aplicativo recebe um token de acesso, que pode ser usado para autenticar futuras requisições, como o envio de e-mails. Este método é amplamente adotado por provedores de e-mail como Google (Gmail), Microsoft (Outlook), e outros, por oferecer maior segurança, pois reduz o risco de comprometimento de senhas e permite que os usuários revoguem o acesso a qualquer momento.
</blockquote>

===Envio de e-mail via Office 365===
:O envio de e-mails pelo CIGAM via 'Office 365' deve ser autenticado usando as credenciais do OAuth 2.0. Essa funcionalidade requer a criação e utilização de um token de autorização, que deve ser gerado através da console de administração do Office 365 - [[Como configurar autenticação Office 365 OAuth 2.0]]. Este token garante acesso seguro e permite que o CIGAM envie e-mails em nome do usuário sem a necessidade de expor senhas, aumentando a segurança no processo de comunicação.

'''As configurações do sistema CIGAM envolvidas são:''' 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção: '''OAuth'''

* [[GE - AM - 3233 - OAuth para envio de e-mail]]
** Opção: Informar o Id do cadastro da parametrização desejada
::::Cadastro de parâmetros OAuth
:::::001.1 - Office 365 OAuth 2.0

* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.

* [[GE - AM - 3074 - E-mail do sistema]]

* [[GE - AM - 3075 - Senha do e-mail do sistema]]

* [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]

* [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

:'''Importante:''' A autenticação será realizada sempre com base no remetente do e-mail, que pode variar conforme a rotina utilizada.

===Envio de e-mail com OAuth utilizando o SendGrid===
:O '''SendGrid''' é uma plataforma de envio de e-mails, desenvolvida por terceiros, que atua como intermediário entre uma aplicação e os servidores de e-mail dos destinatários. Essa plataforma oferece recursos como autenticação, monitoramento e alta entregabilidade, e pode ser integrada a aplicações utilizando autenticação via protocolo OAuth para acessar suas APIs.

Antes de iniciar as parametrizações, é necessário realizar o download dos arquivos conforme link abaixo e colocá-los no local da instalação do CIGAM, dentro da pasta 'Cab\Exclusivo'. Exemplo: %CIGAM_INSTAL%\Cab\Exclusivo\EnvioEmailCustomizado\. 
Clique para baixar o pacote de arquivos [https://www.cigam.com.br/wiki/images/a/a2/EnvioEmailCustomizado.zip EnvioEmailCustomizado.zip].

:'''As parametrizações do sistema CIGAM envolvidas são:''' 
:No arquivo MAGIC.INI ou no seu arquivo de adendo, se for o caso, devem ser adicionados na sessão essão [MAGIC_LOGICAL_NAMES] os nomes lógicos listados abaixo.
:EX_CK02176TSI = S
:EX_CK02176TSICabPrg = EE00003
:EX_CK02176TSICab = *%CIGAM_INSTAL%Cab\Exclusivo\EnvioEmailCustomizado\Cab\EnvioEmailCustomizado.ecf
:EX_SENDGRID_APIKEY =
:EX_EMAIL_CUSTOMIZADO = S

IMPORTANTE: na tradução do nome lógico EX_SENDGRID_APIKEY deve ser informada a chave conforme a parametrização do SendGrid realizada pelo cliente. Veja [[GE - Como Fazer - Como integrar o SendGrid|como integrar o SendGrid]].

{{VoltarInicio}}

== Como utilizar ferramentas que necessitam de senhas com mais de 30 caracteres? ==
A utilização de um servidor de relay de e-mail (SMTP Relay) para envio de e-mails é uma solução eficaz em cenários nos quais é necessário lidar com serviços que requerem senhas longas, como o SendGrid ou Amazon Web Services (AWS). Isso pode ser especialmente útil quando se lida com autenticações complexas ou senhas/tokens longos para serviços de e-mail ou outros serviços que utilizam e-mail para comunicação. 
#'''Autenticação pelo SMTP Relay:''' Ao configurar um servidor de relay de e-mail, o servidor assume a responsabilidade de autenticar-se com o serviço de e-mail (por exemplo, SendGrid ou AWS) em nome do sistema que está enviando os e-mails (neste caso, o CIGAM). Isso significa que o CIGAM não precisa lidar diretamente com senhas/tokens longos, tornando a autenticação mais segura e gerenciável.
#'''Implementação:''' A implementação de um servidor de relay de e-mail é responsabilidade do departamento de TI do cliente ou de uma empresa de TI terceirizada, se for esse o caso. A configuração envolve definir as credenciais de autenticação para o serviço de relay, configurar as regras de envio de e-mail e direcionar o CIGAM para usar o servidor de relay.
#'''Considerações de Segurança:''' Certifique-se de que o servidor de relay de e-mail seja adequadamente seguro e mantenha as boas práticas de segurança para proteger as credenciais armazenadas. Além disso, considere a implementação de autenticação em dois fatores (2FA) para aumentar a segurança.

= Envio de e-mail usuários externos =
<ref group="Versão 220404.c"> Liberado a partir da OS 373456/391. </ref> Os e-mails a serem enviados via portais respeitam as mesmas configurações aplicadas diretamente no desktop, os usuários sempre devem possuir um cadastro no CIGAM e seu e-mail no cadastro de usuários. 
* Para que seja possível o envio de e-mail para usuários externos deve ter as seguintes parametrizações: 
** Ter configurado no sistema o envio de e-mail conforme orientações acima
** Informação na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] se optar por não informar a senha de e-mail a cada acesso ao portal.
Sendo assim onde existir a implementação da funcionalidade, caso a configuração: [[GE - AM - 904 - Senha para login no servidor de e-mail]] não conste informada para o usuário será exibida uma tela para que seja possível indicar a senha para login no servidor de e-mail e consequentemente fazer o envio. Essas informações serão aplicadas até o próximo acesso sem necessidade de informar novamente.
{{VoltarInicio}}

=Manuais Referenciados=
*[[Configurações e parametrizações para envio de e-mail através do Cigam]]

= Versão 220404 =
=== Patch "c" ===
<references group="Versão 220404.c"/>
= Versão 221107 =
=== Patch "c" ===
<references group="Versão 221107.c"/>
= Versão 241007 =
<references group="Versão 241007"/>

GE - Como Fazer - Configuração de Envio de E-mail no CIGAM

2025-02-12T16:42:57Z

Alessandro.voto: /* Envio de e-mail com OAuth utilizando o SendGrid */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM|Configuração de Envio de E-mail no CIGAM]]



= Configuração de envio e email pelo Sistema CIGAM =
O uso de envio de e-mail pelo Sistema Cigam requer informações fornecidas pelo cliente, parametrizações de máquina e configurações de sistema para o correto funcionamento. 

== Quais são as informações de Envio de E-mail para parametrização?==
As informações são geralmente repassadas pelo próprio cliente ou sua T.I. As informações são: 
⦁ Qual é o servidor de e-mail e respectiva porta? 
⦁ Qual é a conta de e-mail do usuário? 
⦁ Qual é a senha de e-mail do usuário? 
⦁ É utilizado algum método de segurança, como SSL (Secure Sockets Layer)? 

== Quais as parametrizações de Envio de E-mail de máquina? ==
O Framework .Net precisa estar devidamente instalado e com suas permissões. Para saber como parametrizar o .Net verificar o documento “[[GE - Como Fazer - Instalação do .Net|Como Fazer - Instalação do .Net]]”. 
{{VoltarInicio}}

== Quais são as configurações para parametrizar o envio de e-mail pelo CIGAM? ==
*As configurações do sistema CIGAM envolvidas são: 
** [[GE - AM - 338 - Opção para envio de e-mail]] 
** [[GE - AM - 545 - Auto-assinatura a ser anexada no envio de e-mail]]
** [[GE - AM - 692 - Servidor de e-mail]]
** [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** [[GE - AM - 1495 - Solicitar confirmação de leitura para e-mails enviados]]
** [[GE - AM - 2077 - Não enviar cópia para o remetente do e-mail]]
** [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]
** [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

== Qual é o cadastro a ser feito? ==
Para o envio de e-mail, é necessário existir um cadastro do usuário sendo opcional a informação do e-mail vinculado a ele. 
<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref> Caso conste informado e-mail no cadastro, esse será considerado somente se a configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] não constar informada. 
Para ser possível o envio de e-mail é necessário que uma das opções conste com o usuário para o login do servidor de e-mail. Seja ele a configuração ou o cadastro de usuário, quando informado nas duas opções acima mencionadas, será respeitado sempre o que estiver informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]]. 
 
O cadastro de usuário e seu e-mail (opcional) é feito através do programa Usuários - Grupos e Direitos
*Utilidades / Diversos
**Parâmetros
***Usuários
****Usuário - Grupos Direitos 

É possível além do e-mail (opcional), informar a Unidade de Negócio (opcional) caso queira reforçar a unidade que pertence o usuário. 
 
Após realizado o cadastro ou eventual modificação, o ajuste só será validado na próxima sessão para isso preciso sair do sistema e entrar novamente para carregar as parametrizações ou então acessar a área onde consta o perfil do usuário e clicar na opção Carregar Parâmetros.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção SmtpClient? ==
SMTP - (Protocolo de Transferência de Correio Simples é o protocolo padrão de envio de mensagens de correio eletrônico através da Internet entre dois dispositivos computacionais). 
Para que seja possível o envio de email via SmtpClient é necessário ter as seguintes configurações parametrizadas:
* E-mail informado no cadastro do usuário 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''SmtpClient'''
* [[GE - AM - 692 - Servidor de e-mail]]
** Indicado o servidor de e-mail seguido por ‘:’ e a porta liberada para envio de e-mail. 
**Se não informado o número da porta o sistema irá realizar o envio de e-mail pela porta padrão: 25 correspondente aos e-mails que serão utilizados para o envio. 
**Para obter as informações servidor e porta para envio de e-mail acesse uma ferramenta de envio de e-mail que esteja configurada (Ex.: Outlook) e busque pelas informações nas propriedades da conta. 
* [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** Opcional deixar a senha já informada para envio direto do e-mail, caso não seja informada pedirá a senha na hora do envio.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada quando o servidor de envio de e-mail utilizado exigir o usuário + o domínio completo para a autenticação (Ex: conta@dominio.com.br). Quando essa configuração estiver desmarcada só será considerado o informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] ou no cadastro de usuário até o caractere @.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP

* '''IMPORTANTE:''' A partir de 30 de maio de 2022, alguns servidores não autorizaram mais o uso de apps ou dispositivos de terceiros que exigem apenas nome de usuário e senha para fazer login na conta, sendo assim indicamos a aplicação da verificação em duas etapas nas contas a serem utilizadas e a utilização de senhas de app, sendo obrigatória para acesso do email no CIGAM a utilização da senha de app. 
* Ao aplicar a senha de APP no CIGAM não será exigido autenticação em duas etapas devido a composição da senha fornecida pelo provedor basta informar ela na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou individualmente a cada envio que esse ocorrerá normalmente. 
** Para configuração de senhas de app consulte a documentação do seu servidor de e-mail, procurando por '''senhas de APP''' ou '''gerenciamento de senhas de APP''', ou siga as informações abaixo.

{{VoltarInicio}}

=== Como criar uma senha de aplicativo ===
====Senha de aplicativo Gmail====
Ao seguir esses passos, você poderá configurar corretamente uma senha de aplicativo no Gmail para ser utilizada com o CIGAM, garantindo que o envio de e-mails via SMTP funcione adequadamente sem a necessidade de usar sua senha principal da conta do Google. 
 
Para configurar uma senha de aplicativo no Gmail, especialmente quando você está utilizando o servidor de envio SMTP e a opção está informada como SmtpClient na configuração [[GE - AM - 338 - Opção para envio de e-mail]], acesse [https://support.google.com/accounts/answer/185833?hl=pt-BR Criar e usar senhas de app] e siga os passos. 
 
Ao acessar, deverá ser informado para qual tipo de app será utilizado, neste caso será "E-mail" e posteriormente será informado para qual tipo de dispositivo.
 
[[Image: envioemailCigam5.png|550px|centro]]
 
Ao clicar em gerar, será gerada uma senha para o dispositivo. Acesse o menu [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Configurações|Configurações]] para informar na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] a senha gerada.
 
[[Image: envioemailCigam6.png|550px|centro]]

====Senha de aplicativo Outlook====
Servidor de envios Office365, será necessário habilitar a Senha de Aplicativo: 
[https://account.live.com/proofs/manage/additional?mkt=pt-BR&refd=account.microsoft.com&refp=security Acesso direto conta Pessoal] 
[https://mysignins.microsoft.com/security-info Acesso diretor conta Profissional - Administrado por Exchange]
 
[[Image: envioemailCigam12.png|750px|centro]]
 
Inserir uma validação com: E-mail ou Telefone:
 
[[Image: envioemailCigam13.png|300px|centro]]
 
Ativar a verificação em duas etapas:
 
[[Image: envioemailCigam14.png|750px|centro]]
 
Após ativar, irá aparecer a opção Senha de Aplicativo, sendo necessária a criação e inserção na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]].
 
[[Image: envioemailCigam15.png|750px|centro]]
 
Caso a Senha de Aplicativo não esteja habilitada, será necessário ativar a Autenticação Multifator(MFA) dentro do [https://admin.exchange.microsoft.com Exchange do Office365].
 
[[Image: envioemailCigam9.png|750px|centro]]
 
Deve-se verificar se a autenticação SMTP está ativa. Somente o Administrador poderá verificar.
 
[[Image: envioemailCigam7.png|350px|centro]]
{{VoltarInicio}}

====Validação Kinghost====
O provedor Kinghost quando utilizado em ambiente nuvem como: FWC ou Nuvem CIGAM, necessitam que seja realizada a parametrização do SMTPI no provedor, assim como o ajuste do SMTP no CIGAM. 
 
[https://king.host/wiki/artigo/como-ativar-o-smtp-internacional/ Como ativar SMTPI Kinghost]

== Como configurar para utilização de envio através da opção Gmail API? ==
Gmail API - (Para usuários do Gmail, a API do Gmail é a melhor opção para acesso autorizado aos dados do Gmail de um usuário. Isso não armazena nenhum dos e-mails no banco de dados de terceiros, proporcionando mais segurança e privacidade aos seus e-mails. A API do Gmail é usada para interagir com as caixas de entrada e configurações do Gmail dos usuários e oferece suporte a várias linguagens de programação populares). 
 
O envio de email via CIGAM através do Gmail API devem ser autorizadas via credenciais do OAuth 2.0. 
Essa funcionalidade exige a utilização de um token de autorização de acesso ao qual deve ser criado através da console de APIs Google - '''[[https://support.google.com/googleapi/answer/6158849/?hl=en&authuser=1| Configurando o OAuth 2.0]]'''.

*As configurações do sistema CIGAM envolvidas são: 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''Gmail API'''
* [[GE - AM - 692 - Servidor de e-mail]]
** smtp.gmail.com:587 
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]
**Pressione F5 e na tela de Cadastro de credenciais, informe o conteúdo do arquivo feito download anteriormente ou clique em ‘Importar’ conforme a configuração feita para obter o token de autorização via console de APIs Google e confirme.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada para o funcionamento do envio via Gmail API
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via Gmail API

* '''Importante:''' Caso não haja informação nas configurações necessárias para validar credenciais, ao enviar o e-mail será aberta uma tela para colocar as informações necessárias.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção OAuth? ==
A partir da <ref group="Versão 241007">Liberado a partir da OS 373456/716.</ref>, a configuração [[GE - AM - 338 - Opção para envio de e-mail]] agora inclui a possibilidade de enviar e-mails utilizando o protocolo OAuth.
:'''OAuth''' refere-se ao processo de envio de e-mails em que a autenticação é feita utilizando o protocolo OAuth (Open Authorization). 
<blockquote>
OAuth é um padrão de autorização que permite que aplicativos acessem recursos, como contas de e-mail, em nome de um usuário, sem precisar saber a senha do usuário. Em vez disso, OAuth utiliza tokens de acesso temporários que autorizam a aplicação a realizar operações, como o envio de e-mails, de forma segura e controlada. 
 
Quando um aplicativo envia e-mails usando OAuth, ele primeiro solicita a autorização do usuário para acessar sua conta de e-mail. Uma vez autorizado, o aplicativo recebe um token de acesso, que pode ser usado para autenticar futuras requisições, como o envio de e-mails. Este método é amplamente adotado por provedores de e-mail como Google (Gmail), Microsoft (Outlook), e outros, por oferecer maior segurança, pois reduz o risco de comprometimento de senhas e permite que os usuários revoguem o acesso a qualquer momento.
</blockquote>

===Envio de e-mail via Office 365===
:O envio de e-mails pelo CIGAM via 'Office 365' deve ser autenticado usando as credenciais do OAuth 2.0. Essa funcionalidade requer a criação e utilização de um token de autorização, que deve ser gerado através da console de administração do Office 365 - [[Como configurar autenticação Office 365 OAuth 2.0]]. Este token garante acesso seguro e permite que o CIGAM envie e-mails em nome do usuário sem a necessidade de expor senhas, aumentando a segurança no processo de comunicação.

'''As configurações do sistema CIGAM envolvidas são:''' 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção: '''OAuth'''

* [[GE - AM - 3233 - OAuth para envio de e-mail]]
** Opção: Informar o Id do cadastro da parametrização desejada
::::Cadastro de parâmetros OAuth
:::::001.1 - Office 365 OAuth 2.0

* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.

* [[GE - AM - 3074 - E-mail do sistema]]

* [[GE - AM - 3075 - Senha do e-mail do sistema]]

* [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]

* [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

:'''Importante:''' A autenticação será realizada sempre com base no remetente do e-mail, que pode variar conforme a rotina utilizada.

===Envio de e-mail com OAuth utilizando o SendGrid===
:O '''SendGrid''' é uma plataforma de envio de e-mails, desenvolvida por terceiros, que atua como intermediário entre uma aplicação e os servidores de e-mail dos destinatários. Essa plataforma oferece recursos como autenticação, monitoramento e alta entregabilidade, e pode ser integrada a aplicações utilizando autenticação via protocolo OAuth para acessar suas APIs.

Antes de iniciar as parametrizações, é necessário realizar o download dos arquivos conforme link abaixo e colocá-los no local da instalação do CIGAM, dentro da pasta 'Cab\Exclusivo'. Exemplo: %CIGAM_INSTAL%\Cab\Exclusivo\EnvioEmailCustomizado\. 
Clique para baixar o pacote de arquivos [https://www.cigam.com.br/wiki/images/a/a2/EnvioEmailCustomizado.zip EnvioEmailCustomizado.zip].

'''As parametrizações do sistema CIGAM envolvidas são:''' 
:No arquivo MAGIC.INI ou no seu arquivo de adendo, se for o caso, devem ser adicionados na sessão essão [MAGIC_LOGICAL_NAMES] os nomes lógicos listados abaixo.
:EX_CK02176TSI = S
:EX_CK02176TSICabPrg = EE00003
:EX_CK02176TSICab = *%CIGAM_INSTAL%Cab\Exclusivo\EnvioEmailCustomizado\Cab\EnvioEmailCustomizado.ecf
:EX_SENDGRID_APIKEY =
:EX_EMAIL_CUSTOMIZADO = S

IMPORTANTE: na tradução do nome lógico EX_SENDGRID_APIKEY deve ser informada a chave conforme a parametrização do SendGrid realizada pelo cliente. Veja [[GE - Como Fazer - Como integrar o SendGrid|como integrar o SendGrid]].

{{VoltarInicio}}

== Como utilizar ferramentas que necessitam de senhas com mais de 30 caracteres? ==
A utilização de um servidor de relay de e-mail (SMTP Relay) para envio de e-mails é uma solução eficaz em cenários nos quais é necessário lidar com serviços que requerem senhas longas, como o SendGrid ou Amazon Web Services (AWS). Isso pode ser especialmente útil quando se lida com autenticações complexas ou senhas/tokens longos para serviços de e-mail ou outros serviços que utilizam e-mail para comunicação. 
#'''Autenticação pelo SMTP Relay:''' Ao configurar um servidor de relay de e-mail, o servidor assume a responsabilidade de autenticar-se com o serviço de e-mail (por exemplo, SendGrid ou AWS) em nome do sistema que está enviando os e-mails (neste caso, o CIGAM). Isso significa que o CIGAM não precisa lidar diretamente com senhas/tokens longos, tornando a autenticação mais segura e gerenciável.
#'''Implementação:''' A implementação de um servidor de relay de e-mail é responsabilidade do departamento de TI do cliente ou de uma empresa de TI terceirizada, se for esse o caso. A configuração envolve definir as credenciais de autenticação para o serviço de relay, configurar as regras de envio de e-mail e direcionar o CIGAM para usar o servidor de relay.
#'''Considerações de Segurança:''' Certifique-se de que o servidor de relay de e-mail seja adequadamente seguro e mantenha as boas práticas de segurança para proteger as credenciais armazenadas. Além disso, considere a implementação de autenticação em dois fatores (2FA) para aumentar a segurança.

= Envio de e-mail usuários externos =
<ref group="Versão 220404.c"> Liberado a partir da OS 373456/391. </ref> Os e-mails a serem enviados via portais respeitam as mesmas configurações aplicadas diretamente no desktop, os usuários sempre devem possuir um cadastro no CIGAM e seu e-mail no cadastro de usuários. 
* Para que seja possível o envio de e-mail para usuários externos deve ter as seguintes parametrizações: 
** Ter configurado no sistema o envio de e-mail conforme orientações acima
** Informação na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] se optar por não informar a senha de e-mail a cada acesso ao portal.
Sendo assim onde existir a implementação da funcionalidade, caso a configuração: [[GE - AM - 904 - Senha para login no servidor de e-mail]] não conste informada para o usuário será exibida uma tela para que seja possível indicar a senha para login no servidor de e-mail e consequentemente fazer o envio. Essas informações serão aplicadas até o próximo acesso sem necessidade de informar novamente.
{{VoltarInicio}}

=Manuais Referenciados=
*[[Configurações e parametrizações para envio de e-mail através do Cigam]]

= Versão 220404 =
=== Patch "c" ===
<references group="Versão 220404.c"/>
= Versão 221107 =
=== Patch "c" ===
<references group="Versão 221107.c"/>
= Versão 241007 =
<references group="Versão 241007"/>

GE - Como Fazer - Configuração de Envio de E-mail no CIGAM

2025-02-12T16:37:25Z

Alessandro.voto: /* Envio de e-mail com OAuth utilizando o SendGrid */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM|Configuração de Envio de E-mail no CIGAM]]



= Configuração de envio e email pelo Sistema CIGAM =
O uso de envio de e-mail pelo Sistema Cigam requer informações fornecidas pelo cliente, parametrizações de máquina e configurações de sistema para o correto funcionamento. 

== Quais são as informações de Envio de E-mail para parametrização?==
As informações são geralmente repassadas pelo próprio cliente ou sua T.I. As informações são: 
⦁ Qual é o servidor de e-mail e respectiva porta? 
⦁ Qual é a conta de e-mail do usuário? 
⦁ Qual é a senha de e-mail do usuário? 
⦁ É utilizado algum método de segurança, como SSL (Secure Sockets Layer)? 

== Quais as parametrizações de Envio de E-mail de máquina? ==
O Framework .Net precisa estar devidamente instalado e com suas permissões. Para saber como parametrizar o .Net verificar o documento “[[GE - Como Fazer - Instalação do .Net|Como Fazer - Instalação do .Net]]”. 
{{VoltarInicio}}

== Quais são as configurações para parametrizar o envio de e-mail pelo CIGAM? ==
*As configurações do sistema CIGAM envolvidas são: 
** [[GE - AM - 338 - Opção para envio de e-mail]] 
** [[GE - AM - 545 - Auto-assinatura a ser anexada no envio de e-mail]]
** [[GE - AM - 692 - Servidor de e-mail]]
** [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** [[GE - AM - 1495 - Solicitar confirmação de leitura para e-mails enviados]]
** [[GE - AM - 2077 - Não enviar cópia para o remetente do e-mail]]
** [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]
** [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

== Qual é o cadastro a ser feito? ==
Para o envio de e-mail, é necessário existir um cadastro do usuário sendo opcional a informação do e-mail vinculado a ele. 
<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref> Caso conste informado e-mail no cadastro, esse será considerado somente se a configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] não constar informada. 
Para ser possível o envio de e-mail é necessário que uma das opções conste com o usuário para o login do servidor de e-mail. Seja ele a configuração ou o cadastro de usuário, quando informado nas duas opções acima mencionadas, será respeitado sempre o que estiver informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]]. 
 
O cadastro de usuário e seu e-mail (opcional) é feito através do programa Usuários - Grupos e Direitos
*Utilidades / Diversos
**Parâmetros
***Usuários
****Usuário - Grupos Direitos 

É possível além do e-mail (opcional), informar a Unidade de Negócio (opcional) caso queira reforçar a unidade que pertence o usuário. 
 
Após realizado o cadastro ou eventual modificação, o ajuste só será validado na próxima sessão para isso preciso sair do sistema e entrar novamente para carregar as parametrizações ou então acessar a área onde consta o perfil do usuário e clicar na opção Carregar Parâmetros.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção SmtpClient? ==
SMTP - (Protocolo de Transferência de Correio Simples é o protocolo padrão de envio de mensagens de correio eletrônico através da Internet entre dois dispositivos computacionais). 
Para que seja possível o envio de email via SmtpClient é necessário ter as seguintes configurações parametrizadas:
* E-mail informado no cadastro do usuário 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''SmtpClient'''
* [[GE - AM - 692 - Servidor de e-mail]]
** Indicado o servidor de e-mail seguido por ‘:’ e a porta liberada para envio de e-mail. 
**Se não informado o número da porta o sistema irá realizar o envio de e-mail pela porta padrão: 25 correspondente aos e-mails que serão utilizados para o envio. 
**Para obter as informações servidor e porta para envio de e-mail acesse uma ferramenta de envio de e-mail que esteja configurada (Ex.: Outlook) e busque pelas informações nas propriedades da conta. 
* [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** Opcional deixar a senha já informada para envio direto do e-mail, caso não seja informada pedirá a senha na hora do envio.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada quando o servidor de envio de e-mail utilizado exigir o usuário + o domínio completo para a autenticação (Ex: conta@dominio.com.br). Quando essa configuração estiver desmarcada só será considerado o informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] ou no cadastro de usuário até o caractere @.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP

* '''IMPORTANTE:''' A partir de 30 de maio de 2022, alguns servidores não autorizaram mais o uso de apps ou dispositivos de terceiros que exigem apenas nome de usuário e senha para fazer login na conta, sendo assim indicamos a aplicação da verificação em duas etapas nas contas a serem utilizadas e a utilização de senhas de app, sendo obrigatória para acesso do email no CIGAM a utilização da senha de app. 
* Ao aplicar a senha de APP no CIGAM não será exigido autenticação em duas etapas devido a composição da senha fornecida pelo provedor basta informar ela na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou individualmente a cada envio que esse ocorrerá normalmente. 
** Para configuração de senhas de app consulte a documentação do seu servidor de e-mail, procurando por '''senhas de APP''' ou '''gerenciamento de senhas de APP''', ou siga as informações abaixo.

{{VoltarInicio}}

=== Como criar uma senha de aplicativo ===
====Senha de aplicativo Gmail====
Ao seguir esses passos, você poderá configurar corretamente uma senha de aplicativo no Gmail para ser utilizada com o CIGAM, garantindo que o envio de e-mails via SMTP funcione adequadamente sem a necessidade de usar sua senha principal da conta do Google. 
 
Para configurar uma senha de aplicativo no Gmail, especialmente quando você está utilizando o servidor de envio SMTP e a opção está informada como SmtpClient na configuração [[GE - AM - 338 - Opção para envio de e-mail]], acesse [https://support.google.com/accounts/answer/185833?hl=pt-BR Criar e usar senhas de app] e siga os passos. 
 
Ao acessar, deverá ser informado para qual tipo de app será utilizado, neste caso será "E-mail" e posteriormente será informado para qual tipo de dispositivo.
 
[[Image: envioemailCigam5.png|550px|centro]]
 
Ao clicar em gerar, será gerada uma senha para o dispositivo. Acesse o menu [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Configurações|Configurações]] para informar na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] a senha gerada.
 
[[Image: envioemailCigam6.png|550px|centro]]

====Senha de aplicativo Outlook====
Servidor de envios Office365, será necessário habilitar a Senha de Aplicativo: 
[https://account.live.com/proofs/manage/additional?mkt=pt-BR&refd=account.microsoft.com&refp=security Acesso direto conta Pessoal] 
[https://mysignins.microsoft.com/security-info Acesso diretor conta Profissional - Administrado por Exchange]
 
[[Image: envioemailCigam12.png|750px|centro]]
 
Inserir uma validação com: E-mail ou Telefone:
 
[[Image: envioemailCigam13.png|300px|centro]]
 
Ativar a verificação em duas etapas:
 
[[Image: envioemailCigam14.png|750px|centro]]
 
Após ativar, irá aparecer a opção Senha de Aplicativo, sendo necessária a criação e inserção na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]].
 
[[Image: envioemailCigam15.png|750px|centro]]
 
Caso a Senha de Aplicativo não esteja habilitada, será necessário ativar a Autenticação Multifator(MFA) dentro do [https://admin.exchange.microsoft.com Exchange do Office365].
 
[[Image: envioemailCigam9.png|750px|centro]]
 
Deve-se verificar se a autenticação SMTP está ativa. Somente o Administrador poderá verificar.
 
[[Image: envioemailCigam7.png|350px|centro]]
{{VoltarInicio}}

====Validação Kinghost====
O provedor Kinghost quando utilizado em ambiente nuvem como: FWC ou Nuvem CIGAM, necessitam que seja realizada a parametrização do SMTPI no provedor, assim como o ajuste do SMTP no CIGAM. 
 
[https://king.host/wiki/artigo/como-ativar-o-smtp-internacional/ Como ativar SMTPI Kinghost]

== Como configurar para utilização de envio através da opção Gmail API? ==
Gmail API - (Para usuários do Gmail, a API do Gmail é a melhor opção para acesso autorizado aos dados do Gmail de um usuário. Isso não armazena nenhum dos e-mails no banco de dados de terceiros, proporcionando mais segurança e privacidade aos seus e-mails. A API do Gmail é usada para interagir com as caixas de entrada e configurações do Gmail dos usuários e oferece suporte a várias linguagens de programação populares). 
 
O envio de email via CIGAM através do Gmail API devem ser autorizadas via credenciais do OAuth 2.0. 
Essa funcionalidade exige a utilização de um token de autorização de acesso ao qual deve ser criado através da console de APIs Google - '''[[https://support.google.com/googleapi/answer/6158849/?hl=en&authuser=1| Configurando o OAuth 2.0]]'''.

*As configurações do sistema CIGAM envolvidas são: 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''Gmail API'''
* [[GE - AM - 692 - Servidor de e-mail]]
** smtp.gmail.com:587 
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]
**Pressione F5 e na tela de Cadastro de credenciais, informe o conteúdo do arquivo feito download anteriormente ou clique em ‘Importar’ conforme a configuração feita para obter o token de autorização via console de APIs Google e confirme.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada para o funcionamento do envio via Gmail API
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via Gmail API

* '''Importante:''' Caso não haja informação nas configurações necessárias para validar credenciais, ao enviar o e-mail será aberta uma tela para colocar as informações necessárias.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção OAuth? ==
A partir da <ref group="Versão 241007">Liberado a partir da OS 373456/716.</ref>, a configuração [[GE - AM - 338 - Opção para envio de e-mail]] agora inclui a possibilidade de enviar e-mails utilizando o protocolo OAuth.
:'''OAuth''' refere-se ao processo de envio de e-mails em que a autenticação é feita utilizando o protocolo OAuth (Open Authorization). 
<blockquote>
OAuth é um padrão de autorização que permite que aplicativos acessem recursos, como contas de e-mail, em nome de um usuário, sem precisar saber a senha do usuário. Em vez disso, OAuth utiliza tokens de acesso temporários que autorizam a aplicação a realizar operações, como o envio de e-mails, de forma segura e controlada. 
 
Quando um aplicativo envia e-mails usando OAuth, ele primeiro solicita a autorização do usuário para acessar sua conta de e-mail. Uma vez autorizado, o aplicativo recebe um token de acesso, que pode ser usado para autenticar futuras requisições, como o envio de e-mails. Este método é amplamente adotado por provedores de e-mail como Google (Gmail), Microsoft (Outlook), e outros, por oferecer maior segurança, pois reduz o risco de comprometimento de senhas e permite que os usuários revoguem o acesso a qualquer momento.
</blockquote>

===Envio de e-mail via Office 365===
:O envio de e-mails pelo CIGAM via 'Office 365' deve ser autenticado usando as credenciais do OAuth 2.0. Essa funcionalidade requer a criação e utilização de um token de autorização, que deve ser gerado através da console de administração do Office 365 - [[Como configurar autenticação Office 365 OAuth 2.0]]. Este token garante acesso seguro e permite que o CIGAM envie e-mails em nome do usuário sem a necessidade de expor senhas, aumentando a segurança no processo de comunicação.

'''As configurações do sistema CIGAM envolvidas são:''' 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção: '''OAuth'''

* [[GE - AM - 3233 - OAuth para envio de e-mail]]
** Opção: Informar o Id do cadastro da parametrização desejada
::::Cadastro de parâmetros OAuth
:::::001.1 - Office 365 OAuth 2.0

* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.

* [[GE - AM - 3074 - E-mail do sistema]]

* [[GE - AM - 3075 - Senha do e-mail do sistema]]

* [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]

* [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

:'''Importante:''' A autenticação será realizada sempre com base no remetente do e-mail, que pode variar conforme a rotina utilizada.

===Envio de e-mail com OAuth utilizando o SendGrid===
:O '''SendGrid''' é uma plataforma de envio de e-mails, desenvolvida por terceiros, que atua como intermediário entre uma aplicação e os servidores de e-mail dos destinatários. Essa plataforma oferece recursos como autenticação, monitoramento e alta entregabilidade, e pode ser integrada a aplicações utilizando autenticação via protocolo OAuth para acessar suas APIs. Veja [[GE - Como Fazer - Como integrar o SendGrid|como integrar o SendGrid]].

Antes de iniciar as parametrizações, é necessário realizar o download dos arquivos conforme link abaixo e colocá-los no local da instalação do CIGAM, dentro da pasta 'Cab\Exclusivo'. Exemplo: %CIGAM_INSTAL%\Cab\Exclusivo\EnvioEmailCustomizado\. 
Clique para baixar o pacote de arquivos [https://www.cigam.com.br/wiki/images/a/a2/EnvioEmailCustomizado.zip EnvioEmailCustomizado.zip].

'''As parametrizações do sistema CIGAM envolvidas são:''' 
:'''No arquivo MAGIC.INI ou no seu arquivo de adendo, se for o caso, devem ser adicionados na sessão essão [MAGIC_LOGICAL_NAMES] os nomes lógicos listados abaixo'''.
:::EX_CK02176TSI = S
:::EX_CK02176TSICabPrg = EE00003
:::EX_CK02176TSICab = *%CIGAM_INSTAL%Cab\Exclusivo\EnvioEmailCustomizado\Cab\EnvioEmailCustomizado.ecf
:::EX_SENDGRID_APIKEY =
:::EX_EMAIL_CUSTOMIZADO = S

IMPORTANTE: na tradução do nome lógico EX_SENDGRID_APIKEY deve ser informada a chave conforme a parametrização do SendGrid realizada pelo cliente. Veja [[GE - Como Fazer - Como integrar o SendGrid|como integrar o SendGrid]].

{{VoltarInicio}}

== Como utilizar ferramentas que necessitam de senhas com mais de 30 caracteres? ==
A utilização de um servidor de relay de e-mail (SMTP Relay) para envio de e-mails é uma solução eficaz em cenários nos quais é necessário lidar com serviços que requerem senhas longas, como o SendGrid ou Amazon Web Services (AWS). Isso pode ser especialmente útil quando se lida com autenticações complexas ou senhas/tokens longos para serviços de e-mail ou outros serviços que utilizam e-mail para comunicação. 
#'''Autenticação pelo SMTP Relay:''' Ao configurar um servidor de relay de e-mail, o servidor assume a responsabilidade de autenticar-se com o serviço de e-mail (por exemplo, SendGrid ou AWS) em nome do sistema que está enviando os e-mails (neste caso, o CIGAM). Isso significa que o CIGAM não precisa lidar diretamente com senhas/tokens longos, tornando a autenticação mais segura e gerenciável.
#'''Implementação:''' A implementação de um servidor de relay de e-mail é responsabilidade do departamento de TI do cliente ou de uma empresa de TI terceirizada, se for esse o caso. A configuração envolve definir as credenciais de autenticação para o serviço de relay, configurar as regras de envio de e-mail e direcionar o CIGAM para usar o servidor de relay.
#'''Considerações de Segurança:''' Certifique-se de que o servidor de relay de e-mail seja adequadamente seguro e mantenha as boas práticas de segurança para proteger as credenciais armazenadas. Além disso, considere a implementação de autenticação em dois fatores (2FA) para aumentar a segurança.

= Envio de e-mail usuários externos =
<ref group="Versão 220404.c"> Liberado a partir da OS 373456/391. </ref> Os e-mails a serem enviados via portais respeitam as mesmas configurações aplicadas diretamente no desktop, os usuários sempre devem possuir um cadastro no CIGAM e seu e-mail no cadastro de usuários. 
* Para que seja possível o envio de e-mail para usuários externos deve ter as seguintes parametrizações: 
** Ter configurado no sistema o envio de e-mail conforme orientações acima
** Informação na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] se optar por não informar a senha de e-mail a cada acesso ao portal.
Sendo assim onde existir a implementação da funcionalidade, caso a configuração: [[GE - AM - 904 - Senha para login no servidor de e-mail]] não conste informada para o usuário será exibida uma tela para que seja possível indicar a senha para login no servidor de e-mail e consequentemente fazer o envio. Essas informações serão aplicadas até o próximo acesso sem necessidade de informar novamente.
{{VoltarInicio}}

=Manuais Referenciados=
*[[Configurações e parametrizações para envio de e-mail através do Cigam]]

= Versão 220404 =
=== Patch "c" ===
<references group="Versão 220404.c"/>
= Versão 221107 =
=== Patch "c" ===
<references group="Versão 221107.c"/>
= Versão 241007 =
<references group="Versão 241007"/>

GE - Como Fazer - Configuração de Envio de E-mail no CIGAM

2025-02-12T16:27:21Z

Alessandro.voto: /* Envio de e-mail com OAuth utilizando o SendGrid */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM|Configuração de Envio de E-mail no CIGAM]]



= Configuração de envio e email pelo Sistema CIGAM =
O uso de envio de e-mail pelo Sistema Cigam requer informações fornecidas pelo cliente, parametrizações de máquina e configurações de sistema para o correto funcionamento. 

== Quais são as informações de Envio de E-mail para parametrização?==
As informações são geralmente repassadas pelo próprio cliente ou sua T.I. As informações são: 
⦁ Qual é o servidor de e-mail e respectiva porta? 
⦁ Qual é a conta de e-mail do usuário? 
⦁ Qual é a senha de e-mail do usuário? 
⦁ É utilizado algum método de segurança, como SSL (Secure Sockets Layer)? 

== Quais as parametrizações de Envio de E-mail de máquina? ==
O Framework .Net precisa estar devidamente instalado e com suas permissões. Para saber como parametrizar o .Net verificar o documento “[[GE - Como Fazer - Instalação do .Net|Como Fazer - Instalação do .Net]]”. 
{{VoltarInicio}}

== Quais são as configurações para parametrizar o envio de e-mail pelo CIGAM? ==
*As configurações do sistema CIGAM envolvidas são: 
** [[GE - AM - 338 - Opção para envio de e-mail]] 
** [[GE - AM - 545 - Auto-assinatura a ser anexada no envio de e-mail]]
** [[GE - AM - 692 - Servidor de e-mail]]
** [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** [[GE - AM - 1495 - Solicitar confirmação de leitura para e-mails enviados]]
** [[GE - AM - 2077 - Não enviar cópia para o remetente do e-mail]]
** [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]
** [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

== Qual é o cadastro a ser feito? ==
Para o envio de e-mail, é necessário existir um cadastro do usuário sendo opcional a informação do e-mail vinculado a ele. 
<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref> Caso conste informado e-mail no cadastro, esse será considerado somente se a configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] não constar informada. 
Para ser possível o envio de e-mail é necessário que uma das opções conste com o usuário para o login do servidor de e-mail. Seja ele a configuração ou o cadastro de usuário, quando informado nas duas opções acima mencionadas, será respeitado sempre o que estiver informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]]. 
 
O cadastro de usuário e seu e-mail (opcional) é feito através do programa Usuários - Grupos e Direitos
*Utilidades / Diversos
**Parâmetros
***Usuários
****Usuário - Grupos Direitos 

É possível além do e-mail (opcional), informar a Unidade de Negócio (opcional) caso queira reforçar a unidade que pertence o usuário. 
 
Após realizado o cadastro ou eventual modificação, o ajuste só será validado na próxima sessão para isso preciso sair do sistema e entrar novamente para carregar as parametrizações ou então acessar a área onde consta o perfil do usuário e clicar na opção Carregar Parâmetros.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção SmtpClient? ==
SMTP - (Protocolo de Transferência de Correio Simples é o protocolo padrão de envio de mensagens de correio eletrônico através da Internet entre dois dispositivos computacionais). 
Para que seja possível o envio de email via SmtpClient é necessário ter as seguintes configurações parametrizadas:
* E-mail informado no cadastro do usuário 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''SmtpClient'''
* [[GE - AM - 692 - Servidor de e-mail]]
** Indicado o servidor de e-mail seguido por ‘:’ e a porta liberada para envio de e-mail. 
**Se não informado o número da porta o sistema irá realizar o envio de e-mail pela porta padrão: 25 correspondente aos e-mails que serão utilizados para o envio. 
**Para obter as informações servidor e porta para envio de e-mail acesse uma ferramenta de envio de e-mail que esteja configurada (Ex.: Outlook) e busque pelas informações nas propriedades da conta. 
* [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** Opcional deixar a senha já informada para envio direto do e-mail, caso não seja informada pedirá a senha na hora do envio.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada quando o servidor de envio de e-mail utilizado exigir o usuário + o domínio completo para a autenticação (Ex: conta@dominio.com.br). Quando essa configuração estiver desmarcada só será considerado o informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] ou no cadastro de usuário até o caractere @.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP

* '''IMPORTANTE:''' A partir de 30 de maio de 2022, alguns servidores não autorizaram mais o uso de apps ou dispositivos de terceiros que exigem apenas nome de usuário e senha para fazer login na conta, sendo assim indicamos a aplicação da verificação em duas etapas nas contas a serem utilizadas e a utilização de senhas de app, sendo obrigatória para acesso do email no CIGAM a utilização da senha de app. 
* Ao aplicar a senha de APP no CIGAM não será exigido autenticação em duas etapas devido a composição da senha fornecida pelo provedor basta informar ela na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou individualmente a cada envio que esse ocorrerá normalmente. 
** Para configuração de senhas de app consulte a documentação do seu servidor de e-mail, procurando por '''senhas de APP''' ou '''gerenciamento de senhas de APP''', ou siga as informações abaixo.

{{VoltarInicio}}

=== Como criar uma senha de aplicativo ===
====Senha de aplicativo Gmail====
Ao seguir esses passos, você poderá configurar corretamente uma senha de aplicativo no Gmail para ser utilizada com o CIGAM, garantindo que o envio de e-mails via SMTP funcione adequadamente sem a necessidade de usar sua senha principal da conta do Google. 
 
Para configurar uma senha de aplicativo no Gmail, especialmente quando você está utilizando o servidor de envio SMTP e a opção está informada como SmtpClient na configuração [[GE - AM - 338 - Opção para envio de e-mail]], acesse [https://support.google.com/accounts/answer/185833?hl=pt-BR Criar e usar senhas de app] e siga os passos. 
 
Ao acessar, deverá ser informado para qual tipo de app será utilizado, neste caso será "E-mail" e posteriormente será informado para qual tipo de dispositivo.
 
[[Image: envioemailCigam5.png|550px|centro]]
 
Ao clicar em gerar, será gerada uma senha para o dispositivo. Acesse o menu [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Configurações|Configurações]] para informar na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] a senha gerada.
 
[[Image: envioemailCigam6.png|550px|centro]]

====Senha de aplicativo Outlook====
Servidor de envios Office365, será necessário habilitar a Senha de Aplicativo: 
[https://account.live.com/proofs/manage/additional?mkt=pt-BR&refd=account.microsoft.com&refp=security Acesso direto conta Pessoal] 
[https://mysignins.microsoft.com/security-info Acesso diretor conta Profissional - Administrado por Exchange]
 
[[Image: envioemailCigam12.png|750px|centro]]
 
Inserir uma validação com: E-mail ou Telefone:
 
[[Image: envioemailCigam13.png|300px|centro]]
 
Ativar a verificação em duas etapas:
 
[[Image: envioemailCigam14.png|750px|centro]]
 
Após ativar, irá aparecer a opção Senha de Aplicativo, sendo necessária a criação e inserção na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]].
 
[[Image: envioemailCigam15.png|750px|centro]]
 
Caso a Senha de Aplicativo não esteja habilitada, será necessário ativar a Autenticação Multifator(MFA) dentro do [https://admin.exchange.microsoft.com Exchange do Office365].
 
[[Image: envioemailCigam9.png|750px|centro]]
 
Deve-se verificar se a autenticação SMTP está ativa. Somente o Administrador poderá verificar.
 
[[Image: envioemailCigam7.png|350px|centro]]
{{VoltarInicio}}

====Validação Kinghost====
O provedor Kinghost quando utilizado em ambiente nuvem como: FWC ou Nuvem CIGAM, necessitam que seja realizada a parametrização do SMTPI no provedor, assim como o ajuste do SMTP no CIGAM. 
 
[https://king.host/wiki/artigo/como-ativar-o-smtp-internacional/ Como ativar SMTPI Kinghost]

== Como configurar para utilização de envio através da opção Gmail API? ==
Gmail API - (Para usuários do Gmail, a API do Gmail é a melhor opção para acesso autorizado aos dados do Gmail de um usuário. Isso não armazena nenhum dos e-mails no banco de dados de terceiros, proporcionando mais segurança e privacidade aos seus e-mails. A API do Gmail é usada para interagir com as caixas de entrada e configurações do Gmail dos usuários e oferece suporte a várias linguagens de programação populares). 
 
O envio de email via CIGAM através do Gmail API devem ser autorizadas via credenciais do OAuth 2.0. 
Essa funcionalidade exige a utilização de um token de autorização de acesso ao qual deve ser criado através da console de APIs Google - '''[[https://support.google.com/googleapi/answer/6158849/?hl=en&authuser=1| Configurando o OAuth 2.0]]'''.

*As configurações do sistema CIGAM envolvidas são: 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''Gmail API'''
* [[GE - AM - 692 - Servidor de e-mail]]
** smtp.gmail.com:587 
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]
**Pressione F5 e na tela de Cadastro de credenciais, informe o conteúdo do arquivo feito download anteriormente ou clique em ‘Importar’ conforme a configuração feita para obter o token de autorização via console de APIs Google e confirme.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada para o funcionamento do envio via Gmail API
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via Gmail API

* '''Importante:''' Caso não haja informação nas configurações necessárias para validar credenciais, ao enviar o e-mail será aberta uma tela para colocar as informações necessárias.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção OAuth? ==
A partir da <ref group="Versão 241007">Liberado a partir da OS 373456/716.</ref>, a configuração [[GE - AM - 338 - Opção para envio de e-mail]] agora inclui a possibilidade de enviar e-mails utilizando o protocolo OAuth.
:'''OAuth''' refere-se ao processo de envio de e-mails em que a autenticação é feita utilizando o protocolo OAuth (Open Authorization). 
<blockquote>
OAuth é um padrão de autorização que permite que aplicativos acessem recursos, como contas de e-mail, em nome de um usuário, sem precisar saber a senha do usuário. Em vez disso, OAuth utiliza tokens de acesso temporários que autorizam a aplicação a realizar operações, como o envio de e-mails, de forma segura e controlada. 
 
Quando um aplicativo envia e-mails usando OAuth, ele primeiro solicita a autorização do usuário para acessar sua conta de e-mail. Uma vez autorizado, o aplicativo recebe um token de acesso, que pode ser usado para autenticar futuras requisições, como o envio de e-mails. Este método é amplamente adotado por provedores de e-mail como Google (Gmail), Microsoft (Outlook), e outros, por oferecer maior segurança, pois reduz o risco de comprometimento de senhas e permite que os usuários revoguem o acesso a qualquer momento.
</blockquote>

===Envio de e-mail via Office 365===
:O envio de e-mails pelo CIGAM via 'Office 365' deve ser autenticado usando as credenciais do OAuth 2.0. Essa funcionalidade requer a criação e utilização de um token de autorização, que deve ser gerado através da console de administração do Office 365 - [[Como configurar autenticação Office 365 OAuth 2.0]]. Este token garante acesso seguro e permite que o CIGAM envie e-mails em nome do usuário sem a necessidade de expor senhas, aumentando a segurança no processo de comunicação.

'''As configurações do sistema CIGAM envolvidas são:''' 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção: '''OAuth'''

* [[GE - AM - 3233 - OAuth para envio de e-mail]]
** Opção: Informar o Id do cadastro da parametrização desejada
::::Cadastro de parâmetros OAuth
:::::001.1 - Office 365 OAuth 2.0

* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.

* [[GE - AM - 3074 - E-mail do sistema]]

* [[GE - AM - 3075 - Senha do e-mail do sistema]]

* [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]

* [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

:'''Importante:''' A autenticação será realizada sempre com base no remetente do e-mail, que pode variar conforme a rotina utilizada.

===Envio de e-mail com OAuth utilizando o SendGrid===
:O '''SendGrid''' é uma plataforma de envio de e-mails, desenvolvida por terceiros, que atua como intermediário entre uma aplicação e os servidores de e-mail dos destinatários. Essa plataforma oferece recursos como autenticação, monitoramento e alta entregabilidade, e pode ser integrada a aplicações utilizando autenticação via protocolo OAuth para acessar suas APIs. Veja [[GE - Como Fazer - Como integrar o SendGrid|como integrar o SendGrid]].

Antes de iniciar as parametrizações, é necessário realizar o download dos arquivos conforme link abaixo e colocá-los no local da instalação do CIGAM, dentro da pasta 'Cab\Exclusivo'. Exemplo: %CIGAM_INSTAL%\Cab\Exclusivo\EnvioEmailCustomizado\. 
Clique para baixar o pacote de arquivos [https://www.cigam.com.br/wiki/images/a/a2/EnvioEmailCustomizado.zip EnvioEmailCustomizado.zip].

'''As parametrizações do sistema CIGAM envolvidas são:''' 
:'''Adição de nomes lógicos no arquivo MAGIC.INI ou Adendo''':
::Os nomes lógicos a seguir devem ser adicionados na sessão [MAGIC_LOGICAL_NAMES]
:::EX_CK02176TSI = S
:::EX_CK02176TSICabPrg = EE00003
:::EX_CK02176TSICab = *%CIGAM_INSTAL%Cab\Exclusivo\EnvioEmailCustomizado\Cab\EnvioEmailCustomizado.ecf
:::EX_SENDGRID_APIKEY =
:::EX_EMAIL_CUSTOMIZADO = S

IMPORTANTE: na tradução do nome lógico EX_SENDGRID_APIKEY deve ser informada a chave conforme a parametrização do SendGrid realizada pelo cliente. Veja [[GE - Como Fazer - Como integrar o SendGrid|como integrar o SendGrid]].

{{VoltarInicio}}

== Como utilizar ferramentas que necessitam de senhas com mais de 30 caracteres? ==
A utilização de um servidor de relay de e-mail (SMTP Relay) para envio de e-mails é uma solução eficaz em cenários nos quais é necessário lidar com serviços que requerem senhas longas, como o SendGrid ou Amazon Web Services (AWS). Isso pode ser especialmente útil quando se lida com autenticações complexas ou senhas/tokens longos para serviços de e-mail ou outros serviços que utilizam e-mail para comunicação. 
#'''Autenticação pelo SMTP Relay:''' Ao configurar um servidor de relay de e-mail, o servidor assume a responsabilidade de autenticar-se com o serviço de e-mail (por exemplo, SendGrid ou AWS) em nome do sistema que está enviando os e-mails (neste caso, o CIGAM). Isso significa que o CIGAM não precisa lidar diretamente com senhas/tokens longos, tornando a autenticação mais segura e gerenciável.
#'''Implementação:''' A implementação de um servidor de relay de e-mail é responsabilidade do departamento de TI do cliente ou de uma empresa de TI terceirizada, se for esse o caso. A configuração envolve definir as credenciais de autenticação para o serviço de relay, configurar as regras de envio de e-mail e direcionar o CIGAM para usar o servidor de relay.
#'''Considerações de Segurança:''' Certifique-se de que o servidor de relay de e-mail seja adequadamente seguro e mantenha as boas práticas de segurança para proteger as credenciais armazenadas. Além disso, considere a implementação de autenticação em dois fatores (2FA) para aumentar a segurança.

= Envio de e-mail usuários externos =
<ref group="Versão 220404.c"> Liberado a partir da OS 373456/391. </ref> Os e-mails a serem enviados via portais respeitam as mesmas configurações aplicadas diretamente no desktop, os usuários sempre devem possuir um cadastro no CIGAM e seu e-mail no cadastro de usuários. 
* Para que seja possível o envio de e-mail para usuários externos deve ter as seguintes parametrizações: 
** Ter configurado no sistema o envio de e-mail conforme orientações acima
** Informação na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] se optar por não informar a senha de e-mail a cada acesso ao portal.
Sendo assim onde existir a implementação da funcionalidade, caso a configuração: [[GE - AM - 904 - Senha para login no servidor de e-mail]] não conste informada para o usuário será exibida uma tela para que seja possível indicar a senha para login no servidor de e-mail e consequentemente fazer o envio. Essas informações serão aplicadas até o próximo acesso sem necessidade de informar novamente.
{{VoltarInicio}}

=Manuais Referenciados=
*[[Configurações e parametrizações para envio de e-mail através do Cigam]]

= Versão 220404 =
=== Patch "c" ===
<references group="Versão 220404.c"/>
= Versão 221107 =
=== Patch "c" ===
<references group="Versão 221107.c"/>
= Versão 241007 =
<references group="Versão 241007"/>

GE - Como Fazer - Configuração de Envio de E-mail no CIGAM

2025-02-12T14:59:53Z

Alessandro.voto: /* Envio de e-mail com OAuth utilizando o SendGrid */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM|Configuração de Envio de E-mail no CIGAM]]



= Configuração de envio e email pelo Sistema CIGAM =
O uso de envio de e-mail pelo Sistema Cigam requer informações fornecidas pelo cliente, parametrizações de máquina e configurações de sistema para o correto funcionamento. 

== Quais são as informações de Envio de E-mail para parametrização?==
As informações são geralmente repassadas pelo próprio cliente ou sua T.I. As informações são: 
⦁ Qual é o servidor de e-mail e respectiva porta? 
⦁ Qual é a conta de e-mail do usuário? 
⦁ Qual é a senha de e-mail do usuário? 
⦁ É utilizado algum método de segurança, como SSL (Secure Sockets Layer)? 

== Quais as parametrizações de Envio de E-mail de máquina? ==
O Framework .Net precisa estar devidamente instalado e com suas permissões. Para saber como parametrizar o .Net verificar o documento “[[GE - Como Fazer - Instalação do .Net|Como Fazer - Instalação do .Net]]”. 
{{VoltarInicio}}

== Quais são as configurações para parametrizar o envio de e-mail pelo CIGAM? ==
*As configurações do sistema CIGAM envolvidas são: 
** [[GE - AM - 338 - Opção para envio de e-mail]] 
** [[GE - AM - 545 - Auto-assinatura a ser anexada no envio de e-mail]]
** [[GE - AM - 692 - Servidor de e-mail]]
** [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** [[GE - AM - 1495 - Solicitar confirmação de leitura para e-mails enviados]]
** [[GE - AM - 2077 - Não enviar cópia para o remetente do e-mail]]
** [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]
** [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

== Qual é o cadastro a ser feito? ==
Para o envio de e-mail, é necessário existir um cadastro do usuário sendo opcional a informação do e-mail vinculado a ele. 
<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref> Caso conste informado e-mail no cadastro, esse será considerado somente se a configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] não constar informada. 
Para ser possível o envio de e-mail é necessário que uma das opções conste com o usuário para o login do servidor de e-mail. Seja ele a configuração ou o cadastro de usuário, quando informado nas duas opções acima mencionadas, será respeitado sempre o que estiver informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]]. 
 
O cadastro de usuário e seu e-mail (opcional) é feito através do programa Usuários - Grupos e Direitos
*Utilidades / Diversos
**Parâmetros
***Usuários
****Usuário - Grupos Direitos 

É possível além do e-mail (opcional), informar a Unidade de Negócio (opcional) caso queira reforçar a unidade que pertence o usuário. 
 
Após realizado o cadastro ou eventual modificação, o ajuste só será validado na próxima sessão para isso preciso sair do sistema e entrar novamente para carregar as parametrizações ou então acessar a área onde consta o perfil do usuário e clicar na opção Carregar Parâmetros.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção SmtpClient? ==
SMTP - (Protocolo de Transferência de Correio Simples é o protocolo padrão de envio de mensagens de correio eletrônico através da Internet entre dois dispositivos computacionais). 
Para que seja possível o envio de email via SmtpClient é necessário ter as seguintes configurações parametrizadas:
* E-mail informado no cadastro do usuário 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''SmtpClient'''
* [[GE - AM - 692 - Servidor de e-mail]]
** Indicado o servidor de e-mail seguido por ‘:’ e a porta liberada para envio de e-mail. 
**Se não informado o número da porta o sistema irá realizar o envio de e-mail pela porta padrão: 25 correspondente aos e-mails que serão utilizados para o envio. 
**Para obter as informações servidor e porta para envio de e-mail acesse uma ferramenta de envio de e-mail que esteja configurada (Ex.: Outlook) e busque pelas informações nas propriedades da conta. 
* [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** Opcional deixar a senha já informada para envio direto do e-mail, caso não seja informada pedirá a senha na hora do envio.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada quando o servidor de envio de e-mail utilizado exigir o usuário + o domínio completo para a autenticação (Ex: conta@dominio.com.br). Quando essa configuração estiver desmarcada só será considerado o informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] ou no cadastro de usuário até o caractere @.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP

* '''IMPORTANTE:''' A partir de 30 de maio de 2022, alguns servidores não autorizaram mais o uso de apps ou dispositivos de terceiros que exigem apenas nome de usuário e senha para fazer login na conta, sendo assim indicamos a aplicação da verificação em duas etapas nas contas a serem utilizadas e a utilização de senhas de app, sendo obrigatória para acesso do email no CIGAM a utilização da senha de app. 
* Ao aplicar a senha de APP no CIGAM não será exigido autenticação em duas etapas devido a composição da senha fornecida pelo provedor basta informar ela na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou individualmente a cada envio que esse ocorrerá normalmente. 
** Para configuração de senhas de app consulte a documentação do seu servidor de e-mail, procurando por '''senhas de APP''' ou '''gerenciamento de senhas de APP''', ou siga as informações abaixo.

{{VoltarInicio}}

=== Como criar uma senha de aplicativo ===
====Senha de aplicativo Gmail====
Ao seguir esses passos, você poderá configurar corretamente uma senha de aplicativo no Gmail para ser utilizada com o CIGAM, garantindo que o envio de e-mails via SMTP funcione adequadamente sem a necessidade de usar sua senha principal da conta do Google. 
 
Para configurar uma senha de aplicativo no Gmail, especialmente quando você está utilizando o servidor de envio SMTP e a opção está informada como SmtpClient na configuração [[GE - AM - 338 - Opção para envio de e-mail]], acesse [https://support.google.com/accounts/answer/185833?hl=pt-BR Criar e usar senhas de app] e siga os passos. 
 
Ao acessar, deverá ser informado para qual tipo de app será utilizado, neste caso será "E-mail" e posteriormente será informado para qual tipo de dispositivo.
 
[[Image: envioemailCigam5.png|550px|centro]]
 
Ao clicar em gerar, será gerada uma senha para o dispositivo. Acesse o menu [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Configurações|Configurações]] para informar na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] a senha gerada.
 
[[Image: envioemailCigam6.png|550px|centro]]

====Senha de aplicativo Outlook====
Servidor de envios Office365, será necessário habilitar a Senha de Aplicativo: 
[https://account.live.com/proofs/manage/additional?mkt=pt-BR&refd=account.microsoft.com&refp=security Acesso direto conta Pessoal] 
[https://mysignins.microsoft.com/security-info Acesso diretor conta Profissional - Administrado por Exchange]
 
[[Image: envioemailCigam12.png|750px|centro]]
 
Inserir uma validação com: E-mail ou Telefone:
 
[[Image: envioemailCigam13.png|300px|centro]]
 
Ativar a verificação em duas etapas:
 
[[Image: envioemailCigam14.png|750px|centro]]
 
Após ativar, irá aparecer a opção Senha de Aplicativo, sendo necessária a criação e inserção na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]].
 
[[Image: envioemailCigam15.png|750px|centro]]
 
Caso a Senha de Aplicativo não esteja habilitada, será necessário ativar a Autenticação Multifator(MFA) dentro do [https://admin.exchange.microsoft.com Exchange do Office365].
 
[[Image: envioemailCigam9.png|750px|centro]]
 
Deve-se verificar se a autenticação SMTP está ativa. Somente o Administrador poderá verificar.
 
[[Image: envioemailCigam7.png|350px|centro]]
{{VoltarInicio}}

====Validação Kinghost====
O provedor Kinghost quando utilizado em ambiente nuvem como: FWC ou Nuvem CIGAM, necessitam que seja realizada a parametrização do SMTPI no provedor, assim como o ajuste do SMTP no CIGAM. 
 
[https://king.host/wiki/artigo/como-ativar-o-smtp-internacional/ Como ativar SMTPI Kinghost]

== Como configurar para utilização de envio através da opção Gmail API? ==
Gmail API - (Para usuários do Gmail, a API do Gmail é a melhor opção para acesso autorizado aos dados do Gmail de um usuário. Isso não armazena nenhum dos e-mails no banco de dados de terceiros, proporcionando mais segurança e privacidade aos seus e-mails. A API do Gmail é usada para interagir com as caixas de entrada e configurações do Gmail dos usuários e oferece suporte a várias linguagens de programação populares). 
 
O envio de email via CIGAM através do Gmail API devem ser autorizadas via credenciais do OAuth 2.0. 
Essa funcionalidade exige a utilização de um token de autorização de acesso ao qual deve ser criado através da console de APIs Google - '''[[https://support.google.com/googleapi/answer/6158849/?hl=en&authuser=1| Configurando o OAuth 2.0]]'''.

*As configurações do sistema CIGAM envolvidas são: 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''Gmail API'''
* [[GE - AM - 692 - Servidor de e-mail]]
** smtp.gmail.com:587 
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]
**Pressione F5 e na tela de Cadastro de credenciais, informe o conteúdo do arquivo feito download anteriormente ou clique em ‘Importar’ conforme a configuração feita para obter o token de autorização via console de APIs Google e confirme.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada para o funcionamento do envio via Gmail API
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via Gmail API

* '''Importante:''' Caso não haja informação nas configurações necessárias para validar credenciais, ao enviar o e-mail será aberta uma tela para colocar as informações necessárias.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção OAuth? ==
A partir da <ref group="Versão 241007">Liberado a partir da OS 373456/716.</ref>, a configuração [[GE - AM - 338 - Opção para envio de e-mail]] agora inclui a possibilidade de enviar e-mails utilizando o protocolo OAuth.
:'''OAuth''' refere-se ao processo de envio de e-mails em que a autenticação é feita utilizando o protocolo OAuth (Open Authorization). 
<blockquote>
OAuth é um padrão de autorização que permite que aplicativos acessem recursos, como contas de e-mail, em nome de um usuário, sem precisar saber a senha do usuário. Em vez disso, OAuth utiliza tokens de acesso temporários que autorizam a aplicação a realizar operações, como o envio de e-mails, de forma segura e controlada. 
 
Quando um aplicativo envia e-mails usando OAuth, ele primeiro solicita a autorização do usuário para acessar sua conta de e-mail. Uma vez autorizado, o aplicativo recebe um token de acesso, que pode ser usado para autenticar futuras requisições, como o envio de e-mails. Este método é amplamente adotado por provedores de e-mail como Google (Gmail), Microsoft (Outlook), e outros, por oferecer maior segurança, pois reduz o risco de comprometimento de senhas e permite que os usuários revoguem o acesso a qualquer momento.
</blockquote>

===Envio de e-mail via Office 365===
:O envio de e-mails pelo CIGAM via 'Office 365' deve ser autenticado usando as credenciais do OAuth 2.0. Essa funcionalidade requer a criação e utilização de um token de autorização, que deve ser gerado através da console de administração do Office 365 - [[Como configurar autenticação Office 365 OAuth 2.0]]. Este token garante acesso seguro e permite que o CIGAM envie e-mails em nome do usuário sem a necessidade de expor senhas, aumentando a segurança no processo de comunicação.

'''As configurações do sistema CIGAM envolvidas são:''' 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção: '''OAuth'''

* [[GE - AM - 3233 - OAuth para envio de e-mail]]
** Opção: Informar o Id do cadastro da parametrização desejada
::::Cadastro de parâmetros OAuth
:::::001.1 - Office 365 OAuth 2.0

* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.

* [[GE - AM - 3074 - E-mail do sistema]]

* [[GE - AM - 3075 - Senha do e-mail do sistema]]

* [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]

* [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

:'''Importante:''' A autenticação será realizada sempre com base no remetente do e-mail, que pode variar conforme a rotina utilizada.

===Envio de e-mail com OAuth utilizando o SendGrid===
:O '''SendGrid''' é uma plataforma de envio de e-mails, desenvolvida por terceiros, que atua como intermediário entre uma aplicação e os servidores de e-mail dos destinatários. Essa plataforma oferece recursos como autenticação, monitoramento e alta entregabilidade, e pode ser integrada a aplicações utilizando autenticação via protocolo OAuth para acessar suas APIs. Veja [[GE - Como Fazer - Como integrar o SendGrid|como integrar o SendGrid]].

Antes de iniciar as parametrizações, é necessário realizar o download dos arquivos conforme link abaixo e colocá-los no local da instalação do CIGAM, dentro da pasta 'Cab\Exclusivo'. Exemplo: %CIGAM_INSTAL%\Cab\Exclusivo\EnvioEmailCustomizado\. 
Clique para baixar o pacote de arquivos [https://www.cigam.com.br/wiki/images/a/a2/EnvioEmailCustomizado.zip EnvioEmailCustomizado.zip].

'''As parametrizações do sistema CIGAM envolvidas são:''' 
:'''Adição de nomes lógicos no arquivo MAGIC.INI ou Adendo''':
::Os nomes lógicos a seguir devem ser adicionados na sessão [MAGIC_LOGICAL_NAMES]
:::EX_CK02176TSI = S
:::EX_CK02176TSICabPrg = EE00003
:::EX_CK02176TSICab = *%CIGAM_INSTAL%Cab\Exclusivo\EnvioEmailCustomizado\Cab\EnvioEmailCustomizado.ecf
:::EX_SENDGRID_APIKEY =
:::EX_EMAIL_CUSTOMIZADO = S

IMPORTANTE: na tradução do nome lógico EX_SENDGRID_APIKEY deve ser informada a chave conforme a parametrização do SendGrid realizada pelo cliente.

{{VoltarInicio}}

== Como utilizar ferramentas que necessitam de senhas com mais de 30 caracteres? ==
A utilização de um servidor de relay de e-mail (SMTP Relay) para envio de e-mails é uma solução eficaz em cenários nos quais é necessário lidar com serviços que requerem senhas longas, como o SendGrid ou Amazon Web Services (AWS). Isso pode ser especialmente útil quando se lida com autenticações complexas ou senhas/tokens longos para serviços de e-mail ou outros serviços que utilizam e-mail para comunicação. 
#'''Autenticação pelo SMTP Relay:''' Ao configurar um servidor de relay de e-mail, o servidor assume a responsabilidade de autenticar-se com o serviço de e-mail (por exemplo, SendGrid ou AWS) em nome do sistema que está enviando os e-mails (neste caso, o CIGAM). Isso significa que o CIGAM não precisa lidar diretamente com senhas/tokens longos, tornando a autenticação mais segura e gerenciável.
#'''Implementação:''' A implementação de um servidor de relay de e-mail é responsabilidade do departamento de TI do cliente ou de uma empresa de TI terceirizada, se for esse o caso. A configuração envolve definir as credenciais de autenticação para o serviço de relay, configurar as regras de envio de e-mail e direcionar o CIGAM para usar o servidor de relay.
#'''Considerações de Segurança:''' Certifique-se de que o servidor de relay de e-mail seja adequadamente seguro e mantenha as boas práticas de segurança para proteger as credenciais armazenadas. Além disso, considere a implementação de autenticação em dois fatores (2FA) para aumentar a segurança.

= Envio de e-mail usuários externos =
<ref group="Versão 220404.c"> Liberado a partir da OS 373456/391. </ref> Os e-mails a serem enviados via portais respeitam as mesmas configurações aplicadas diretamente no desktop, os usuários sempre devem possuir um cadastro no CIGAM e seu e-mail no cadastro de usuários. 
* Para que seja possível o envio de e-mail para usuários externos deve ter as seguintes parametrizações: 
** Ter configurado no sistema o envio de e-mail conforme orientações acima
** Informação na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] se optar por não informar a senha de e-mail a cada acesso ao portal.
Sendo assim onde existir a implementação da funcionalidade, caso a configuração: [[GE - AM - 904 - Senha para login no servidor de e-mail]] não conste informada para o usuário será exibida uma tela para que seja possível indicar a senha para login no servidor de e-mail e consequentemente fazer o envio. Essas informações serão aplicadas até o próximo acesso sem necessidade de informar novamente.
{{VoltarInicio}}

=Manuais Referenciados=
*[[Configurações e parametrizações para envio de e-mail através do Cigam]]

= Versão 220404 =
=== Patch "c" ===
<references group="Versão 220404.c"/>
= Versão 221107 =
=== Patch "c" ===
<references group="Versão 221107.c"/>
= Versão 241007 =
<references group="Versão 241007"/>

GE - Como Fazer - Configuração de Envio de E-mail no CIGAM

2025-02-12T14:43:00Z

Alessandro.voto: /* Envio de e-mail com OAuth utilizando o SendGrid */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM|Configuração de Envio de E-mail no CIGAM]]



= Configuração de envio e email pelo Sistema CIGAM =
O uso de envio de e-mail pelo Sistema Cigam requer informações fornecidas pelo cliente, parametrizações de máquina e configurações de sistema para o correto funcionamento. 

== Quais são as informações de Envio de E-mail para parametrização?==
As informações são geralmente repassadas pelo próprio cliente ou sua T.I. As informações são: 
⦁ Qual é o servidor de e-mail e respectiva porta? 
⦁ Qual é a conta de e-mail do usuário? 
⦁ Qual é a senha de e-mail do usuário? 
⦁ É utilizado algum método de segurança, como SSL (Secure Sockets Layer)? 

== Quais as parametrizações de Envio de E-mail de máquina? ==
O Framework .Net precisa estar devidamente instalado e com suas permissões. Para saber como parametrizar o .Net verificar o documento “[[GE - Como Fazer - Instalação do .Net|Como Fazer - Instalação do .Net]]”. 
{{VoltarInicio}}

== Quais são as configurações para parametrizar o envio de e-mail pelo CIGAM? ==
*As configurações do sistema CIGAM envolvidas são: 
** [[GE - AM - 338 - Opção para envio de e-mail]] 
** [[GE - AM - 545 - Auto-assinatura a ser anexada no envio de e-mail]]
** [[GE - AM - 692 - Servidor de e-mail]]
** [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** [[GE - AM - 1495 - Solicitar confirmação de leitura para e-mails enviados]]
** [[GE - AM - 2077 - Não enviar cópia para o remetente do e-mail]]
** [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]
** [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

== Qual é o cadastro a ser feito? ==
Para o envio de e-mail, é necessário existir um cadastro do usuário sendo opcional a informação do e-mail vinculado a ele. 
<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref> Caso conste informado e-mail no cadastro, esse será considerado somente se a configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] não constar informada. 
Para ser possível o envio de e-mail é necessário que uma das opções conste com o usuário para o login do servidor de e-mail. Seja ele a configuração ou o cadastro de usuário, quando informado nas duas opções acima mencionadas, será respeitado sempre o que estiver informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]]. 
 
O cadastro de usuário e seu e-mail (opcional) é feito através do programa Usuários - Grupos e Direitos
*Utilidades / Diversos
**Parâmetros
***Usuários
****Usuário - Grupos Direitos 

É possível além do e-mail (opcional), informar a Unidade de Negócio (opcional) caso queira reforçar a unidade que pertence o usuário. 
 
Após realizado o cadastro ou eventual modificação, o ajuste só será validado na próxima sessão para isso preciso sair do sistema e entrar novamente para carregar as parametrizações ou então acessar a área onde consta o perfil do usuário e clicar na opção Carregar Parâmetros.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção SmtpClient? ==
SMTP - (Protocolo de Transferência de Correio Simples é o protocolo padrão de envio de mensagens de correio eletrônico através da Internet entre dois dispositivos computacionais). 
Para que seja possível o envio de email via SmtpClient é necessário ter as seguintes configurações parametrizadas:
* E-mail informado no cadastro do usuário 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''SmtpClient'''
* [[GE - AM - 692 - Servidor de e-mail]]
** Indicado o servidor de e-mail seguido por ‘:’ e a porta liberada para envio de e-mail. 
**Se não informado o número da porta o sistema irá realizar o envio de e-mail pela porta padrão: 25 correspondente aos e-mails que serão utilizados para o envio. 
**Para obter as informações servidor e porta para envio de e-mail acesse uma ferramenta de envio de e-mail que esteja configurada (Ex.: Outlook) e busque pelas informações nas propriedades da conta. 
* [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** Opcional deixar a senha já informada para envio direto do e-mail, caso não seja informada pedirá a senha na hora do envio.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada quando o servidor de envio de e-mail utilizado exigir o usuário + o domínio completo para a autenticação (Ex: conta@dominio.com.br). Quando essa configuração estiver desmarcada só será considerado o informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] ou no cadastro de usuário até o caractere @.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP

* '''IMPORTANTE:''' A partir de 30 de maio de 2022, alguns servidores não autorizaram mais o uso de apps ou dispositivos de terceiros que exigem apenas nome de usuário e senha para fazer login na conta, sendo assim indicamos a aplicação da verificação em duas etapas nas contas a serem utilizadas e a utilização de senhas de app, sendo obrigatória para acesso do email no CIGAM a utilização da senha de app. 
* Ao aplicar a senha de APP no CIGAM não será exigido autenticação em duas etapas devido a composição da senha fornecida pelo provedor basta informar ela na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou individualmente a cada envio que esse ocorrerá normalmente. 
** Para configuração de senhas de app consulte a documentação do seu servidor de e-mail, procurando por '''senhas de APP''' ou '''gerenciamento de senhas de APP''', ou siga as informações abaixo.

{{VoltarInicio}}

=== Como criar uma senha de aplicativo ===
====Senha de aplicativo Gmail====
Ao seguir esses passos, você poderá configurar corretamente uma senha de aplicativo no Gmail para ser utilizada com o CIGAM, garantindo que o envio de e-mails via SMTP funcione adequadamente sem a necessidade de usar sua senha principal da conta do Google. 
 
Para configurar uma senha de aplicativo no Gmail, especialmente quando você está utilizando o servidor de envio SMTP e a opção está informada como SmtpClient na configuração [[GE - AM - 338 - Opção para envio de e-mail]], acesse [https://support.google.com/accounts/answer/185833?hl=pt-BR Criar e usar senhas de app] e siga os passos. 
 
Ao acessar, deverá ser informado para qual tipo de app será utilizado, neste caso será "E-mail" e posteriormente será informado para qual tipo de dispositivo.
 
[[Image: envioemailCigam5.png|550px|centro]]
 
Ao clicar em gerar, será gerada uma senha para o dispositivo. Acesse o menu [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Configurações|Configurações]] para informar na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] a senha gerada.
 
[[Image: envioemailCigam6.png|550px|centro]]

====Senha de aplicativo Outlook====
Servidor de envios Office365, será necessário habilitar a Senha de Aplicativo: 
[https://account.live.com/proofs/manage/additional?mkt=pt-BR&refd=account.microsoft.com&refp=security Acesso direto conta Pessoal] 
[https://mysignins.microsoft.com/security-info Acesso diretor conta Profissional - Administrado por Exchange]
 
[[Image: envioemailCigam12.png|750px|centro]]
 
Inserir uma validação com: E-mail ou Telefone:
 
[[Image: envioemailCigam13.png|300px|centro]]
 
Ativar a verificação em duas etapas:
 
[[Image: envioemailCigam14.png|750px|centro]]
 
Após ativar, irá aparecer a opção Senha de Aplicativo, sendo necessária a criação e inserção na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]].
 
[[Image: envioemailCigam15.png|750px|centro]]
 
Caso a Senha de Aplicativo não esteja habilitada, será necessário ativar a Autenticação Multifator(MFA) dentro do [https://admin.exchange.microsoft.com Exchange do Office365].
 
[[Image: envioemailCigam9.png|750px|centro]]
 
Deve-se verificar se a autenticação SMTP está ativa. Somente o Administrador poderá verificar.
 
[[Image: envioemailCigam7.png|350px|centro]]
{{VoltarInicio}}

====Validação Kinghost====
O provedor Kinghost quando utilizado em ambiente nuvem como: FWC ou Nuvem CIGAM, necessitam que seja realizada a parametrização do SMTPI no provedor, assim como o ajuste do SMTP no CIGAM. 
 
[https://king.host/wiki/artigo/como-ativar-o-smtp-internacional/ Como ativar SMTPI Kinghost]

== Como configurar para utilização de envio através da opção Gmail API? ==
Gmail API - (Para usuários do Gmail, a API do Gmail é a melhor opção para acesso autorizado aos dados do Gmail de um usuário. Isso não armazena nenhum dos e-mails no banco de dados de terceiros, proporcionando mais segurança e privacidade aos seus e-mails. A API do Gmail é usada para interagir com as caixas de entrada e configurações do Gmail dos usuários e oferece suporte a várias linguagens de programação populares). 
 
O envio de email via CIGAM através do Gmail API devem ser autorizadas via credenciais do OAuth 2.0. 
Essa funcionalidade exige a utilização de um token de autorização de acesso ao qual deve ser criado através da console de APIs Google - '''[[https://support.google.com/googleapi/answer/6158849/?hl=en&authuser=1| Configurando o OAuth 2.0]]'''.

*As configurações do sistema CIGAM envolvidas são: 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''Gmail API'''
* [[GE - AM - 692 - Servidor de e-mail]]
** smtp.gmail.com:587 
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]
**Pressione F5 e na tela de Cadastro de credenciais, informe o conteúdo do arquivo feito download anteriormente ou clique em ‘Importar’ conforme a configuração feita para obter o token de autorização via console de APIs Google e confirme.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada para o funcionamento do envio via Gmail API
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via Gmail API

* '''Importante:''' Caso não haja informação nas configurações necessárias para validar credenciais, ao enviar o e-mail será aberta uma tela para colocar as informações necessárias.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção OAuth? ==
A partir da <ref group="Versão 241007">Liberado a partir da OS 373456/716.</ref>, a configuração [[GE - AM - 338 - Opção para envio de e-mail]] agora inclui a possibilidade de enviar e-mails utilizando o protocolo OAuth.
:'''OAuth''' refere-se ao processo de envio de e-mails em que a autenticação é feita utilizando o protocolo OAuth (Open Authorization). 
<blockquote>
OAuth é um padrão de autorização que permite que aplicativos acessem recursos, como contas de e-mail, em nome de um usuário, sem precisar saber a senha do usuário. Em vez disso, OAuth utiliza tokens de acesso temporários que autorizam a aplicação a realizar operações, como o envio de e-mails, de forma segura e controlada. 
 
Quando um aplicativo envia e-mails usando OAuth, ele primeiro solicita a autorização do usuário para acessar sua conta de e-mail. Uma vez autorizado, o aplicativo recebe um token de acesso, que pode ser usado para autenticar futuras requisições, como o envio de e-mails. Este método é amplamente adotado por provedores de e-mail como Google (Gmail), Microsoft (Outlook), e outros, por oferecer maior segurança, pois reduz o risco de comprometimento de senhas e permite que os usuários revoguem o acesso a qualquer momento.
</blockquote>

===Envio de e-mail via Office 365===
:O envio de e-mails pelo CIGAM via 'Office 365' deve ser autenticado usando as credenciais do OAuth 2.0. Essa funcionalidade requer a criação e utilização de um token de autorização, que deve ser gerado através da console de administração do Office 365 - [[Como configurar autenticação Office 365 OAuth 2.0]]. Este token garante acesso seguro e permite que o CIGAM envie e-mails em nome do usuário sem a necessidade de expor senhas, aumentando a segurança no processo de comunicação.

'''As configurações do sistema CIGAM envolvidas são:''' 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção: '''OAuth'''

* [[GE - AM - 3233 - OAuth para envio de e-mail]]
** Opção: Informar o Id do cadastro da parametrização desejada
::::Cadastro de parâmetros OAuth
:::::001.1 - Office 365 OAuth 2.0

* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.

* [[GE - AM - 3074 - E-mail do sistema]]

* [[GE - AM - 3075 - Senha do e-mail do sistema]]

* [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]

* [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

:'''Importante:''' A autenticação será realizada sempre com base no remetente do e-mail, que pode variar conforme a rotina utilizada.

===Envio de e-mail com OAuth utilizando o SendGrid===
:O '''SendGrid''' é uma plataforma de envio de e-mails, desenvolvida por terceiros, que atua como intermediário entre uma aplicação e os servidores de e-mail dos destinatários. Essa plataforma oferece recursos como autenticação, monitoramento e alta entregabilidade, e pode ser integrada a aplicações utilizando autenticação via protocolo OAuth para acessar suas APIs. Veja [[GE - Como Fazer - Como integrar o SendGrid|como integrar o SendGrid]].

Antes de iniciar as parametrizações, é necessário realizar o download dos arquivos conforme link abaixo e colocá-los no local da instalação do CIGAM, dentro da pasta 'Cab\Exclusivo'. Exemplo: %CIGAM_INSTAL%\Cab\Exclusivo\EnvioEmailCustomizado\. 
Clique para baixar o pacote de arquivos [https://www.cigam.com.br/wiki/images/a/a2/EnvioEmailCustomizado.zip EnvioEmailCustomizado.zip].

'''As parametrizações do sistema CIGAM envolvidas são:''' 
:1. '''Disponibilizar os arquivos '''

:2. '''Adição de nomes lógicos no arquivo .ini ou adendo''':
::Inclua as configurações abaixo no arquivo .ini correspondente:
:::[MAGIC_LOGICAL_NAMES]
:::EX_CK02176TSI = S
:::EX_CK02176TSICabPrg = EE00003
:::EX_CK02176TSICab = *%CIGAM_INSTAL%Cab\Exclusivo\EnvioEmailCustomizado\Cab\EnvioEmailCustomizado.ecf
:::EX_SENDGRID_APIKEY = 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
:::EX_EMAIL_CUSTOMIZADO = S
{{VoltarInicio}}

== Como utilizar ferramentas que necessitam de senhas com mais de 30 caracteres? ==
A utilização de um servidor de relay de e-mail (SMTP Relay) para envio de e-mails é uma solução eficaz em cenários nos quais é necessário lidar com serviços que requerem senhas longas, como o SendGrid ou Amazon Web Services (AWS). Isso pode ser especialmente útil quando se lida com autenticações complexas ou senhas/tokens longos para serviços de e-mail ou outros serviços que utilizam e-mail para comunicação. 
#'''Autenticação pelo SMTP Relay:''' Ao configurar um servidor de relay de e-mail, o servidor assume a responsabilidade de autenticar-se com o serviço de e-mail (por exemplo, SendGrid ou AWS) em nome do sistema que está enviando os e-mails (neste caso, o CIGAM). Isso significa que o CIGAM não precisa lidar diretamente com senhas/tokens longos, tornando a autenticação mais segura e gerenciável.
#'''Implementação:''' A implementação de um servidor de relay de e-mail é responsabilidade do departamento de TI do cliente ou de uma empresa de TI terceirizada, se for esse o caso. A configuração envolve definir as credenciais de autenticação para o serviço de relay, configurar as regras de envio de e-mail e direcionar o CIGAM para usar o servidor de relay.
#'''Considerações de Segurança:''' Certifique-se de que o servidor de relay de e-mail seja adequadamente seguro e mantenha as boas práticas de segurança para proteger as credenciais armazenadas. Além disso, considere a implementação de autenticação em dois fatores (2FA) para aumentar a segurança.

= Envio de e-mail usuários externos =
<ref group="Versão 220404.c"> Liberado a partir da OS 373456/391. </ref> Os e-mails a serem enviados via portais respeitam as mesmas configurações aplicadas diretamente no desktop, os usuários sempre devem possuir um cadastro no CIGAM e seu e-mail no cadastro de usuários. 
* Para que seja possível o envio de e-mail para usuários externos deve ter as seguintes parametrizações: 
** Ter configurado no sistema o envio de e-mail conforme orientações acima
** Informação na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] se optar por não informar a senha de e-mail a cada acesso ao portal.
Sendo assim onde existir a implementação da funcionalidade, caso a configuração: [[GE - AM - 904 - Senha para login no servidor de e-mail]] não conste informada para o usuário será exibida uma tela para que seja possível indicar a senha para login no servidor de e-mail e consequentemente fazer o envio. Essas informações serão aplicadas até o próximo acesso sem necessidade de informar novamente.
{{VoltarInicio}}

=Manuais Referenciados=
*[[Configurações e parametrizações para envio de e-mail através do Cigam]]

= Versão 220404 =
=== Patch "c" ===
<references group="Versão 220404.c"/>
= Versão 221107 =
=== Patch "c" ===
<references group="Versão 221107.c"/>
= Versão 241007 =
<references group="Versão 241007"/>

GE - Como Fazer - Configuração de Envio de E-mail no CIGAM

2025-02-12T14:42:36Z

Alessandro.voto: /* Envio de e-mail com OAuth utilizando o SendGrid */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM|Configuração de Envio de E-mail no CIGAM]]



= Configuração de envio e email pelo Sistema CIGAM =
O uso de envio de e-mail pelo Sistema Cigam requer informações fornecidas pelo cliente, parametrizações de máquina e configurações de sistema para o correto funcionamento. 

== Quais são as informações de Envio de E-mail para parametrização?==
As informações são geralmente repassadas pelo próprio cliente ou sua T.I. As informações são: 
⦁ Qual é o servidor de e-mail e respectiva porta? 
⦁ Qual é a conta de e-mail do usuário? 
⦁ Qual é a senha de e-mail do usuário? 
⦁ É utilizado algum método de segurança, como SSL (Secure Sockets Layer)? 

== Quais as parametrizações de Envio de E-mail de máquina? ==
O Framework .Net precisa estar devidamente instalado e com suas permissões. Para saber como parametrizar o .Net verificar o documento “[[GE - Como Fazer - Instalação do .Net|Como Fazer - Instalação do .Net]]”. 
{{VoltarInicio}}

== Quais são as configurações para parametrizar o envio de e-mail pelo CIGAM? ==
*As configurações do sistema CIGAM envolvidas são: 
** [[GE - AM - 338 - Opção para envio de e-mail]] 
** [[GE - AM - 545 - Auto-assinatura a ser anexada no envio de e-mail]]
** [[GE - AM - 692 - Servidor de e-mail]]
** [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** [[GE - AM - 1495 - Solicitar confirmação de leitura para e-mails enviados]]
** [[GE - AM - 2077 - Não enviar cópia para o remetente do e-mail]]
** [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]
** [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

== Qual é o cadastro a ser feito? ==
Para o envio de e-mail, é necessário existir um cadastro do usuário sendo opcional a informação do e-mail vinculado a ele. 
<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref> Caso conste informado e-mail no cadastro, esse será considerado somente se a configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] não constar informada. 
Para ser possível o envio de e-mail é necessário que uma das opções conste com o usuário para o login do servidor de e-mail. Seja ele a configuração ou o cadastro de usuário, quando informado nas duas opções acima mencionadas, será respeitado sempre o que estiver informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]]. 
 
O cadastro de usuário e seu e-mail (opcional) é feito através do programa Usuários - Grupos e Direitos
*Utilidades / Diversos
**Parâmetros
***Usuários
****Usuário - Grupos Direitos 

É possível além do e-mail (opcional), informar a Unidade de Negócio (opcional) caso queira reforçar a unidade que pertence o usuário. 
 
Após realizado o cadastro ou eventual modificação, o ajuste só será validado na próxima sessão para isso preciso sair do sistema e entrar novamente para carregar as parametrizações ou então acessar a área onde consta o perfil do usuário e clicar na opção Carregar Parâmetros.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção SmtpClient? ==
SMTP - (Protocolo de Transferência de Correio Simples é o protocolo padrão de envio de mensagens de correio eletrônico através da Internet entre dois dispositivos computacionais). 
Para que seja possível o envio de email via SmtpClient é necessário ter as seguintes configurações parametrizadas:
* E-mail informado no cadastro do usuário 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''SmtpClient'''
* [[GE - AM - 692 - Servidor de e-mail]]
** Indicado o servidor de e-mail seguido por ‘:’ e a porta liberada para envio de e-mail. 
**Se não informado o número da porta o sistema irá realizar o envio de e-mail pela porta padrão: 25 correspondente aos e-mails que serão utilizados para o envio. 
**Para obter as informações servidor e porta para envio de e-mail acesse uma ferramenta de envio de e-mail que esteja configurada (Ex.: Outlook) e busque pelas informações nas propriedades da conta. 
* [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** Opcional deixar a senha já informada para envio direto do e-mail, caso não seja informada pedirá a senha na hora do envio.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada quando o servidor de envio de e-mail utilizado exigir o usuário + o domínio completo para a autenticação (Ex: conta@dominio.com.br). Quando essa configuração estiver desmarcada só será considerado o informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] ou no cadastro de usuário até o caractere @.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP

* '''IMPORTANTE:''' A partir de 30 de maio de 2022, alguns servidores não autorizaram mais o uso de apps ou dispositivos de terceiros que exigem apenas nome de usuário e senha para fazer login na conta, sendo assim indicamos a aplicação da verificação em duas etapas nas contas a serem utilizadas e a utilização de senhas de app, sendo obrigatória para acesso do email no CIGAM a utilização da senha de app. 
* Ao aplicar a senha de APP no CIGAM não será exigido autenticação em duas etapas devido a composição da senha fornecida pelo provedor basta informar ela na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou individualmente a cada envio que esse ocorrerá normalmente. 
** Para configuração de senhas de app consulte a documentação do seu servidor de e-mail, procurando por '''senhas de APP''' ou '''gerenciamento de senhas de APP''', ou siga as informações abaixo.

{{VoltarInicio}}

=== Como criar uma senha de aplicativo ===
====Senha de aplicativo Gmail====
Ao seguir esses passos, você poderá configurar corretamente uma senha de aplicativo no Gmail para ser utilizada com o CIGAM, garantindo que o envio de e-mails via SMTP funcione adequadamente sem a necessidade de usar sua senha principal da conta do Google. 
 
Para configurar uma senha de aplicativo no Gmail, especialmente quando você está utilizando o servidor de envio SMTP e a opção está informada como SmtpClient na configuração [[GE - AM - 338 - Opção para envio de e-mail]], acesse [https://support.google.com/accounts/answer/185833?hl=pt-BR Criar e usar senhas de app] e siga os passos. 
 
Ao acessar, deverá ser informado para qual tipo de app será utilizado, neste caso será "E-mail" e posteriormente será informado para qual tipo de dispositivo.
 
[[Image: envioemailCigam5.png|550px|centro]]
 
Ao clicar em gerar, será gerada uma senha para o dispositivo. Acesse o menu [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Configurações|Configurações]] para informar na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] a senha gerada.
 
[[Image: envioemailCigam6.png|550px|centro]]

====Senha de aplicativo Outlook====
Servidor de envios Office365, será necessário habilitar a Senha de Aplicativo: 
[https://account.live.com/proofs/manage/additional?mkt=pt-BR&refd=account.microsoft.com&refp=security Acesso direto conta Pessoal] 
[https://mysignins.microsoft.com/security-info Acesso diretor conta Profissional - Administrado por Exchange]
 
[[Image: envioemailCigam12.png|750px|centro]]
 
Inserir uma validação com: E-mail ou Telefone:
 
[[Image: envioemailCigam13.png|300px|centro]]
 
Ativar a verificação em duas etapas:
 
[[Image: envioemailCigam14.png|750px|centro]]
 
Após ativar, irá aparecer a opção Senha de Aplicativo, sendo necessária a criação e inserção na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]].
 
[[Image: envioemailCigam15.png|750px|centro]]
 
Caso a Senha de Aplicativo não esteja habilitada, será necessário ativar a Autenticação Multifator(MFA) dentro do [https://admin.exchange.microsoft.com Exchange do Office365].
 
[[Image: envioemailCigam9.png|750px|centro]]
 
Deve-se verificar se a autenticação SMTP está ativa. Somente o Administrador poderá verificar.
 
[[Image: envioemailCigam7.png|350px|centro]]
{{VoltarInicio}}

====Validação Kinghost====
O provedor Kinghost quando utilizado em ambiente nuvem como: FWC ou Nuvem CIGAM, necessitam que seja realizada a parametrização do SMTPI no provedor, assim como o ajuste do SMTP no CIGAM. 
 
[https://king.host/wiki/artigo/como-ativar-o-smtp-internacional/ Como ativar SMTPI Kinghost]

== Como configurar para utilização de envio através da opção Gmail API? ==
Gmail API - (Para usuários do Gmail, a API do Gmail é a melhor opção para acesso autorizado aos dados do Gmail de um usuário. Isso não armazena nenhum dos e-mails no banco de dados de terceiros, proporcionando mais segurança e privacidade aos seus e-mails. A API do Gmail é usada para interagir com as caixas de entrada e configurações do Gmail dos usuários e oferece suporte a várias linguagens de programação populares). 
 
O envio de email via CIGAM através do Gmail API devem ser autorizadas via credenciais do OAuth 2.0. 
Essa funcionalidade exige a utilização de um token de autorização de acesso ao qual deve ser criado através da console de APIs Google - '''[[https://support.google.com/googleapi/answer/6158849/?hl=en&authuser=1| Configurando o OAuth 2.0]]'''.

*As configurações do sistema CIGAM envolvidas são: 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''Gmail API'''
* [[GE - AM - 692 - Servidor de e-mail]]
** smtp.gmail.com:587 
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]
**Pressione F5 e na tela de Cadastro de credenciais, informe o conteúdo do arquivo feito download anteriormente ou clique em ‘Importar’ conforme a configuração feita para obter o token de autorização via console de APIs Google e confirme.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada para o funcionamento do envio via Gmail API
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via Gmail API

* '''Importante:''' Caso não haja informação nas configurações necessárias para validar credenciais, ao enviar o e-mail será aberta uma tela para colocar as informações necessárias.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção OAuth? ==
A partir da <ref group="Versão 241007">Liberado a partir da OS 373456/716.</ref>, a configuração [[GE - AM - 338 - Opção para envio de e-mail]] agora inclui a possibilidade de enviar e-mails utilizando o protocolo OAuth.
:'''OAuth''' refere-se ao processo de envio de e-mails em que a autenticação é feita utilizando o protocolo OAuth (Open Authorization). 
<blockquote>
OAuth é um padrão de autorização que permite que aplicativos acessem recursos, como contas de e-mail, em nome de um usuário, sem precisar saber a senha do usuário. Em vez disso, OAuth utiliza tokens de acesso temporários que autorizam a aplicação a realizar operações, como o envio de e-mails, de forma segura e controlada. 
 
Quando um aplicativo envia e-mails usando OAuth, ele primeiro solicita a autorização do usuário para acessar sua conta de e-mail. Uma vez autorizado, o aplicativo recebe um token de acesso, que pode ser usado para autenticar futuras requisições, como o envio de e-mails. Este método é amplamente adotado por provedores de e-mail como Google (Gmail), Microsoft (Outlook), e outros, por oferecer maior segurança, pois reduz o risco de comprometimento de senhas e permite que os usuários revoguem o acesso a qualquer momento.
</blockquote>

===Envio de e-mail via Office 365===
:O envio de e-mails pelo CIGAM via 'Office 365' deve ser autenticado usando as credenciais do OAuth 2.0. Essa funcionalidade requer a criação e utilização de um token de autorização, que deve ser gerado através da console de administração do Office 365 - [[Como configurar autenticação Office 365 OAuth 2.0]]. Este token garante acesso seguro e permite que o CIGAM envie e-mails em nome do usuário sem a necessidade de expor senhas, aumentando a segurança no processo de comunicação.

'''As configurações do sistema CIGAM envolvidas são:''' 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção: '''OAuth'''

* [[GE - AM - 3233 - OAuth para envio de e-mail]]
** Opção: Informar o Id do cadastro da parametrização desejada
::::Cadastro de parâmetros OAuth
:::::001.1 - Office 365 OAuth 2.0

* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.

* [[GE - AM - 3074 - E-mail do sistema]]

* [[GE - AM - 3075 - Senha do e-mail do sistema]]

* [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]

* [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

:'''Importante:''' A autenticação será realizada sempre com base no remetente do e-mail, que pode variar conforme a rotina utilizada.

===Envio de e-mail com OAuth utilizando o SendGrid===
:O '''SendGrid''' é uma plataforma de envio de e-mails, desenvolvida por terceiros, que atua como intermediário entre uma aplicação e os servidores de e-mail dos destinatários. Essa plataforma oferece recursos como autenticação, monitoramento e alta entregabilidade, e pode ser integrada a aplicações utilizando autenticação via protocolo OAuth para acessar suas APIs. Veja [[GE - Como Fazer - Como integrar o SendGrid|como integrar o SendGrid]].

Antes de iniciar as parametrizações, é necessário realizar o download dos arquivos conforme link abaixo e colocá-los no local da instalação do CIGAM, dentro da pasta 'Cab\Exclusivo'. Exemplo: %CIGAM_INSTAL%\Cab\Exclusivo\EnvioEmailCustomizado\. 
Clique para baixar pacote de arquivos [https://www.cigam.com.br/wiki/images/a/a2/EnvioEmailCustomizado.zip EnvioEmailCustomizado.zip].

'''As parametrizações do sistema CIGAM envolvidas são:''' 
:1. '''Disponibilizar os arquivos '''

:2. '''Adição de nomes lógicos no arquivo .ini ou adendo''':
::Inclua as configurações abaixo no arquivo .ini correspondente:
:::[MAGIC_LOGICAL_NAMES]
:::EX_CK02176TSI = S
:::EX_CK02176TSICabPrg = EE00003
:::EX_CK02176TSICab = *%CIGAM_INSTAL%Cab\Exclusivo\EnvioEmailCustomizado\Cab\EnvioEmailCustomizado.ecf
:::EX_SENDGRID_APIKEY = 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
:::EX_EMAIL_CUSTOMIZADO = S
{{VoltarInicio}}

== Como utilizar ferramentas que necessitam de senhas com mais de 30 caracteres? ==
A utilização de um servidor de relay de e-mail (SMTP Relay) para envio de e-mails é uma solução eficaz em cenários nos quais é necessário lidar com serviços que requerem senhas longas, como o SendGrid ou Amazon Web Services (AWS). Isso pode ser especialmente útil quando se lida com autenticações complexas ou senhas/tokens longos para serviços de e-mail ou outros serviços que utilizam e-mail para comunicação. 
#'''Autenticação pelo SMTP Relay:''' Ao configurar um servidor de relay de e-mail, o servidor assume a responsabilidade de autenticar-se com o serviço de e-mail (por exemplo, SendGrid ou AWS) em nome do sistema que está enviando os e-mails (neste caso, o CIGAM). Isso significa que o CIGAM não precisa lidar diretamente com senhas/tokens longos, tornando a autenticação mais segura e gerenciável.
#'''Implementação:''' A implementação de um servidor de relay de e-mail é responsabilidade do departamento de TI do cliente ou de uma empresa de TI terceirizada, se for esse o caso. A configuração envolve definir as credenciais de autenticação para o serviço de relay, configurar as regras de envio de e-mail e direcionar o CIGAM para usar o servidor de relay.
#'''Considerações de Segurança:''' Certifique-se de que o servidor de relay de e-mail seja adequadamente seguro e mantenha as boas práticas de segurança para proteger as credenciais armazenadas. Além disso, considere a implementação de autenticação em dois fatores (2FA) para aumentar a segurança.

= Envio de e-mail usuários externos =
<ref group="Versão 220404.c"> Liberado a partir da OS 373456/391. </ref> Os e-mails a serem enviados via portais respeitam as mesmas configurações aplicadas diretamente no desktop, os usuários sempre devem possuir um cadastro no CIGAM e seu e-mail no cadastro de usuários. 
* Para que seja possível o envio de e-mail para usuários externos deve ter as seguintes parametrizações: 
** Ter configurado no sistema o envio de e-mail conforme orientações acima
** Informação na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] se optar por não informar a senha de e-mail a cada acesso ao portal.
Sendo assim onde existir a implementação da funcionalidade, caso a configuração: [[GE - AM - 904 - Senha para login no servidor de e-mail]] não conste informada para o usuário será exibida uma tela para que seja possível indicar a senha para login no servidor de e-mail e consequentemente fazer o envio. Essas informações serão aplicadas até o próximo acesso sem necessidade de informar novamente.
{{VoltarInicio}}

=Manuais Referenciados=
*[[Configurações e parametrizações para envio de e-mail através do Cigam]]

= Versão 220404 =
=== Patch "c" ===
<references group="Versão 220404.c"/>
= Versão 221107 =
=== Patch "c" ===
<references group="Versão 221107.c"/>
= Versão 241007 =
<references group="Versão 241007"/>

GE - Como Fazer - Configuração de Envio de E-mail no CIGAM

2025-02-12T14:33:37Z

Alessandro.voto: /* Envio de e-mail com OAuth utilizando o SendGrid */

{{VoltarPagina}}
 
[[categoria:Como Fazer Utilidades/Diversos]]
[[MediaWiki:Como_Fazer_sidebar|Como Fazer]] > [[Como_Fazer_Utilidades/Diversos|Utilidades/Diversos]] > [[GE - Como Fazer - Configuração de Envio de E-mail no CIGAM|Configuração de Envio de E-mail no CIGAM]]



= Configuração de envio e email pelo Sistema CIGAM =
O uso de envio de e-mail pelo Sistema Cigam requer informações fornecidas pelo cliente, parametrizações de máquina e configurações de sistema para o correto funcionamento. 

== Quais são as informações de Envio de E-mail para parametrização?==
As informações são geralmente repassadas pelo próprio cliente ou sua T.I. As informações são: 
⦁ Qual é o servidor de e-mail e respectiva porta? 
⦁ Qual é a conta de e-mail do usuário? 
⦁ Qual é a senha de e-mail do usuário? 
⦁ É utilizado algum método de segurança, como SSL (Secure Sockets Layer)? 

== Quais as parametrizações de Envio de E-mail de máquina? ==
O Framework .Net precisa estar devidamente instalado e com suas permissões. Para saber como parametrizar o .Net verificar o documento “[[GE - Como Fazer - Instalação do .Net|Como Fazer - Instalação do .Net]]”. 
{{VoltarInicio}}

== Quais são as configurações para parametrizar o envio de e-mail pelo CIGAM? ==
*As configurações do sistema CIGAM envolvidas são: 
** [[GE - AM - 338 - Opção para envio de e-mail]] 
** [[GE - AM - 545 - Auto-assinatura a ser anexada no envio de e-mail]]
** [[GE - AM - 692 - Servidor de e-mail]]
** [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** [[GE - AM - 1495 - Solicitar confirmação de leitura para e-mails enviados]]
** [[GE - AM - 2077 - Não enviar cópia para o remetente do e-mail]]
** [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]
** [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

== Qual é o cadastro a ser feito? ==
Para o envio de e-mail, é necessário existir um cadastro do usuário sendo opcional a informação do e-mail vinculado a ele. 
<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref> Caso conste informado e-mail no cadastro, esse será considerado somente se a configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] não constar informada. 
Para ser possível o envio de e-mail é necessário que uma das opções conste com o usuário para o login do servidor de e-mail. Seja ele a configuração ou o cadastro de usuário, quando informado nas duas opções acima mencionadas, será respeitado sempre o que estiver informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]]. 
 
O cadastro de usuário e seu e-mail (opcional) é feito através do programa Usuários - Grupos e Direitos
*Utilidades / Diversos
**Parâmetros
***Usuários
****Usuário - Grupos Direitos 

É possível além do e-mail (opcional), informar a Unidade de Negócio (opcional) caso queira reforçar a unidade que pertence o usuário. 
 
Após realizado o cadastro ou eventual modificação, o ajuste só será validado na próxima sessão para isso preciso sair do sistema e entrar novamente para carregar as parametrizações ou então acessar a área onde consta o perfil do usuário e clicar na opção Carregar Parâmetros.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção SmtpClient? ==
SMTP - (Protocolo de Transferência de Correio Simples é o protocolo padrão de envio de mensagens de correio eletrônico através da Internet entre dois dispositivos computacionais). 
Para que seja possível o envio de email via SmtpClient é necessário ter as seguintes configurações parametrizadas:
* E-mail informado no cadastro do usuário 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''SmtpClient'''
* [[GE - AM - 692 - Servidor de e-mail]]
** Indicado o servidor de e-mail seguido por ‘:’ e a porta liberada para envio de e-mail. 
**Se não informado o número da porta o sistema irá realizar o envio de e-mail pela porta padrão: 25 correspondente aos e-mails que serão utilizados para o envio. 
**Para obter as informações servidor e porta para envio de e-mail acesse uma ferramenta de envio de e-mail que esteja configurada (Ex.: Outlook) e busque pelas informações nas propriedades da conta. 
* [[GE - AM - 693 - Necessita senha para efetuar login no servidor de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]]
** Opcional deixar a senha já informada para envio direto do e-mail, caso não seja informada pedirá a senha na hora do envio.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada quando o servidor de envio de e-mail utilizado exigir o usuário + o domínio completo para a autenticação (Ex: conta@dominio.com.br). Quando essa configuração estiver desmarcada só será considerado o informado na configuração [[GE - AM - 903 - Usuário para login no servidor de e-mail]] ou no cadastro de usuário até o caractere @.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via SMTP

* '''IMPORTANTE:''' A partir de 30 de maio de 2022, alguns servidores não autorizaram mais o uso de apps ou dispositivos de terceiros que exigem apenas nome de usuário e senha para fazer login na conta, sendo assim indicamos a aplicação da verificação em duas etapas nas contas a serem utilizadas e a utilização de senhas de app, sendo obrigatória para acesso do email no CIGAM a utilização da senha de app. 
* Ao aplicar a senha de APP no CIGAM não será exigido autenticação em duas etapas devido a composição da senha fornecida pelo provedor basta informar ela na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou individualmente a cada envio que esse ocorrerá normalmente. 
** Para configuração de senhas de app consulte a documentação do seu servidor de e-mail, procurando por '''senhas de APP''' ou '''gerenciamento de senhas de APP''', ou siga as informações abaixo.

{{VoltarInicio}}

=== Como criar uma senha de aplicativo ===
====Senha de aplicativo Gmail====
Ao seguir esses passos, você poderá configurar corretamente uma senha de aplicativo no Gmail para ser utilizada com o CIGAM, garantindo que o envio de e-mails via SMTP funcione adequadamente sem a necessidade de usar sua senha principal da conta do Google. 
 
Para configurar uma senha de aplicativo no Gmail, especialmente quando você está utilizando o servidor de envio SMTP e a opção está informada como SmtpClient na configuração [[GE - AM - 338 - Opção para envio de e-mail]], acesse [https://support.google.com/accounts/answer/185833?hl=pt-BR Criar e usar senhas de app] e siga os passos. 
 
Ao acessar, deverá ser informado para qual tipo de app será utilizado, neste caso será "E-mail" e posteriormente será informado para qual tipo de dispositivo.
 
[[Image: envioemailCigam5.png|550px|centro]]
 
Ao clicar em gerar, será gerada uma senha para o dispositivo. Acesse o menu [[Utilidades/Diversos]] > [[GE_Genéricos|Genéricos]] > [[GE_Parâmetros|Parâmetros]] > [[GE_Configurações|Configurações]] para informar na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] a senha gerada.
 
[[Image: envioemailCigam6.png|550px|centro]]

====Senha de aplicativo Outlook====
Servidor de envios Office365, será necessário habilitar a Senha de Aplicativo: 
[https://account.live.com/proofs/manage/additional?mkt=pt-BR&refd=account.microsoft.com&refp=security Acesso direto conta Pessoal] 
[https://mysignins.microsoft.com/security-info Acesso diretor conta Profissional - Administrado por Exchange]
 
[[Image: envioemailCigam12.png|750px|centro]]
 
Inserir uma validação com: E-mail ou Telefone:
 
[[Image: envioemailCigam13.png|300px|centro]]
 
Ativar a verificação em duas etapas:
 
[[Image: envioemailCigam14.png|750px|centro]]
 
Após ativar, irá aparecer a opção Senha de Aplicativo, sendo necessária a criação e inserção na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]].
 
[[Image: envioemailCigam15.png|750px|centro]]
 
Caso a Senha de Aplicativo não esteja habilitada, será necessário ativar a Autenticação Multifator(MFA) dentro do [https://admin.exchange.microsoft.com Exchange do Office365].
 
[[Image: envioemailCigam9.png|750px|centro]]
 
Deve-se verificar se a autenticação SMTP está ativa. Somente o Administrador poderá verificar.
 
[[Image: envioemailCigam7.png|350px|centro]]
{{VoltarInicio}}

====Validação Kinghost====
O provedor Kinghost quando utilizado em ambiente nuvem como: FWC ou Nuvem CIGAM, necessitam que seja realizada a parametrização do SMTPI no provedor, assim como o ajuste do SMTP no CIGAM. 
 
[https://king.host/wiki/artigo/como-ativar-o-smtp-internacional/ Como ativar SMTPI Kinghost]

== Como configurar para utilização de envio através da opção Gmail API? ==
Gmail API - (Para usuários do Gmail, a API do Gmail é a melhor opção para acesso autorizado aos dados do Gmail de um usuário. Isso não armazena nenhum dos e-mails no banco de dados de terceiros, proporcionando mais segurança e privacidade aos seus e-mails. A API do Gmail é usada para interagir com as caixas de entrada e configurações do Gmail dos usuários e oferece suporte a várias linguagens de programação populares). 
 
O envio de email via CIGAM através do Gmail API devem ser autorizadas via credenciais do OAuth 2.0. 
Essa funcionalidade exige a utilização de um token de autorização de acesso ao qual deve ser criado através da console de APIs Google - '''[[https://support.google.com/googleapi/answer/6158849/?hl=en&authuser=1| Configurando o OAuth 2.0]]'''.

*As configurações do sistema CIGAM envolvidas são: 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção '''Gmail API'''
* [[GE - AM - 692 - Servidor de e-mail]]
** smtp.gmail.com:587 
* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 904 - Senha para login no servidor de e-mail]] ou [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]
**Pressione F5 e na tela de Cadastro de credenciais, informe o conteúdo do arquivo feito download anteriormente ou clique em ‘Importar’ conforme a configuração feita para obter o token de autorização via console de APIs Google e confirme.
* [[GE - AM - 2159 - Utilizar e-mail completo para autenticar no servidor]]
** Deve estar marcada para o funcionamento do envio via Gmail API
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2445 - Utilizar método seguro SSL/TLS para envio de e-mail]]
** Deve estar marcada para o funcionamento do envio via Gmail API

* '''Importante:''' Caso não haja informação nas configurações necessárias para validar credenciais, ao enviar o e-mail será aberta uma tela para colocar as informações necessárias.
{{VoltarInicio}}

== Como configurar para utilização de envio através da opção OAuth? ==
A partir da <ref group="Versão 241007">Liberado a partir da OS 373456/716.</ref>, a configuração [[GE - AM - 338 - Opção para envio de e-mail]] agora inclui a possibilidade de enviar e-mails utilizando o protocolo OAuth.
:'''OAuth''' refere-se ao processo de envio de e-mails em que a autenticação é feita utilizando o protocolo OAuth (Open Authorization). 
<blockquote>
OAuth é um padrão de autorização que permite que aplicativos acessem recursos, como contas de e-mail, em nome de um usuário, sem precisar saber a senha do usuário. Em vez disso, OAuth utiliza tokens de acesso temporários que autorizam a aplicação a realizar operações, como o envio de e-mails, de forma segura e controlada. 
 
Quando um aplicativo envia e-mails usando OAuth, ele primeiro solicita a autorização do usuário para acessar sua conta de e-mail. Uma vez autorizado, o aplicativo recebe um token de acesso, que pode ser usado para autenticar futuras requisições, como o envio de e-mails. Este método é amplamente adotado por provedores de e-mail como Google (Gmail), Microsoft (Outlook), e outros, por oferecer maior segurança, pois reduz o risco de comprometimento de senhas e permite que os usuários revoguem o acesso a qualquer momento.
</blockquote>

===Envio de e-mail via Office 365===
:O envio de e-mails pelo CIGAM via 'Office 365' deve ser autenticado usando as credenciais do OAuth 2.0. Essa funcionalidade requer a criação e utilização de um token de autorização, que deve ser gerado através da console de administração do Office 365 - [[Como configurar autenticação Office 365 OAuth 2.0]]. Este token garante acesso seguro e permite que o CIGAM envie e-mails em nome do usuário sem a necessidade de expor senhas, aumentando a segurança no processo de comunicação.

'''As configurações do sistema CIGAM envolvidas são:''' 
* [[GE - AM - 338 - Opção para envio de e-mail]] 
** Opção: '''OAuth'''

* [[GE - AM - 3233 - OAuth para envio de e-mail]]
** Opção: Informar o Id do cadastro da parametrização desejada
::::Cadastro de parâmetros OAuth
:::::001.1 - Office 365 OAuth 2.0

* [[GE - AM - 903 - Usuário para login no servidor de e-mail]]
** Opcional - caso esteja informado, será utilizado como usuário para autenticação no servidor de e-mail, caso contrário será utilizada a informação do campo e-mail no cadastro do usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.
* [[GE - AM - 2169 - E-mail do remetente variando por unidade de negócio]]
** Opcional - caso seja informado o e-mail esse será utilizado para o remetente, caso contrário será considerado o do cadastro de usuário<ref group="Versão 221107.c">Liberado a partir da OS 780634/2.</ref>.

* [[GE - AM - 3074 - E-mail do sistema]]

* [[GE - AM - 3075 - Senha do e-mail do sistema]]

* [[GE - AM - 2786 - Endereço de e-mail para envio de documentos eletrônicos]]

* [[GE - AM - 2787 - Senha de autenticação no servidor de e-mail Doc. Eletrônicos]]

:'''Importante:''' A autenticação será realizada sempre com base no remetente do e-mail, que pode variar conforme a rotina utilizada.

===Envio de e-mail com OAuth utilizando o SendGrid===
:O '''SendGrid''' é uma plataforma de envio de e-mails, desenvolvida por terceiros, que atua como intermediário entre uma aplicação e os servidores de e-mail dos destinatários. Essa plataforma oferece recursos como autenticação, monitoramento e alta entregabilidade, e pode ser integrada a aplicações utilizando autenticação via protocolo OAuth para acessar suas APIs. Veja [[GE - Como Fazer - Como integrar o SendGrid|como integrar o SendGrid]].

Antes de iniciar as parametrizações, é necessário realizar o download dos arquivos conforme link abaixo, e colocá-los no local da instalação do CIGAM, dentro da pasta 'Cab\Exclusivo'. Exemplo: %CIGAM_INSTAL%\Cab\Exclusivo\EnvioEmailCustomizado\.

'''As parametrizações do sistema CIGAM envolvidas são:''' 
:1. '''Disponibilizar os arquivos '''
::Baixe o pacote da pasta 'EnvioEmailCustomizado', clicando aqui: [https://www.cigam.com.br/wiki/images/a/a2/EnvioEmailCustomizado.zip EnvioEmailCustomizado.zip].

:2. '''Adição de nomes lógicos no arquivo .ini ou adendo''':
::Inclua as configurações abaixo no arquivo .ini correspondente:
:::[MAGIC_LOGICAL_NAMES]
:::EX_CK02176TSI = S
:::EX_CK02176TSICabPrg = EE00003
:::EX_CK02176TSICab = *%CIGAM_INSTAL%Cab\Exclusivo\EnvioEmailCustomizado\Cab\EnvioEmailCustomizado.ecf
:::EX_SENDGRID_APIKEY = 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
:::EX_EMAIL_CUSTOMIZADO = S
{{VoltarInicio}}

== Como utilizar ferramentas que necessitam de senhas com mais de 30 caracteres? ==
A utilização de um servidor de relay de e-mail (SMTP Relay) para envio de e-mails é uma solução eficaz em cenários nos quais é necessário lidar com serviços que requerem senhas longas, como o SendGrid ou Amazon Web Services (AWS). Isso pode ser especialmente útil quando se lida com autenticações complexas ou senhas/tokens longos para serviços de e-mail ou outros serviços que utilizam e-mail para comunicação. 
#'''Autenticação pelo SMTP Relay:''' Ao configurar um servidor de relay de e-mail, o servidor assume a responsabilidade de autenticar-se com o serviço de e-mail (por exemplo, SendGrid ou AWS) em nome do sistema que está enviando os e-mails (neste caso, o CIGAM). Isso significa que o CIGAM não precisa lidar diretamente com senhas/tokens longos, tornando a autenticação mais segura e gerenciável.
#'''Implementação:''' A implementação de um servidor de relay de e-mail é responsabilidade do departamento de TI do cliente ou de uma empresa de TI terceirizada, se for esse o caso. A configuração envolve definir as credenciais de autenticação para o serviço de relay, configurar as regras de envio de e-mail e direcionar o CIGAM para usar o servidor de relay.
#'''Considerações de Segurança:''' Certifique-se de que o servidor de relay de e-mail seja adequadamente seguro e mantenha as boas práticas de segurança para proteger as credenciais armazenadas. Além disso, considere a implementação de autenticação em dois fatores (2FA) para aumentar a segurança.

= Envio de e-mail usuários externos =
<ref group="Versão 220404.c"> Liberado a partir da OS 373456/391. </ref> Os e-mails a serem enviados via portais respeitam as mesmas configurações aplicadas diretamente no desktop, os usuários sempre devem possuir um cadastro no CIGAM e seu e-mail no cadastro de usuários. 
* Para que seja possível o envio de e-mail para usuários externos deve ter as seguintes parametrizações: 
** Ter configurado no sistema o envio de e-mail conforme orientações acima
** Informação na configuração [[GE - AM - 904 - Senha para login no servidor de e-mail]] se optar por não informar a senha de e-mail a cada acesso ao portal.
Sendo assim onde existir a implementação da funcionalidade, caso a configuração: [[GE - AM - 904 - Senha para login no servidor de e-mail]] não conste informada para o usuário será exibida uma tela para que seja possível indicar a senha para login no servidor de e-mail e consequentemente fazer o envio. Essas informações serão aplicadas até o próximo acesso sem necessidade de informar novamente.
{{VoltarInicio}}

=Manuais Referenciados=
*[[Configurações e parametrizações para envio de e-mail através do Cigam]]

= Versão 220404 =
=== Patch "c" ===
<references group="Versão 220404.c"/>
= Versão 221107 =
=== Patch "c" ===
<references group="Versão 221107.c"/>
= Versão 241007 =
<references group="Versão 241007"/>