Versões comparadas

Chave

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

...

Aviso
titleImportante

A instalação depende da atualização dos pacotes descritos

Localizar e aplicar a última atualização da lib do Protheus, responsáveis pelos serviços rest e segurança: 

Atualizar o último pacote acumulado de atualizações dos serviços para o App MeuRH;:

Última versão dos arquivos cliente disponibilizados para downloadno portal do cliente:

...

Painel
titleinstalação e utilização

.

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

A sessão "RESTCONFIG" é de extrema importância para o projeto MeuRH Protheus:


2) Em Seguida, criaremos a parte especifica para os serviços do aplicativo:

Deck of Cards
iddeck principal
Card
labelpasso 1


Atualizando os arquivos Client MeuRH


Após o download dos arquivos cliente da Central de Downloads no link: https://suporte.totvs.com/portal/p/10098/download?e=662850   

Foi baixado o arquivo: 18-03-06-ARQUIVOS_PORTAL_MEURH_12.1.17.ZIP

 

Após baixar os arquivos e descompactar, será obtida a seguinte estrutura de arquivos: 

 


Dentro desse arquivo compactado encontramos a pasta "PortalRHUnificado", contendo os WebFiles utilizados no app MeuRH, essa pasta pode ser descompactada e os arquivos remanejados para qualquer diretório dentro do seu ambiente Protheus, preferencial pode ser colocado dentro do ProtheusData na pasta "WEB".

O caminho criado será posteriormente utilizado dentro do seu appserver.ini.


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 no padrão soap do portal tradicional. A 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!
Card
labelpasso 2


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 "appserver.ini" do seu ambiente.

Primeiramente deve


1) Deve ser criado

uma sessão

algumas seções para

informar a URL de acesso para a empresa desejada:

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

[HTTPV11]
Enable=1
Sockets=HTTPREST

[HTTPREST]
Port=9103
URIs=HTTPENV1
SECURITY=1

Nesse caso estamos criando uma sessão que será utilizada para o redirecionamento dos arquvios 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.

Em seguida, deve ser criado uma sessão para informar os dados de ambiente acesso para a empresa desejada:

[HTTPENV1]
URL=/restT1
PrepareIn=T1
Instances=2,5
ENVIRONMENT=MeuEnv12117
CORSEnable=1
AllowOrigin=*
Public=fwjwt/refresh_token,auth

[HTTPJOB]
MAIN=HTTP_START
ENVIRONMENT=MeuEnv12117

[ONSTART]
jobs=HTTPJOB
RefreshRate=120

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":

  • Deve ser criado uma sessão abaixo para informar os dados de acesso para a empresa desejada:

[HTTPV11]
Enable=1
Sockets=HTTPREST

[HTTPREST]
Port=9103
URIs=HTTPENV1
SECURITY=1

[HTTPJOB]
MAIN=HTTP_START
ENVIRONMENT=MeuEnv12117

[RESTCONFIG]
userId=UserRH
restPort=9103
RefreshTokenTimeout=300

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

[RESTCONFIG]
restPort=9103
RefreshTokenTimeout=300

Nesse caso estamos criando uma sessão que será utilizada para o redirecionamento dos arquvios 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
  • Na tag "userId" é preciso incluir um usuário do PROTHEUS, que não seja o ADMIN, cadastrado no módulo configurador, para autenticação e segurança dos serviços, no caso utilizamos um usuário exemplo chamado "UserRH".
    • Atenção ao case sensitive na colocação do nome do usuário, pois no caso de erro no preenchimento o ambiente não será inicializado corretamente.
  • Na tag "restPort" deve ser colocado a 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).


Card
labelpasso 3


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.
exemplo: "http://127.0.0.1:9103/restT1" ,onde:

  • 127.0.0.1 = Endereço/ip do seu servidor protheus
  • 9103 = A porta do REST (restPort) configurada no seu appserver.ini na tag [RESTCONFIG]
  • restT1 = essa informação é localizada no seu appserver.ini no item URL, onde
    é configurada o environment relacionado ao serviço REST


Para realizar uma validação, pode-se abrir esse endereço no browser, onde deverá ser carregado a
api da Totvs referente aos serviços REST disponibilizado, caso não aconteça é necessário revisar as
configurações desse serviço no seu "appserver.ini"



tag "rootContext"

Essa tag deve ser configurada com o endereço informado no seu "appserver.ini" que contém as
configurações de localização dos arquivos client.

  • exemplo: "/MeuRH/" ,onde:
    MeuRH = É o complemento da URL principal, onde está configurado a localização,
    dentro do appserver.ini, por exemplo uma tag denominada: [127.0.0.1:8081/T1]
Informações
titleImportante

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



Card
labelpasso 4


Acesso ao aplicativo MeuRH


Após as configurações do serviço e iniciar o seu servidor podemos realizar a verificação e login no aplicativo.

Para realizar o acesso pelo APP é necessário seguir os seguintes passos.

1 - Baixar o APP “Meu RH”

 


2 - Ao abrir o aplicativo pela primeira vez, será apresentada a tela para leitura do QRCode que é gerado de acordo com as configurações do ambiente em sua empresa. Nesse link encontrará informações necessárias para o QrCode: Geração QRCode acesso MeuRH - Linha RM (12.1.17)

cuidado com o case sensitive no momento de definição da URL de acesso, pois caso existam erros no preenchimento pode ocorrer no aplicativo realizar o login, mas em seguida ficar com uma tela em branco, interrompendo o processo de carregamento.

também poderá ser utilizada e executada a página "qrcodegenerator.htm" que se encontra disponível na raiz do pacote cliente do aplicativo, no mesmo lugar do arquivo "properties.json".

No nosso exemplo acima, poderia colar o seguinte texto:
"MeuRH - MeuEnv12117|MeuRH empresa T1|http://127.0.0.1:8081/T1/?restPort=9103"

   



3 - Ao realizar o processo de login dentro do aplicativo MeuRH, é possível acompanhar as autenticações dentro do console do servidor, ou mesmo, em seu arquivo de log (exemplo: "console.log")

    • Essas mensagens poderão auxiliar caso esteja tendo problemas no processo de autenticação.
    • Caso as mensagens não estejam aparecendo no servidor, 3 situações necessitam serem revistas:
      • confirmar se o patch referente ao MeuRH, informado na inicio desse documento, encontra-se aplicado em seu RPO.
      • confirmar as informações utilizada para a geração do QRCode, caso não esteja aparecendo nenhuma informação no console do servidor, a sua requisição de login nem chegou ao server para validação, pois deverá estar apontando para um endereço errado.
      • caso esteja tentando realizar o login, fora da sua rede corporativa, é importante confirmar com o seu time de infraestrutura se o endereço configurado no QRCode está habilitado para receber conexões remotos da internet e não apenas configurado para acesso interno.









...