INTRODUÇÃO


A partir do pacote Logix 12.1.2507 ou Fix Framework Logix 12.1.2503.FIX01 é possível executar programas com interface WEB, desenvolvidos com base em PO-UI (biblioteca de componentes basedos em Angular), mas para isso existem pré-requisitos envolvendo:

  • Versões de build SmartClient e AppServer
  • Configurações de ambiente WEB no arquivo de configuração do AppServer
  • Disponibilização de artefatos das aplicações WEB para o AppServer

Veja abaixo mais detalhes a respeito de cada um destes três itens acima, para viablizar a execução de aplicações WEB a partir do Menu Logix..


Pacote Logix Pré-requisito


(informação) A execuções de aplicações WEB Logix desenvolvidas em PO-UI estão disponíveis a partir do Logix 12.1.2507 ou pacote Framework Logix 12.1.2503.FIX01. (informação)

Caso esteja utilizando uma versão de pacote anterior do Logix, providencie atualização do pacote FIX Framework Logix até o pacote 12.1.2503.FIX01.


Não sabe como atualizar os pacotes FIX Framework Logix? Acessse AQUI


Os pacotes FIX Framework Logix estão disponíveis no PORTAL TOTVS


Versões de build SmartClient e AppServer


(informação) A versão Smartclient que é 100% compatível para executar telas com interface WEB desenvolvidas com base em PO-UI é referente ao build HARPIA (7.210324P). (informação)


A versão Smartclient do build 7.00.131227A, NÃO É COMPATÍVEL e o sistema irá bloquear qualquer tentativa de execução de uma tela WEB Logix para o componente LGX - LWEBDIALOG.


Já a versão Smartclient do build 7.00.170117A (LOBO GUARÁ) compatível com o build AppServer 7.00.131227A (32 bits), permite executar as telas WEB Logix, no entanto com uma restrição:

  • Devido a incompatibilidade da atual versão Angular com a versão da biblioteca Chromium embutida no build Smartclient LOBO GUARÁ, a interface da tela WEB Logix não é apresentada como conteúdo da aba do menu Logix, mas é disponibilizado ao usuário um LINK na parte superior direita da tela que permite a abertura da respectiva tela WEB Logix em uma nova janela utilizando um navegador WEB externo que será de escolha do usuário.


Independente desta exceção de incompatibilidade com a versão do Chromium embutido no SmartClient Desktop, este link de acesso em navegador externo para as telas WEB Logix sempre estará disponível para o usuário utilizar caso surja qualquer tipo de incompatibilidade com a tela WEB que impeça a visualização da sua interface com sucesso no conteúdo da aba do menu Logix.


Configurações de ambiente WEB no arquivo de configuração do AppServer


É necessário definir algumas seções no arquivo de configuração do Appserver:

  • Ativar os serviços HTTP ou HTTPS para execuções com interface WEB.
  • Definir a seção do endpoint /apps que é onde estarão localizados os artefatos das aplicações WEB no servidor.
  • Ativar os serviços de requisições HTTP REST para requisições de APIs REST invocadas pelas aplicações WEB para busca de informações exibidas em tela ao usuário.


Ativando o serviço HTTP/HTTPS para execução da interface das aplicações WEB 

É opcional ativar o serviço HTTP ou HTTPS, mas você precisa optar por um deles OBRIGATORIAMENTE.

No exemplo abaixo apesar de definir a seção HTTP, esta foi configurada como ENABLE=0 para inativar o acesso HTTP (sem segurança). Já a seção HTTPS encontra-se como ativa (ENABLE=1) e neste exemplo vamos mostrar toda a configuração ativa com segurança HTTPS.

Para configurar este serviço e o ambiente para execuções das aplicações WEB Logix, podemos seguir as definições abaixo:

[HTTP]
ENABLE=0   ;*** Pode ser habilitada, se optar por ativar sem segurança HTTPS.
PORT=9193  ;*** Número da porta para viabilizar acesso HTTP ao AppServer
ENVIRONMENT=logix_prd ;*** Ambiente de referência para requisição HTTP
DEFAULTPAGE=wsindex.apw  ;*** Recurso web inicial acessado, nas requisições HTTP quando não informado na URL (Exemplo: http://localhost:9193/) 
PATH=c:\totvs\http

[HTTPS]
ENABLE=1
PORT=9194  ;*** Número da porta para viabilizar acesso HTTPS ao AppServer
ENVIRONMENT=logix12_prd  ;***  Ambiente de referência para requisição HTTPS
DEFAULTPAGE=wsindex.apw  ;*** Recurso web inicial acessado, nas requisições HTTP quando não informado na URL (Exemplo: https://localhost:9194/)
PATH=c:\totvs\http


Definindo o endpoint /apps para definir a localização dos artefatos das aplicações WEB

Um ENDPOINT para acesso de artefatos WEB no appserver.ini é sempre definido com o seguinte formato:  

Onde:

SERVER_IP_OR_HOSTNAME → Nome do servidor (HOSTNAME) ou número de endereço IP do servidor correspondente ao IP do appserver Logix.
PROTOCOL_PORT → Número da porta do protocolo que será utilizado para acesso das aplicações WEB, que pode ser a porta indicada para o serviço HTTP, HTTPS ou porta MULTIPROTOCOLO.
ENDPOINT → é o caminho relativo de um endereço (URL) que permite que um cliente acesse um recurso específico de um servidor web, ou seja isso dará acesso ao ponto final de comunicação entre um browser e os artefatos de uma aplicação WEB no servidor.


Na definição de uma seção de um ENDPOINT para acesso de recursos WEB a partir do Appserver é possível definir:

  • O diretório no disco do servidor de aplicação onde estão localizados os artefatos WEB
  • O ambiente (ENVIRONMENT) que este acesso irá utilizar, ou seja, qual é o RPO, banco de dados e tudo mais que irá respeitar a execução desta aplicação WEB.
  • Entre outras configurações padrões adotadas para todo ENDPOINT configurado, conforme o exemplo abaixo:


Para execução das aplicações WEB Logix é preciso definir obrigatoriamente o endpoint como /apps conforme indicando a pasta raiz onde os artefatos WEB e também o ambiente que será usado pra execução conforme abaixo:

[172.23.155.24:9194/apps]
ENVIRONMENT=logix_prd
RESPONSEJOB=JOBWEB
DEFAULTPAGE=index.html ;*** Recurso web inicial acessado na pasta da aplicação web, quando não for informado na URL (Exemplo: https://localhost:9194/apps/gtrib/gtr10000)
PATH=c:\totvs\web\apps
UPLOADPATH=\upload
CACHE-CONTROL=no-store
PRAGMA=no-cache

O número de IP 172.23.155.24 e PORTA 9194, no exemplo acima, foram apenas utilizados como exemplo, pois devem respeitar os respectivos dados definidos para o Appserver Logix.


A pasta configurada na chave PATH para as aplicações WEB Logix SEMPRE deve ser uma pasta localizada no servidor com nome de subpasta final como apps.  ATENÇÃO! Crie a pasta apps com letras minúsculas, ou seja, precisa ser /apps (seleção) e NÃO /APPS (erro))

No exemplo acima [172.23.155.24:9194/apps] no endpoint /apps foi usado o número de endereço de IP do servidor de aplicação e foi definido apenas para a porta 9194, que neste caso era para o acesso via porta HTTPS.

Caso opte em informar o HOSTNAME do servidor ao invés do número de endereço IP, é possível configurar no arquivo de profile do Logix a chave logix.app.hostname com o nome do servidor.


No arquivo de profile, se estiver definida a chave desta forma:


       logix.app.hostname = "meuservidor"


Lembrando que "meuservidor" é um hostname que responde a um endereço de IP válido e no arquivo appserver.ini na seção do endpoint /apps é feita a troca do número de endereço IP pelo HOSTNAME da seguinte forma:

[meuservidor:9194/apps]
ENVIRONMENT=logix_prd
RESPONSEJOB=JOBWEB
DEFAULTPAGE=index.html ;*** Recurso web inicial acessado na pasta da aplicação web, quando não for informado na URL (Exemplo: https://localhost:9194/apps/gtrib/gtr10000)
PATH=c:\totvs\web\apps
UPLOADPATH=\upload
CACHE-CONTROL=no-store
PRAGMA=no-cache


Veja que tem /apps no nome da seção [meuservidor:9194/apps] e também tem /apps como subpasta na chave PATH e precisa ser com letras minúsculas a pasta /apps OK?

O valor definido para a chave ENVIRONMENT no exemplo acima você deve usar o nome do ambiente que indica o caminho do RPO e banco de dados que usará pra conexão da aplicação WEB.


Ativando o serviço HTTP REST para requisições API REST

O serviço que permite acionar requisições HTTP REST no AppServer é disponibilizado em uma porta diferente das portas definidas para os serviços HTTP e HTTPS, e este serviço HTTP REST não basta definir o ambiente do Logix e em que porta ficará disponível para acesso, mas precisa executar um JOB que disponibiliza um conjunto de Threads, denominadas "Working Threads" que ficam "a espera" de requisições API REST para serem executadas. Apesar do serviço HTTP REST funcionar semelhante ao serviço de requisições HTTP SOAP, este serviço responde única e exclusivamente requisições no formato REST.


As configurações para ativar o serviço REST para atender as requisições HTTP REST das aplicações WEB resume-se a definir as seções abaixo no arquivo appserver.ini:

[ONSTART]
REFRESHRATE=30
JOBS=HTTPJOB 

[HTTPJOB]
MAIN=HTTP_START
ENVIRONMENT=logix12_ora  ;*** Nome do Ambiente Logix, pode ser modificado

[HTTPV11]
ENABLE=1
SOCKETS=HTTPREST
TIMEOUT=600 

[HTTPREST]
PORT=8580   ;*** Porta utilizada na URI, pode ser modificada
URIS=URIAPPS
SECURITY=1  ;*** quando aqui o valor for 1, é obrigatório configurar seções HTTPS e SSLCONFIGURE indicando o certificado SSL.

[URIAPPS]
URL=/   ;*** Endereço base pra atender as requisições REST. Exemplo: http://localhost:8580/api/vdp/v1/clientes
INSTANCES=10,40,3,10   ;*** Número de instâncias utilizadas para atender as requisições REST (quantidade inicial e máxima de instâncias, quantidade minima livre e quantidade de novas instancias quando limite mímimo livre for alcançado)
ONSTART=LOGIXRESTSTART
ONCONNECT=LOGIXRESTCONNECT
ONEXIT=LOGIXRESTEXIT 
CORSENABLE=1
ALLOWORIGIN=*  ;;*** Aqui o padrão assumido é * mas caso exista uma restrição de acessos é preciso configurar a lista de permissões

Seção ONSTART

A seção ONSTART é responsável por definir a lista de JOBS que serão iniciados automaticamente no momento em que o AppServer é iniciado e a chave REFRESHRATE é responsável por monitorar se a lista de JOBS indicados está em execução a cada intervalo de segundos informado. Quando algum JOB informado na lista não estiver em execução, o AppServer automaticamente irá colocar o JOB para executar, garantindo assim que não ficará inativo, caso ocorra qualquer interrupção.

No exemplo abaixo veja que foi definido o JOB chamado HTTPJOB, sendo que o AppServer pode ter definido na chave JOBS uma lista, separada por vírgula ( , ).


Seção HTTPJOB

Na seção HTTPJOB, a chave MAIN é definida com a função HTTP_START existente no Repositório Logix e que é responsável por dar início a um conjunto de "Working Treads" que se mantém em execução no AppServer, a espera de requisições API REST para execução.

As quantidades de Working Threads (instâncias) para atender as requisições HTTP REST simultâneas é configurada conforme Instances.


Seção HTTPV11

Para habilitar o serviço HTTP REST será necessário criar a seção abaixo no appserver.ini:

[HTTPV11]
Enable=1
Sockets=HTTPREST
Timeout=600

Parâmetro

Descrição

Obrigatório

EnableIndica se o HTTP esta habilitado.   (1 - Habilitado    0 - Desabilitado)x
Sockets

A chave Sockets referencia as seções com a configuração de porta e URL que a mesma irá atender, permitindo que o Application Server seja configurado com mais de uma porta HTTP do REST.   Exemplo:  Sockets=HTTPREST,HTTPREST2

É necessário definir ao menos uma seção.

x
TimeoutTempo (em segundos) que uma requisição REST aguarda para obter uma resposta, sem emitir falha por tempo excedido.


Seção Socket HTTPREST

Para a seção Socket chamada HTTPREST deve-se indicar algumas configurações como URIS que apontam os endPoints disponíveis pra requisições REST, número de porta em que as requisições REST podem ser acionadas, e determinar a segurança, onde irá exigir ou não autenticação.

[HTTPREST] 
Port=8085
URIs=URIAPPS
Security=1

Parâmetro

Descrição

Obrigatório

PortNúmero da porta que o serviço HTTP REST irá assumir.x
URIs

A chave URIs referencia as seções com a configuração da URL que a porta irá atender. Pode ser configurado mais de uma URL.
Exemplo: URIs=HTTPURI,HTTPURI2

Configure ao menos uma seção.

x
Security

Indica se a autenticação de requisição esta habilitada.

Recomenda-se fortemente que esta chave seja configurada como 1 (Habilitado) para garantir a exigência de autenticação em todas as requisições HTTP REST executadas pelo AppServer.

Ao ativar SECURITY=1 é necessário configurar outras chaves que indicarão o caminho do certificado e chave, e o protocolo de segurança utilizado (SSL/TLS).

Acesse LGX - Comunicação REST e leia as orientações a respeito de como ativar a autenticação REST no tópico Ativando Autenticação REST.		x



O HTTP do REST verifica existência do campo Authorization no HEADER da requisição para requisições REST em geral, mas para requisições REST realizadas a partir de aplicações WEB a autenticação é realizada exclusivamente pelo existência do campo AppSession no HEADER, e ambos os controles de autorização são realizados pelo framework do produto que está utilizando o protocolo.

Seção URIAPPS 

Exemplo de configuração da seção URIAPPS para requisições REST das aplicações WEB Logix:

Parâmetro

Descrição

Obrigatório

URLIndica o endereço URL que será atendida a requisição REST.x
Instances

Configuração de inicialização de working threads. 

A chave Instances é configurada como no HTTP do SOAP.
Para mais detalhes acesse Instances.

x
OnStart

Determina a função acionada ao iniciar qualquer Thread destinada ao funcionamento do REST.
Sempre manter como LOGIXRESTSTART para produto ERP Logix.

x
OnConnect

Função de inicialização, conexão e execução de qualquer Thread destinada a uma requisição REST.
Sempre manter como LOGIXRESTCONNECT para produto ERP Logix.

x
OnExit

Determina a função acionada na finalização de qualquer Thread destinada ao funcionamento do REST
Sempre manter como LOGIXRESTEXIT para produto ERP Logix.

x
CorsEnable

Ativa o recurso para gerenciamento de páginas permissíveis de recebimento de dados do servidor, recurso anti-CSRF.

É sugerido manter esta chave com o valor 1 para aceitar requisições de APPs Web Logix.

x
AllowOrigin

Essa chave limita os IPs que o REST do Logix pode responder, deve conter o valor * (responder para qualquer IP) ou informar a lista de IPs aceitos.

É importante sempre avaliar o conceito de uso para avaliar o uso ou não das chaves CORSENABLE e ALLOWORIGIN.

Por padrão é sugerido informar como * (Qualquer IP).

x




Disponibilização de artefatos das aplicações WEB Logix no AppServer


Após configurar e ativar os serviços HTTP, HTTP REST e definir o ENDPOINT /apps no AppServer, falta apenas disponibilizar os artefatos WEB para execução da interface das aplicações WEB Logix. 

Para isso você precisará descompactar os arquivos de artefatos WEB correspondentes a cada aplicação WEB na respectiva pasta e subpasta indicada na documentação disponibilizada por cada time Logix responsável pela aplicação.

Na pasta principal de cada aplicação WEB existirá o arquivo inicial chamado Index.html.

Segue um exemplo para a aplicação WEB Logix GTR10000, disponibilizada na estrutura /apps/gtrib/gtr10000:


É muito importante que todos artefatos da aplicação WEB estejam na pasta raiz da aplicação. Vejam que nesta imagem acima o arquivo index.html e todos demais artefatos WEB do programa gtr10000 estão na pasta final gtr10000/. 

Veja que além da pasta /apps ser definida em letras minúsculas, é preciso também respeitar o caminho relativo da aplicação WEB em questão, que neste caso é /gtrib que também exige uso de letras mínúsculas.

A pasta /gtrib é a indicação do módulo ao qual pertence a aplicação e essa informação consta no pacote de atualização da aplicação ou na respectiva documentação disponibilizada no portal TDN pelo time responsável pela aplicação. Em caso de dúvidas sobre a pasta de destino da aplicação WEB, entre em contato com o time de atendimento responsável pela aplicação.

A última parte deste caminho relativo é a pasta da aplicação, que neste caso é a pasta /gtr10000 e novamente ela precisa OBRIGATORIAMENTE ser definida com letras minúsculas.

Portanto todo caminhor relativo da aplicação WEB e também a pasta principal da aplicação precisa ser criada sempre com letras minúsculas, para evitarmos qualquer tipo de problema no acesso das aplicações via browser, que tem por padrão diferenciar letras maiúsculas e minúsculas (CASE SENSITIVE).




  NÃO ESQUEÇA DAS PERMISSÕES DE ACESSO DO USUÁRIO!

   Você precisa:

      Losango - ícones de formas grátis Cadastrar a aplicação WEB Logix no menu do produto em (LOG00112 - Central de Menu Logix >> Níveis de Processos) com o tipo de processo 2 (INTEROP)

      Losango - ícones de formas grátis Registrar as devidas permissões de acesso para o usuário em (LOG05050 - Central de Usuários >> Permissões de Acesso)

   Só assim o usuário vai conseguir encontrar o atalho dessa aplicação no menu OK? 


 PRONTO! (grande sorriso) Agora que os artefatos WEB das aplicações Logix já estão devidamente alocados na pasta raiz apps, que é a mesma pasta configurada nas chave PATH da seção [<SERVER_IP>:<PORT_HTTP_or_HTTPS>/apps] do appserver, é só realizar o teste de acesso da aplicação WEB a partir do menu Logix.


DICA FINAL (caso tenha problemas para executar as aplicações WEB Logix)


Se tiver algum problema para executar as aplicações WEB Logix após tudo ser corretamente configurado com base nas intruções acima, tente investigar primeiramente o que está acusando problema e realize o seguinte passo a passo num ambiente de testes/homologação:

  • Revisar todas configurações acima se foram corretamente registradas
  • Ativar o debug Framework no arquivo de profile (chaves logix.source.debug=1 e logix.debug=1) ou então a partir do menu logix executar a aplicação WEB Logix usando a opção DEBUG FRAMEWORK. 
  • Caso tenha optado em ativar as chaves de DEBUG FRAMEWORK manualmente no arquivo de profile, antes de executar a aplicação WEB, lembre-se de que é preciso limpar o arquivo console.log do Appserver e no build Harpia será preciso encerrar o serviço do AppServer, excluir o arquivo console.log e reiniciá-lo o AppServer.
  • Após a apresentação da mensagem de aviso que não foi possível executar a aplicação WEB, finalize a aplicação retornando para o menu do produto e capture o arquivo de LOG gerado via DEBUG FRAMEWORK ou o próprio arquivo console.log do appServer, caso tenha optado em ativar manualmente as chaves de DEBUG no arquivo profile.
  • No arquivo de LOG gerado com DEBUG FRAMEWORK, procure pelo identificador [APPWEB] e acompanhe as mensagens geradas com este identificador, pois é bem possível que você já consiga identificar o motivo da aplicação WEB não ter sido executada.
  • Se mesmo assim você não conseguir identificar o problema, entre em contato com nosso time de suporte e na abertura de ticket, faça o seguinte:
    • Informe qual é a aplicação WEB Logix,
    • Envie um PRINT do caminho e conteúdo da pasta do servidor de aplicação onde estão armazenados os artefatos WEB da aplicação LOGIX
    • Anexe o arquivo appsever.ini do seu AppServer onde configurou a execução da aplicação WEB.
    • Anexo o arquivo de profile utilizado por este appserver.ini



Se surgir qualquer dúvida ou problema com relação a algum tópico aqui descrito, entre em contato com o suporte do time Framework Logix para apoiar no que for preciso.