Execução de aplicações WEB Logix utilizando componente LWebDialog - LGX

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

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. 

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

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

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.

       logix.app.hostname = "meuservidor"

[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

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

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

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

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

 PRONTO! 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