Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Painel
Deck of Cards
iddeck principal

Configurando serviço REST

Após o primeiro passo deve-se realizar a configuração no "appserver.ini" realizando a definição dos serviços REST.
Os itens abaixo, devem ser incluídos/atualizados no seu arquivo atual do seu ambiente.

Card
labelParte 1 - Configurando pelo wizard


A partir da release 12.1.25 o complemento da configuração para o app MeuRH poderá ser realizado também de dentro do APWebWizard, assim como foi realizada a configuração do serviço REST anteriormente. Ao acessar o Wizard você deverá identificar uma nova opção na árvore do menu chamada "App MeuRH". 

Image Added


Dentro dessa configuração já existem uma série de validações referentes aos serviços HTTP e REST que já devem estar previamente configurados, onde seu objetivo é eliminar possíveis divergências de informações durante o processo de configuração.

Iniciando a configuração será validado o endereço da URL do REST que será atualizada automaticamente no arquivo “properties.json” ao final da configuração, desde que a pasta dos arquivos cliente já exista no server, antes que essas configurações de host do MeuRH sejam finalizadas!

Image Added



Image Added


Ao realizar a confirmação das configuração dos hosts para o App MeuRH , o arquivo "appserver.ini" será atualizado e o wizard tentará realizar a criação do novo arquivo “properties.json” para cada PATH informado, renomeando o arquivo já existente na pasta como backup.

Image Added


Ao retornar será possível identificar visualmente na lista todos os hosts cadastrados para serem utilizados no App MeuRH.

Image Added


Card
labelParte 2 - Configurando manualmente


Nessa etapa precisamos complementar o seu arquivo "appserver.ini" com as configurações relativas ao serviço MeuRH
:

Nesse caso estamos criando uma '[sessão]' auxiliar do MeuRH que será utilizada para o redirecionamento dos arquivos client e realizando a configuração do ambiente utilizado. Você poderá ter uma URL para cada empresa separada dentro da sua estrutura.

O endereço de exemplo "10.172.36.45" poderá ser um endereço para utilização apenas na sua rede local interna ou um endereço para acesso externo, assim permitindo que o aplicativo funcione quando os colaboradores de sua empresa estivem conectado fora de sua rede corporativa.

Lembre-se de não utilizar localhost ou 127.0.0.1 pois estes indicam "este computador", ou seja, quando você configura com localhost não é possível acessar de nenhum outro computador ou smartphone.

A Porta de exemplo "8081" corresponde a sua tag "Port" configurada na sessão "HTTP" que já deverá existir no seu "appserver.ini".
Realizamos essa configuração no passo anterior dessa página!.

Como complemento do endereço raiz (IP + Porta HTTP), precisaremos informar um contexto. A origem desse contexto é o sufixo da URL do serviço REST definido no wizard observe abaixo:

  • A URL do serviço REST configurado foi "/restT1", dividiremos essa URL em 2 partes:
    • O prefixo "/rest"
    • O sufixo "T1"

Nesse caso, o complemento do endereço rais raiz será "/T1".
Essa informação do contexto é importante para que o aplicativo consiga realizar a montagem correta da URL do serviço REST para a realização das solicitações ao servidor!

[10.172.36.45:8081/T1]
ENABLE=1
PATH=C:\TOTVS\Protheus\Protheus_Data\Web\PortalRHUnificado
ENVIRONMENT=MeuEnv12117
INSTANCENAME=MeuRHT1
DEFAULTPAGE=index.html


Agora criaremos mais essa sessão abaixo no seu arquivo "appserver.ini", a sessão "RESTCONFIG" onde são criadas tags utilizadas para o app MeuRH Protheus:

    • A tag "restPort" é obrigatória e deve ser preenchida com a mesma porta utilizada na sessão "HTTPREST" dentro da chave PORT, no nosso caso o nosso REST foi iniciado na porta 8103.A tag "RefreshTokenTimeout" é responsável por definir o tempo em que um acesso/token de autenticação será válido, caso não seja informado essa tag, o seu valor default é 600 (correspondendo a 10 minutos) - Obsoleta.
    • A tag "meurhLog" controla a geração de mensagens no "console.log" sobre o processo de autenticação/login do aplicativo MeuRH, apoiando em possíveis manutenções e acompanhamentos do processo. Por padrão, as mensagens sempre estarão sendo demonstradas no console, mesmo que a tag não exista no arquivo de inicialização "appserver.ini". Caso deseje que as mensagens não sejam mais demonstradas no console, basta declarar a tag "meurhLog=0", dentro da sessão "[RESTCONFIG]", para seja desabilitado.

[RESTCONFIG]
restPort=8103
meurhLog=1


Configurando o arquivo "properties.json"

Para finalizar a configuração, vamos atualizar as informações desse arquivo, baseado nas configurações realizadas anteriormente.

Esse arquivo encontra-se no raiz da pasta de arquivos cliente do app MeuRH, no mesmo local do arquivo "index.html".
Essa pasta é declarada na chave "PATH", no exemplo acima sobre a declaração do aplicativo. 

As tags que atualizaremos dentro de arquivo são: "baseUrl" e "rootContext":

Tag "baseUrl"

Essa tag deve ser configurada com o endereço do REST, onde no exemplo: "http://10.172.36.45:8103/restT1"

  • 10.172.36.45 = Endereço/IP do seu servidor protheus
  • 8103 = A porta do REST (restPort) configurada no seu appserver.ini na seção [RESTCONFIG]
  • /restT1 = essa informação foi declarada no item URL de REST, em seu "appserver.ini"

Tag "rootContext"

Essa tag deve ser configurada com o valor do sufixo da URL do rest:

Abaixo exemplo do arquivo "properties.json" padrão, que se encontra na raiz dos arquivos cliente da pasta web:

{
	"ERP": 3,
	"PROPS": {
		"baseUrl": "http://10.172.36.45:8103/restT1",
		"rootContext": "/T1/" },
	
	"EXTERNAL_APP_RESPONSE": [
		{
			"id": "tfs",
			"nameShort": {
				"pt": "Financeiro",
				"en": "Financial"
			},
			"nameLong": {
				"pt": "Serviços Financeiros",
				"en": "Financial Services"
			},
			"url": "https://totvs.myconsig.com.br/tokens/{token}",
			"urlStaging": "https://staging-totvs.myconsig.com.br/tokens/{token}",
			"icon": "ico-money",
			"enabled": false,
			"grouperId": "paymentSubMenu",
			"useStagingEnvironment": false
		}
	]
}

Onde { "ERP": 3, "PROPS": { "baseUrl": "http://10.172.36.45:8103/restT1", "rootContext": "/T1/" } é necessário para que os redirecionamentos do login com "ERP": 3 (Protheus) sejam feitos corretamente.

E o trecho do "EXTERNAL_APP_RESPONSE" é relacionado ao empréstimo consignado. Mais detalhes: 6.3 Serviços Financeiros (Empréstimo Consignado)


Importante:

Atente-se na atualização desse arquivo "properties.json", atualizações realizadas incorretamente, podem ocasionar problemas no carregamento do aplicativo após o processo de autenticação do usuário.

A baseUrl padrão e o rootContext devem estar configurados de acordo com seu ambiente.


...