CONTEÚDO

Visão Geral
Exemplo de utilização

01. VISÃO GERAL

Validar o ambiente, instalar e atualizar os produtos web TOTVS Varejo Supermercados.

02. EXEMPLO DE UTILIZAÇÃO

Caminho

Publica Web – GLO00053

Pré-Requisitos e Restrições

O Publica Web é compatível somente à partir do Windows Server 2012, conforme sistema operacionais homologados.
É recomendado que toda a publicação seja feita utilizando o protocolo https para maior segurança.
É necessário ter o .Net Framework v4.8 ou superior instalado.
É necessário instalar os bundles .Net Core 3.1.31 e .Net Core 6.0.22 (a partir da versão 24.01).
É necessário ter o Oracle Client 32-bit com o arquivo tnsnames.ora configurado.
É necessário que o usuário tenha permissão de administrador e leitura/escrita nos diretórios do servidor.
Ao utilizar a funcionalidade de “Exclusão” de uma publicação, alguns antivírus (ex: Trend Micro) podem interceptar o funcionamento da ferramenta com suspeita de ransomware, gerando um falso-positivo, já que a operação de exclusão de arquivos dentro da pasta “inetpub” por um software de terceiro pode caracterizar um possível ataque. A recomendação caso isso ocorra, é adicionar nas exceções do antivírus o nome do executável ou então a assinatura digital da TOTVS.
O Publica Web deve ser executado apenas no servidor de aplicação web (IIS), no qual hospeda ou hospedará as publicações TOTVS Varejo Supermercados.
A distribuição do Publica Web é feita por meio do pacote de atualização de versão, disponibilizada pela ferramenta Agente de Atualização.

Passo a Passo

Verificação de Pré-requisitos de Ambiente

Ao iniciar a aplicação, será realizada a checagem dos pré-requisitos mínimos necessários para instalação ou atualização das publicações web no servidor. Somente será possível avançar para as próximas etapas, se não houver nenhum item com status de Não atende.

Na sequência da tela, os dados de verificação são agrupados em categorias e divididos em três colunas:

Na primeira coluna são listadas as regras que serão verificadas.
Na segunda coluna são exibidos os resultados das verificações.
Na terceira coluna é apresentado o status da verificação, sendo:

Atende: Os valores atendem aos pré-requisitos.
Atende com ressalva: Os valores não atendem os pré-requisitos mas não são impeditivos para o funcionamento do produto (ex: pode afetar desempenho).
Não atende: Os valores não atendem aos pré-requisitos e são impeditivos.
Informação não disponível: Não foi possível obter os valores para verificação.

Alguns pré-requisitos possuem descritivo com explicações ou orientações para que o item seja atendido. Para visualizar, basta clicar sobre o item que a informação será exibida na parte inferior da aplicação, conforme o exemplo acima.

Para revalidar os requisitos, basta clicar no botão simbolizado com um ícone de 'atualizar', ao lado do botão 'Exportar'

Tela Principal

Publicação: Lista os produtos já publicados no ambiente para consultá-los.
Nova publicação: Publicar um novo produto.
Registrar aplicações e relatórios: Refaz o registro de aplicações e relatórios para a publicação selecionada.*¹
Excluir publicação: Remove a publicação selecionada.
Abrir site: Abre o navegador com o endereço do site.
Editar conexão: Edita a conexão do site selecionado.
Habilitar HTTPS: Cria/altera o endereço com o protocolo HTTPS. Usado para criar/alterar o endereço no IIS com o protocolo HTTPS de acesso ao site. Atenção: O servidor deve ter um certificado válido instalado para que a utilização do protocolo Https ocorra sem problemas.
Limpar: Limpa todos os campos da tela.
Avançar: Instala ou atualiza a publicação conforme dados informados.
Recarregar pacotes: Recarrega a lista de pacotes instalados e os pacotes disponíveis para instalação/atualização.

*¹ É possível registrar apenas pacote selecionados os pacotes segurando a tecla SHIFT, para selecionar um grupo, ou CTRL, para selecionando itens individuais. Após selecionar os pacotes, clique com o botão direito e selecione a opção 'Registrar Aplicações'. Para que a opção esteja disponível, o pacote deve estar com o serviço no status 'Iniciado'.

Nova Publicação

Ao clicar em Nova Publicação, será exibido a tela abaixo com os produtos disponíveis para publicação.

Recomenda-se não alterar o Nome da publicação sugerido pela ferramenta para manter o padrão de instalação das publicações, o que facilitará o suporte e possíveis evoluções futuras do produto.

Produto: Produto a ser publicado no servidor.
Ambiente: Tipo de ambiente: Produção ou Homologação
Nome: Nome da publicação que será criada no IIS.
Porta: Porta de acesso ao site (ex: http://sistema.totvs.com.br:90).
Porta da API: Para uso interno. Para publicações que não utilizam o site de API, basta informar a porta 0. Se informada a porta do site de APIs já publicado, o novo site passará a utilizá-lo também.
Protocolo: Protocolo a ser utilizado na publicação.
Certificado: Será possível selecionar o certificado digital já instalado no servidor caso a opção do protocolo seja https.
Endereço: Será possível informar o endereço DNS caso a opção do protocolo seja https. (ex: totvs.meudominio.com.br).
Diretório: Caminho ao qual os pacotes serão instalados. A recomendação é utilizar o diretório padrão do IIS, ao qual o campo já vem preenchido.

A aplicação permite criar várias publicações do tipo de ambiente Produção para cada produto no mesmo ambiente, porém uma mensagem de aviso será exibida caso já exista uma publicação do produto em produção. Não há limites para criação de publicações para o tipo de ambiente Homologação. As portas informadas para a nova publicação não podem estar em uso por outra publicação, caso contrário a aplicação não permitirá a continuar.

Após clicar em OK na tela de Nova Publicação, confirme as aplicações e versões a serem publicadas, e informe os dados de conexão com o banco de dados, conforme exemplo acima.

Servidor: Alias do servidor de banco de dados (o mesmo do tnsnames.ora)
Usuário: Usuário do ERP no banco de dados (ex: CONSINCO)
Senha: Senha do usuário do ERP
Testar Conexão: Realiza um teste de conexão com a base de dados informada.
Recarregar pacotes: Recarrega a lista de pacotes instalados e os pacotes disponíveis para instalar ou atualizar.

Ao clicar em avançar, se as configurações estiverem OK, o processo de instalação será iniciado exibindo as etapas do processo, conforme o exemplo abaixo.

Se ocorrer algum erro durante as etapas de execução, a linha referente a etapa que falhou ficará em vermelho e na mensagem de finalização será solicitado que os erros sejam verificados, conforme o exemplo abaixo.

Caso a instalação ou atualização ocorra sem nenhum problema, a tela abaixo será exibida. Clique em Concluir para voltar a tela principal.

Exportar: Permite exportar o log gerado em tela para arquivo texto.

A aplicação também armazena em seu diretório corrente, os logs em arquivo texto de todas as execuções, caso seja necessário encaminhar para análise de suporte. Após a finalização da instalação, uma página de teste será aberta para validar a instalação.

Atualizar uma Publicação

Para atualizar um produto, basta selecionar a publicação no campo Publicação conforme o exemplo abaixo e clicar em Avançar.

IMPORTANTE: A atualização do ERP atualmente exige que as publicações dos produtos ALW (RF WMS) e RF (Comercial) também sejam atualizados.
Os módulo obrigatórios serão sempre atualizados, não sendo possível desmarcá-los.
É recomendado que os módulos opcionais instalados sejam atualizados constantemente junto aos módulos obrigatórios.

Ao clicar em avançar, se as configurações estiverem OK e a versão do pacote for superior a versão atual do produto, o processo de atualização será iniciado, exibindo as etapas do processo, conforme o exemplo abaixo.

Ao selecionar uma publicação que já está atualizada e clicar em Avançar, uma mensagem informativa será exibida, conforme o exemplo abaixo.

Excluir Publicação

Para excluir uma publicação, basta clicar no botão Excluir Publicação e confirmar a mensagem de aviso. Será exibida uma mensagem se deseja criar o backup da publicação.

Troca de Senha do Banco de Dados

Para trocar a senha do banco de dados de uma publicação, selecione a publicação desejada e clique em Editar dados da conexão. Após informar os novos dados de conexão, clique em Avançar.

Estando OK com a conexão, a aplicação mostrará o andamento da alteração nos arquivos de configuração até a conclusão do processo. Uma página de teste será aberta em seguida a conclusão da troca de senha para validar a alteração aplicada.

Alterando endereço de conexão e portas da publicação

Para alterar o endereço e/ou portas da publicação, basta alterar as informações nos campos “Endereço”, “Habilitar HTTPS”, “Porta” ou “Porta API” e clicar em avançar.

Se habilitar o https, será exibida uma mensagem se deseja informar o certificado e selecionada opção Sim será exibido o formulário, conforme imagem abaixo.

Para saber como importar um certificado no IIS, veja a documentação.

ATENÇÃO: O certificado deve estar válido e instalado no IIS no repositório (Store) como Personal para que apareça na ferramenta.

Ao avançar, será exibido o progresso e o log de alteração.

Registrar aplicações de pacotes

É possível realizar o registro de aplicações dos pacotes selecionados. Para isso, basta selecioná-los na lista e clicar com o botão direito em um deles, e selecionar a opção Registrar aplicações, conforme imagem abaixo.

Para selecionar vários pacotes, basta segurar a tecla CTRL, para ir selecionando individualmente, ou a tecla SHIFT, para selecionar todos os itens entre os cliques.

OBS: A opção de Registrar aplicações só será visível caso o Status do serviços seja Iniciado em ao menos um dos itens selecionados e a tarefa só será executada para esses itens com esse status.

Remover pacotes individuais

Para remover pacotes individuais, basta selecioná-los na lista e clicar com o botão direito para que seja exibida a opção Remover pacote e serão adicionados a lista de exclusão. Os itens marcados, ficarão em vermelho e serão removidos ao clicar no botão Avançar.

OBS: Somente os pacotes do grupo Opcionais poderão ser removidos separadamente e desde que o Status esteja como Iniciado.

Gerenciamento de site, pools de aplicação e serviços

Foram incluídos os recursos listados abaixo para facilitar o gerenciamento de sites e pools de aplicação:

Visualização do status do pool ou serviços: Iniciado, Parado ou Desconhecido.

Gerenciamento do pool de aplicação.

Para realizar esse procedimento, clique com o botão direito sob o produto.

Abrirá o menu com as opções para gerenciamento: Parar Pool/Reciclar Pool.

Gerenciamento do site.

Para realizar esse procedimento, clique no botão direito no combo de "Publicação".

Serão exibidas as opções para o gerenciamento do site: Parar Site/Reciclar Site/Iniciar Site.

Opção "Marcar Todos" e "Desmarcar Todos".

Clique com o botão direito em qualquer área da lista de produtos, será exibida as opções para Marcar Todos e Desmarcar Todos.

Execução em modo silencioso

A aplicação pode ser inicializada com passagem de parâmetros conforme descrito abaixo:

autoexec
Usado para que a execução se inicie sem interação humana, ou seja, execução silenciosa.
salvalog
Usado para informar a geração de log da aplicação. Serão criados arquivos na pasta Logs, no mesmo diretório da aplicação, tendo como padrão o nome como “log_ddMMyyyyHHmmss.json”.
-c <servidor> <usuário> <senha> <tipoAmbiente>
Para informar a conexão com a base de dados, deve-se utilizar o marcador -c seguido do servidor, usuário, senha e tipo do ambiente P ou H (Produção ou Homologação), nessa ordem e sempre com essas informações. A aplicação irá buscar no TNSNAMES os dados de conexão, então é preciso que o arquivo esteja configurado corretamente.
nomepacote=<pacote>
Utilizado somente na ferramenta de setup web para informar qual o pacote principal será instalado. Estão disponíveis os seguintes pacotes:
Nome Pacote
Descrição Pacote (Nome Interface)
LOCWEB_RFWEB Consinco ALW
HOST Consinco Corp
OMSMOBILE Consinco OMS Mobile
SMWEB_RFWEB Consinco RF
INTEGRASIMPLUS Consinco Simplus
HOSTWEB Consinco Web

tipoinstalacao=<tipo>
Utilizado somente na ferramenta de setup web para informar o tipo de instalação, se é completa ou apenas os pacotes do produto padrão. Os valores possíveis são: P (Padrão) ou C (Completa)
host=<endereço>
Utilizado para informar um host para o site que será publicado. Se não for informado, será considerado o ip local da máquina.
nomesite=<nome>
Utilizado para nomear o site. Caso não seja informado, seja considerado o nome de exibição parametrizado no pacote. Ao remover uma publicação, o nome do site deve ser sempre informado.
porta=<numero>
Utilizado para informar uma porta específica a ser usada na publicação do site. Caso não seja informada, seja considerada a porta padrão parametrizado no pacote.
portaapi=<numero>
Utilizado para informar uma porta específica a ser usada na publicação do site de API. Caso não seja informada, seja considerada a porta padrão parametrizado no pacote.
hashcertificado=<codigohash>
Utilizado para fazer uma publicação usando HTTPS e SSL. Deve ser informado o código hash do certificado (impressão digital/thumbnail) que está instalado no servidor.
alteraconexao
Ao informar este parâmetro, serão atualizados os dados de conexão da publicação informada pelo parâmetro nomesite ou, caso não seja informado, pelo nomepacote. É obrigatório informar os dados de conexão.
removerpublicacao
Utilizado para fazer a remoção da publicação com base no nome do site informado. Sendo assim, é obrigatório informar o nome do site a ser removido.
criarbackup
Utilizado para informar se, ao remover uma publicação, deve ser criado um backup da publicação.
diretorio=<caminho>
Utilizado para informar outro diretório a ser instalado o site. Caso não seja informado, será considerado o diretório padrão do IIS.
hotfix
Utilizado para que seja possível aplicar os pacotes disponibilizados na pasta InstallationFiles no modo silencioso. É necessário informar o parâmetro nomesite para que seja possível aplicar os pacotes.

Os parâmetros podem ser informados em qualquer ordem, exceto o parâmetro de conexão que, ao informar o marcador, deve seguir a ordem estabelecida na documentação.

Ao executar em modo silencioso, um ícone de sistema irá exibir as informações atuais da execução, conforme imagem abaixo.

Os arquivos de log gerados, seguem o modelo de exemplo abaixo:

log_20210222120944.json

{
  "nomeExecutavel": "PublicaWeb.exe",
  "versaoExecutavel": "2.4.0.0",
  "id": 1,
  "sistemaOperacional": {
    "nome": "Windows 10 Pro",
    "versao": "10.0.19042.0",
    "build": "19042",
    "release": "2009"
  },
  "nivel": "Erro",
  "dominio": "SP01",
  "nomeMaquina": "RBPN019403893",
  "nomeUsuario": "vitor.gilioli",
  "dataHora": "12/01/2022 16:48:52",
  "mensagem": "Os requisitos abaixo não passaram na validação:\r\n.NET Core Hosting Bundle 2.2.8",
  "detalhes": "Pacote: HOST",
  "stack": "",
  "palavrasChave": [
    "TOTVS",
    "supermercados",
    "setup",
    "erro",
    "instalação",
    "iis",
    "requisitos"
  ]
}

log_20220112164852.json

{
  "nomeExecutavel": "Publica Web.exe",
  "versaoExecutavel": "2.4.1.0",
  "id": 0,
  "sistemaOperacional": {
    "nome": "Windows 10 Pro",
    "versao": "10.0.19042.0",
    "build": "19042",
    "release": "2009"
  },
  "nivel": "Aviso",
  "dominio": "SP01",
  "nomeMaquina": "RBPN019403893",
  "nomeUsuario": "vitor.gilioli",
  "dataHora": "14/01/2022 13:54:40",
  "mensagem": "A instalação do site Consinco_Web foi concluída.\nOcorreu algum erro durante a instalação.\nVeja os detalhes de instalação para mais informações!",
  "detalhes": "Pacote: HOSTWEB",
  "stack": "",
  "palavrasChave": [
    "TOTVS",
    "supermercados",
    "setup",
    "instalação",
    "iis",
    "aviso"
  ]
}

log_20220225173444.json

{
  "nomeExecutavel": "Publica Web.exe",
  "versaoExecutavel": "2.4.1.0",
  "id": 0,
  "sistemaOperacional": {
    "nome": "Windows 10 Pro",
    "versao": "10.0.19042.0",
    "build": "19042",
    "release": "2009"
  },
  "nivel": "Sucesso",
  "dominio": "SP01",
  "nomeMaquina": "RBPN019403893",
  "nomeUsuario": "vitor.gilioli",
  "dataHora": "14/01/2022 13:54:40",
  "mensagem": "A instalação do site Consinco_Web foi concluída.",
  "detalhes": "Pacote: HOSTWEB",
  "stack": "",
  "palavrasChave": [
    "TOTVS",
    "supermercados",
    "setup",
    "instalação",
    "iis",
    "sucesso"
  ]
}

Além do log, é gerado a exportação dos detalhes da instalação para análise detalhada.

Exemplo de chamada

"Publica Web.exe" autoexec salvalog -c ORCL CONSINCO CONSINCO123 P nomepacote=HOSTWEB tipoinstalacao=P

Código de Saída

A aplicação irá lançar um código de saída (exitCode) com o valor 0, caso tenha finalizado a execução com sucesso, o valor 1 caso tenha apresentado algum erro durante a execução e o valor 2 caso seja um aviso ou alerta. Para ambas as situações, se for passado o parâmetro salvalog, a aplicação irá gerar sempre o arquivo de log referente ao momento de encerramento da aplicação, seja por sucesso ou erro.

Valores de saída:
0 - Sucesso
1 - Erro
2 - Alerta
3 - Informação

Nome Pacote	Descrição Pacote (Nome Interface)
LOCWEB_RFWEB	Consinco ALW
HOST	Consinco Corp
OMSMOBILE	Consinco OMS Mobile
SMWEB_RFWEB	Consinco RF
INTEGRASIMPLUS	Consinco Simplus
HOSTWEB	Consinco Web

Árvore de páginas

Publica Web