Versões comparadas

Chave

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

...

Painel
titleinstalação e habilitação
Deck of Cards
iddeck principal
Card
labelpasso 1


Atualizando os arquivos Client MeuRH


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.




Confirmando a associação do usuário do Portal Gestão do Capital Humano


  • Durante o processo de configuração do Portal Padrão do RH GCH (Gestão do Capital Humano) foi necessário realizar a associação de um usuário do portal ao cadastro do participante (tabela RD0), como demonstrado no campo da imagem abaixo. Todavia, é importante realizar um relacionamento complementar para a utilização do aplicativo móvel MeuRH.



  • No cadastro do "Usuário do portal" (SIGATCF/Atualizações/Configurações/Usuários/Genéricos) que foi associado ao cadastro do participante, na tela acima, existe um campo denominado "Usuário int.".

    Caso ainda não tenha sido feito nenhum relacionamento/preenchimento desse campo com o cadastro de usuário (responsável em realizar o login no smartclient), será necessário atualizar esse cadastro e criar esse relacionamento com um usuário.

    É fundamental a execução desse processo de relacionamento, pois o serviço REST utiliza esse usuário do Protheus para a geração do token de autenticação e permissão de acesso aos serviços publicados.

    Informações
    titleperfil de usuário

    É importantíssimo que esse usuário relacionado NÃO possua perfil de administrador, devendo ser um usuário comum de acesso ao smartclient. Isso é uma restrição de segurança das funções de framework para a geração dos tokens de acesso.

    Como sugestão, pode-se criar um usuário especifico para ser utilizado nessa funcionalidade!



  • Exemplo abaixo do cadastro de usuários do protheus (SIGATCF/Miscelanea/Usuários) utilizado no relacionado com o usuário do portal. .



Card
labelpasso 2


Configurando o serviço REST via APWebWizard


O APWebWizard é responsável por fazer as atualizações no seu arquivo "appserver.ini" de acordo com sua necessidade para a criação dos serviços.
Para iniciarmos, conforme imagem abaixo, realize a chamada via smartclient para o seu ambiente desejado:


1) Inicialmente, caso ainda não possua um serviço HTTP, precisaremos cria-lo, como no exemplo da imagem abaixo:

Informando uma pasta do servidor com o caminho para os serviços Web, a porta do HTTP e o ambiente a ser utilizado.
É importante selecionar também "Protocolo habilitado" para permitir ao servidor responder as requisições que chegarem!



2) Nessa fase vamos habilitar o serviço REST no server Protheus:

Escolha a opção REST do menu, em seguida o item HTTPV11, e clique no botão "editar configurações".
Conforme imagem abaixo, devemos configurar o socket com a porta do REST.

É importante selecionar o item "habilitado" para permitir ao servidor responder as requisições que chegarem!
Também é importante, marcar o item "Autenticação", para que os acessos sejam validados, visto que por padrão todos os serviços REST da TOTVS são públicos.

Na parte inferior da imagem, devemos informar as configurações para a montagem da URL que estará disponível com a relação dos serviços a serem consumidos.
Sendo possível configurar uma URL diferente para cada empresa, nesse caso sugerimos utilizar o nome da URL com o complemento da empresa para apoiar na identificação. No exemplo da imagem, como nossa empresa de teste é T1, o novo da URL seria "/restT1"

Na segunda imagem desse item 2, podemos configurar as informações sobre o certificado SSL, lembrando que para esse caso também deverá ser configurado um server HTTPs para que possa responder das solicitações REST em SSL. Continuando nessa segunda imagem, devemos informar outros parâmetros:

    • "Habilitar Cors" deve estar marcado, assim como "Allow Origin" preenchido com '*' (asterisco) para permitir que o server possa responder requisições de outros servidores.
    • "Endpoints publicos" deverá estar preenchido com as informações 'fwjwt/refresh_token,auth' , pois são os endpoints iniciais responsáveis pela autenticação e geração do token de acesso aos serviços.

Após a confirmação dessas configurações, deverá estar visualizando clicar no botão de confirmação, deverá ser possível visualizar a terceira imagem final da sequencia desse item 2 de configuração!

Uma dica interessante:

    • É possível utilizar um servidor Protheus (AppServer) apenas 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, caso necessário, reinicializar um server sem prejudicar o outro!





3) Nessa fase vamos criar um processo comum que criará um job para inicializar o serviço do REST criado anteriormente:

Como na imagem abaixo, devemos informar:

    • O nome para o JOB.
    • O ambiente relacionado para o serviço REST.
    • Informar o nome da função que inicializa o serviço, obrigatoriamente: "HTTP_START"
    • Marcar a opção "Habilitar job no start do servidor Protheus"

Image Added




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:

[HTTPV11]
Enable=1
Sockets=HTTPREST

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

[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".

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]
ENABLE=1
PATH=C:\TOTVS\Protheus\Protheus_Data\Web\PortalRHUnificado
ENVIRONMENT=MeuEnv12117
INSTANCENAME=MeuRHT1
DEFAULTPAGE=index.html

[RESTCONFIG]
restPort=9103
RefreshTokenTimeout=300
meurhLog=1

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.




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 "properties.json", atualizações realizadas incorretamente, podem ocasionar problemas no carregamento do aplicativo após o processo de autenticação do usuário.



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 (diferenciação entre letras minusculas e maiúsculas) no momento de definição da URL de acesso, pois caso existam erros no preenchimento podem ocorrer no aplicativo realizar o login. Como por exemplo, escrever erradamente "Restport" ou deixar de colocar o ponto de interrogação na URL.

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.







...