Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Migration of unmigrated content due to installation of a new plugin
Aviso

Nessa etapa do passo a passo os clientes que encontram-se na release 12.1.25, poderão utilizar essa a configuração via APWebWizard (Parte 1)ApWebWizard, para as releases anteriores deverão realizar a configuração complementar utilizando (Parte 2)manualmente.

Caso encontre dificuldades configurando pelo ApWebWizard consulte a aba Configurando manualmente e valide as informações.

Painel
1) Importante:
Deck of Cards
historyfalse
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.

Configurando o arquivo "properties.json"
Card
labelParte 1 - Configurando pelo wizard
Card
labelParte 2 - Configurando manualmente
ApWebWizard


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

Na parte superior preencha:

  • Porta REST → informe a porta rest da seção HTTPREST.
  • Endereço completo do servidor REST → informe o endereço que utiliza para acessar o REST no browser, inclusive com http://.
  • MeuRH Console Log Habilitado → caso deseje controlar a geração de mensagens no console.log.

Image Added


Na parte inferior de Hosts do MeuRH, preencha:

  • Nome do host → poderá ser um endereço local em sua rede corporativa, um endereço IP externo de acesso, nesse caso não pode ser informado a palavra "http" no nome, apenas a raiz base e o complemento do contexto + porta HTTP.
  • Host habilitado → marque essa opção.
  • Caminhos dos arquivos cliente (PATH) → diretório onde foram extraídos os aquivos baixados no primeiro passo.
  • Página principal do host → index.html

Image Added


Abaixo temos exemplos de configurações de hosts existentes para o MeuRH, estes serão responsáveis em realizar os acessos diretamente via browser e também farão parte da construção do QRCode para realizar os acessos via aplicativo. O "nome do host" poderá ser um endereço local em sua rede corporativa, ou mesmo, um endereço IP externo de acesso, nesse caso não será necessário informar a palavra "HTTP://" no nome, apenas a raiz base e o complemento do contexto + porta HTTP.

Image Added


Após finalizar essa configuração, encontraremos as seguintes tags no arquivo "appserver.ini":

[localhost:9293/T1]
ENABLE=1
PATH=C:\P12BASES\P12127SISTDB\PROTHEUS_DATA_SIS\web\PortalMeuRH
DEFAULTPAGE=index.html

[10.173.7.142:9293

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:8081TOTVSProtheusProtheusDataWeb\PortalRHUnificado
ENVIRONMENT=MeuEnv12117
INSTANCENAME=MeuRHT1
DEFAULTPAGE=index.html

/T1]
ENABLE=1
PATH=C:\

P12BASES\

P12127SISTDB\

PROTHEUS_DATA_

SIS\

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:

WEB\PortalMeuRh
DEFAULTPAGE=index.html

[RESTCONFIG]
restPort=9191
MeuRHLog=1
HostsRest=http://localhost:9191/restT1,localhost:9293,10.173.7.142:9293 

Nota
titleSeção [RESTCONFIG]

Ela é criada exclusivamente para utilização da arquitetura do App MeuRH:

  • A palavra 'restPort'  é utilizada pelos serviços de backend por isso a obrigatoriedade do seu preenchimento, sendo assim, apesar do protheus em seu appserver permitir que se possa instanciar várias portas REST, em virtude da arquitetura do meurh esse contexto não é permitido.


  • Em relação a palavra 'MeuRHLog' ela auxilia no processo de login e manutenção para identificar possíveis dificuldades no processo de configuração e divergências de login, posteriormente, também pode ser desligada utilizando o valor '0' para melhorar a performance de resposta do aplicativo.


  • Em relação a palavra 'HostsRest', as configurações automáticas do Wizard carregam esta informação replicando os hosts que poderão ser acessados.
Card
labelJSON

Configurando o arquivo properties.json

    • 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

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

Esse

O arquivo properties_exemplo.json encontra-se

no

na 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. 

.

Após localizar o arquivo properties_exemplo.json, renomear para properties.json .

Image Added



As tags que atualizaremos dentro de arquivo são:

"

baseUrl

"

e

"

rootContext

"

:

Tag "
  • Tag baseUrl
"

Essa tag deve ser configurada com o endereço do REST,

onde no exemplo

 Exemplo

"

http://10.

172

173.

36

7.

45

142:

810310.172

9191/restT1

"

.

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
    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/restT1o contexto será /T1/

    , apenas quando configurar uma URL diferente para cada empresa.


    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

    173.

    36

    7.

    45

    142:

    8103

    9191/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 } ] }


        }
    }
     

    Aviso
    titleImportante

    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)

    Atente-se na atualização

    desse

    do 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

    , a baseUrl e o rootContext devem estar configurados de acordo com seu ambiente.

    Painel
    titleConfigurando App MeuRH via APWebWizard

    Card
    label5) REST CARREGANDO

    Validando serviço REST ativo

    Para identificarmos se o serviço REST está carregando adequadamente, verificamos se é possível realizar o carregamento dos serviços via browser:

    Observe que utilizamos a porta 9191 do REST criada anteriormente, assim o nome da URL definida utilizará sem o rootContext.

    Localhost:

    Image Added

    IP:

    Image Added


    Card
    labelConfigurando 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

    , criando uma [seção] auxiliar 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

    Client.

    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

    utilizando o conceito de rede externa será permitido que o aplicativo funcione quando os colaboradores de sua empresa estivem conectado fora de sua rede corporativa.

    Aviso
    titleImportante!

    Lembre-se de não utilizar

    localhost

    LOCALHOST ou 127.0.0.1, pois estes indicam "

    este computador

    Host local", ou seja,

    quando você configura com localhost

    com essa esse endereço não é possível acessar de

    nenhum outro computador ou smartphone.A Porta de exemplo "8081

    outro dispositivo.


    Para a configuração manual iremos utilizar como exemplo um ip ainda não utilizado nos exemplos anteriores "10.173.3.216", informamos o endereço que utiliza para acessar o REST no browser com "http://"

    Exemplo: http://10.173.3.216:4040/50

    A porta de exemplo "4040" corresponde a sua

    tag "

    chave Port

    "

    configurada na

    sessão "

    seção HTTP

    "

    que já deverá existir no seu

    "

    appserver.ini

    "

    .

    Realizamos essa configuração no passo anterior dessa página!.

    Sendo assim, ficaria dessa forma:

    [10.173.3.216:4040/50

    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

    P12BASES\

    Protheus

    P12127SISTDB\

    Protheus

    PROTHEUS_DATA_

    Data

    SIS\

    Web

    WEB\

    PortalRHUnificado
    ENVIRONMENT=MeuEnv12117
    INSTANCENAME=MeuRHT1

    PortalMeuRh
    DEFAULTPAGE=index.html

    Agora criaremos mais essa sessão


    Criaremos também a seção abaixo no

    seu

    arquivo

    "

    appserver.ini

    ":Na sessão "RESTCONFIG" são criadas tags

    RESTCONFIG onde são criadas chaves utilizadas para o

    projeto MeuRH Protheus

    Meu RH:

    A tag "restPort" é obrigatória e
    • restPortdeve ser preenchida com a mesma porta utilizada na
    sessão "
    • seção HTTPREST
    "
    • dentro da chave
    PORT,
    • 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"
    • 4141.
    • meurhLogcontrola 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

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

    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

    temos um exemplo: 

    "

    http://10.

    172

    173.

    36

    3.

    45

    216:

    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"

    4141/rest50


    • Tag rootContext
    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/restT1o contexto será /T1/

    , apenas quando configurar uma URL diferente para cada empresa, acesse o exemplo: Configuração para mais de um grupo de empresa, no exemplo será vazio.

    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

    173.

    36

    3.

    45

    216:

    8103

    4141/

    restT1

    rest50",


           "rootContext":

    "/

    T1

    50/"

    }, "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.


        }
    }
     

    Aviso
    titleImportante

    Atente-se na atualização do arquivo properties.json, a baseUrl e o rootContext devem estar configurados de acordo com seu ambiente.

    Card
    label5) REST CARREGANDO

    Validando serviço REST ativo

    Para identificarmos se o serviço REST está carregando adequadamente, verificamos se é possível realizar o carregamento dos serviços via browser:

    Observe que utilizamos a porta 4141 do REST criada anteriormente, assim o nome da URL definida /rest50.

    Localhost:

    Image Added


    IP:

    Image Added


    Aviso
    titleSOBRE TIMEOUT E SESSIONTIMEOUT


    TIMEOUT

    Esta chave tem influência direta na comunicação HTTPS. Durante o SSL handshake cliente e servidor negociam protocolo e cifra para a realização de comunicação segura. Se o servidor não recebe uma resposta do cliente, ele deve aguardar um tempo máximo. Esta chave configura este tempo. Esta chave está disponível a partir da versão Application Server - 19.3.1.5

    Referência: Timeout na Chave [SSLCONFIGURE] 


    SESSIONTIMEOUT

    Define o intervalo, em segundos, das variáveis da sessão do usuário ao utilizar uma configuração de workig threads extended para atender, através de link .APW, solicitações de geração de páginas dinâmicas em Advpl. (Não se aplica ao Aplicativo Meu RH).

    Referência: SessionTimeOut na Seção [HTTP]


    ** Atualmente não foi implementado para o aplicativo Meu RH alguma configuração que tenha como objetivo editar o tempo de desconexão do aplicativo Meu Rh. 

    Nota
    titleDicas

    1) O MEURH utiliza algumas chaves importantes que permitem serem atribuídas para trazer mais vantagens em diferentes configurações efetuadas, seguem alguns assuntos relacionados:

    2) Configuração do MEURH utilizando conceito de pastas compartilhadas:



    Button
    Cor#00BFFF
    TextoPróximo passo!
    Linkhttps://tdn.totvs.com/x/6femHQ