Nessa etapa do passo a passo os clientes que encontram-se na release 12.1.25, poderão utilizar essa configuração via APWebWizard (Parte 1), para as releases anteriores deverão realizar a configuração complementar utilizando (Parte 2)
instalação e habilitação
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.
1) Deve ser criado algumas seções para a configuração do serviço REST:
- Caso necessário esse bloco poderá ser criado com o auxilio da ferramenta ApWebWizard do time de framework para a criação de ambientes:Utilizando ApWebWizard
- Uma dica interessante:
- É possível utilizar um servidor Protheus (AppServer) com os serviços rest, sem a necessidade de configurar os outros jobs e webservices do padrão soap referente ao portal tradicional Gestão do Capital Humano. O aplicativo MeuRH utiliza somente serviços REST em sua utilização, sendo assim, permite a flexibilidade da criação de servidores separados, podendo reinicializar um sem prejudicar o outro!
[HTTPV11] [HTTPREST] [HTTPENV1] [HTTPJOB] [ONSTART] |
|---|
A sessão "HTTPENV1" serve para configurar as questões de ambiente e a URL Rest para cada empresa. Deve ser criado uma sessão para cada empresa, por exemplo "HTTPENV2", "HTTPENV3", permitindo que possa ser configurado outras tags, como o "PrepareIn", responsável em configurar o environment sempre que o Rest receber uma requisição e necessitar criar uma thread para executar a solicitação.
É importante a criação da tag URL para que o aplicativo consiga chegar adequadamente ao servidor, pois ela será utilizada quando for realizado a geração do QrCode. Nesse caso foi formada por: "/rest" concatenado com a empresa "T1".
As sessões criadas acima são padrões para a configuração do serviço REST, e podem ser localizadas nas informações colocadas no link do inicio da página.
Caso tenha configurado ambientes para várias empresas basta incluir as configurações na tag "URIs", exemplo: URIs=HTTPENV1,HTTPENV2
2) Em Seguida, criaremos a parte especifica para os serviços do aplicativo:
[127.0.0.1:8081/T1] [RESTCONFIG] |
|---|
Nesse caso estamos criando uma sessão que será utilizada para o redirecionamento dos arquivos clientes do MeuRH 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 "127.0.0.1" 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 da rede corporativa.
A Porta de exemplo "8081" corresponde a sua tag "Port" configurada na sessão "HTTP" que já deverá existir no seu "appserver.ini", a mesma utilizada para os portais atuais da Totvs, como o portal do RH Gestão do Capital Humano.
Na sessão "RESTCONFIG" são criadas tags utilizadas para o projeto MeuRH Protheus:
- A tag "restPort" é obrigatória e deve ser preenchida com a mesma porta utilizada na sessão "HTTPREST" dentro da chave PORT, exemplo: "PORT=9103".
- 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).
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.
Configurando o arquivo "properties.json"
Esse arquivo encontra-se no raiz da pasta de arquivos cliente do app MeuRH, o seu objetivo é permitir a configuração dos direcionamentos para o serviço REST. Segue abaixo como configurar as informações para um servidor Protheus:
As tags utilizadas dentro de arquivo são: "baseUrl" e "rootContext"
| tag "baseUrl" |
|---|
|
Essa tag deve ser configurada com o endereço do REST criado no seu ambiente.
Para realizar uma validação, pode-se abrir esse endereço no browser, onde deverá ser carregado a
|
| tag "rootContext" |
|---|
Essa tag deve ser configurada com o endereço informado no seu "appserver.ini" que contém as
|
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.
Configurando App MeuRH via APWebWizard
1) 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 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":Na sessão "RESTCONFIG" são criadas tags utilizadas para o projeto 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:
- Seguindo o exemplo "http://10.172.36.45:8103/restT1" o contexto será /T1/.
Abaixo exemplo do properties.json padrão:
{ "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.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas