Árvore de páginas

Versões comparadas

Chave

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

A partir de 05/07/2021 o nome do Consinco Web Setup será Publica Web.

CONTEÚDO

  1. Visão Geral
  2. Exemplo de utilização
  3. Tela Publica Web
    1. Outras Ações / Ações relacionadas
  4. Tela Publica Web
    1. Principais Campos e Parâmetros
  5. Tabelas utilizadas


01. VISÃO GERAL

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


02. EXEMPLO DE UTILIZAÇÃO

Caminho

Publica Web – ALM00002

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 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 anti-ví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 anti-vírus o nome do executável ou então a assinatura digital da Consinco.
  • O Publica Web deve ser executado apenas no servidor de aplicação web (IIS), no qual hospeda ou hospedará as publicações Consinco.
  • Publica Web  substitui e incorpora todas as funcionalidades das ferramentas anteriores: C5Setup, C5Update (Consinco Web Update) e Consinco Web Checker.
  • A distribuição do Publica Web será feita por meio do pacote de atualização de versão, disponibilizada pela ferramenta Sync, da mesma forma como era feito até então com o Consinco Web Update.
  • O Publica Web está disponível à partir da versão 19.06.015.
  • À partir do uso do Publica Web , todos os módulos e sites listados serão atualizados pela ferramenta, não sendo mais necessário atualizar manualmente os pacotes.
  • Para usuários não administradores que não tenham permissão de alterar o arquivo Consinco.ini, o Windows pode replicar o arquivo para o diretório Virtual Store (%UserProfile%\AppData\Local\VirtualStore) e gerar confusão no apontamento do banco de dados da aplicaçã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 impeditivopara 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çãoLista 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.

Nova Publicação

Ao clicar em Nova, 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 facilita o suporte e possíveis evoluções futuras do produto.

  • ProdutoProduto 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.consinco.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.

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.

Gerenciamento de site e pools de aplicação

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

  • Visualização do status do pool da aplicação. Exibindo os status: 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 Poll/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. O parâmetro tipo ambiente é opcional e se não for informado será considerado que a conexão é com ambiente de produção.
  • nomepacote=<pacote>
    Utilizado somente na ferramenta de setup web para informar qual o pacote principal será instalado. Estão disponíveis os seguintes pacotes: HOSTWEBHOSTSMWEB_RFWEBLOCWEB_RFWEBINTEGRASIMPLUS.
  • 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.
  • 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/thumbail) que está instalado no servidor.

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:

Bloco de código
firstline1
titlelog_20210222120944.json
linenumberstrue
collapsetrue
{
  "nomeExecutavel": "Consinco Web Setup.exe",
  "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": "22/02/2021 12:09:44",
  "mensagem": "A instalação do site Consinco_Web foi concluída.\nOcorreu erro(s) durante a instalação.\nVeja o log para mais informações",
  "stack": "",
  "palavrasChave": [
    "consinco",
    "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 ou o valor 1 caso tenha apresentado algum erro durante a execução. 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.

03. TELA Publica Web

Outras Ações / Ações relacionadas

Não há.

04. TELA Publica Web

Principais Campos e Parâmetros

Não há.

05. TABELAS UTILIZADAS

Não há.