GE - Como Fazer - Parâmetros do arquivo config.json

Voltar

Como Fazer > Utilidades/Diversos > GE - Como Fazer - Parâmetros do arquivo config.json

Arquivo de Configuração config.json

Objetivo

O arquivo config.json é utilizado para armazenar configurações externas dos Portais React, permitindo alterar URLs, parâmetros e comportamentos da aplicação.

Localização

Em ambientes hospedados no IIS, o arquivo está localizado em:

<PortalReact>/static/config.json

Exemplo de Configuração

 {
  "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",
  "MENU_MAX_ACESSOS": "50",
  "THEMES": null
 }

Parâmetros

API_URL

Descrição:

Define a URL base da API consumida pelos Portais React.

Observações:

• Parâmetro obrigatório para o funcionamento da aplicação.
• Deve apontar para a instância da API correspondente ao ambiente.

Exemplo:

 {
 "API_URL": "https://servidor:porta/api/api"
 }

Referência:

Consulte a documentação Portais API para mais detalhes sobre a configuração e disponibilização da API.

CDN_URL

Descrição:

Define a URL do CDN (Content Delivery Network) utilizado pelos Portais React para disponibilização e acesso a arquivos.

Observações:

• Deve apontar para o serviço de CDN configurado no ambiente.
• Utilizado para carregamento de arquivos disponibilizados pela aplicação.

Exemplo:

 {
 "CDN_URL": "https://servidor:porta/cdn/files.ashx/"
 }

Referência:

Consulte a documentação Portais CDN para mais detalhes sobre a configuração e utilização do serviço.

PORTAL_SERVICOS_URL

Descrição:

Define a URL do Portal de Serviços.

Exemplo:

 {
 "PORTAL_SERVICOS_URL": "https://servidor:porta/portalservicos"
 }

PD_URL

Descrição:

Define a URL da Pesquisa Dinâmica utilizada pelos Portais React.

Exemplo:

 {
 "PD_URL": "https://servidor:porta/pesquisadinamica"
 }

DEFAULT_PORTAL

Descrição:

Define qual portal será aberto automaticamente ao acessar a aplicação React.

Observações:

• A partir da , o parâmetro ACTIVE_PORTALS deixou de ser utilizado para definir o portal inicial e foi substituído por DEFAULT_PORTAL.
• Apenas um portal pode ser definido como padrão.
• O portal informado deve estar disponível na instalação.
• Após alterar o arquivo config.json, é necessário reiniciar o site no IIS para que a configuração seja aplicada.

Valores permitidos

Portal	Valor
Portal Financeiro	"portalfinanceiro"
Portal Indústria	"portalindustria"
Portal Serviços	"portalservicos"
Portal Compras	"portalcompras"
Portal Projetos	"portalprojetos"

Exemplo:

 {
  "DEFAULT_PORTAL": "portalcompras"
 }

Compatibilidade com ACTIVE_PORTALS

O parâmetro ACTIVE_PORTALS pode continuar sendo utilizado para informar quais portais estão disponíveis na instalação, porém ele não define qual portal será aberto por padrão.

Exemplo:

  "ACTIVE_PORTALS": [ 
      "portalfinanceiro", 
      "portalindustria", 
      "portalcompras", 
      "portalprojetos" 
  ]

Voltar ao início

DEFAULT_LOGIN

Descrição:

Define qual método de autenticação será apresentado automaticamente ao acessar o endereço base da aplicação React.

Observações:

• O valor deve ser informado em letras minúsculas.
• O método configurado deve corresponder a uma aplicação instalada e devidamente configurada no ambiente.
• As aplicações de autenticação possuem instalações e configurações independentes.

Valores permitidos

Método de Entrada	Valor
CIGAM Padrão	"cigam"
Contato Externo	"contato"

Detalhamento

CIGAM Padrão ("cigam")

• Utilizado para autenticação interna padrão dos usuários do sistema.

Contato Externo ("contato")

• Utilizado para autenticação de usuários externos.
• Aplicado atualmente em:
  • Portal Cliente – Área Financeira
  • Portal Cliente – Serviços

Exemplo:

 {
  "DEFAULT_LOGIN": "cigam"
 }

Importante

As aplicações CIGAM Padrão e Contato Externo são componentes distintos e devem ser instaladas separadamente conforme a necessidade do ambiente. As respectivas configurações, integrações e rotas de acesso devem estar corretamente configuradas para garantir o funcionamento da autenticação.

Voltar ao início

MENU_MAX_ACESSOS

Descrição:

Define a quantidade máxima de acessos que podem ser acumulados antes do envio dos registros para gravação.

Obrigatório: Não

Valor padrão: 50

Observações:

• Os acessos são armazenados temporariamente e enviados para gravação quando o limite configurado for atingido.
• Caso a aplicação seja encerrada ou atualizada (refresh) antes de atingir o limite, os registros pendentes também deverão ser enviados.
• Caso o parâmetro não seja informado, será utilizado o valor padrão de 50 acessos.

THEMES

Descrição:

Permite configurar os temas disponíveis para utilização nos Portais React.

Exemplo:

 {
 "THEMES": null
 }

Desativando Endereços de Aplicações Não Utilizadas

• Nas configurações de endereço (campos com sufixo: "_URL"), caso a aplicação não esteja instalada, o valor deve ser anulado.
• Para isso, remova as aspas e deixe o valor como null.

Exemplo:

 {
  "PORTAL_SERVICOS_URL": null
 }

Voltar ao início

Documentos Relacionados

• GE - Como Fazer - Configuração da Aplicação React no IIS