Instalação/Atualização eDocs

Ao iniciar o instalador/atualizador do eDocs, será realizada uma verificação para detectar se existe ou não o .NET Framework 4.8 instalado no computador que está sendo utilizado. Caso ele não exista, será apresentada a seguinte mensagem: Não foi encontrado o .NET Framework ou a versão instalada não atende aos pré-requisitos, deseja realizar a instalação agora? apresentando as opções Sim e Não para selecionar. Estas opções apresentam os seguintes comportamentos:

• Caso seja selecionada a opção Sim: o arquivo do instalador do .NET Framework 4.8 será baixado do FTP da Senior e sua instalação será iniciada logo após o término do download. Quando a instalação for finalizada será necessário reiniciar o computador antes de prosseguir com a instalação do eDocs. Para isto, durante a instalação do framework, será apresentada uma mensagem perguntando se deseja reiniciar no momento da instalação do .NET Framework 4.8 ou após este processo. Depois que o computador for reiniciado e o instalador/atualizador do eDocs for executado novamente, a instalação do sistema continuará normalmente;
• Caso seja selecionada a opção Não: o instalador/atualizador do eDocs será fechado e, para dar continuidade ao processo de instalação do sistema, deverá ser aberto novamente para selecionar a opção Sim, ou deve-se instalar o framework manualmente.

Ao executar o instalador/atualizador o sistema vai verificar se o .NET Framework já está instalado na máquina, caso não encontre será apresentado um aviso solicitando a instalação.

O instalador, informações para instalação e os requisitos da versão do .NET Framework podem ser obtidos no site do fabricante. (http://www.microsoft.com/pt-br).

Os requisitos para a instalação do eDocs podem ser consultados na página Pré Requisitos.

Existem algumas configurações que devem ser realizadas no IIS antes de iniciar a instalação do eDocs, clique aqui e confira.

Caso o processo de instalação automática do MongoDB não seja realizado corretamente pelo Instalador do eDocs, será necessário realizar a instalação manualmente seguindo os passos relacionados abaixo:

1. Faça o download da versão 4.2.13 do MongoDB pelo link https://fastdl.mongodb.org/win32/mongodb-win32-x86_64-2012plus-4.2.13-signed.msi;
2. Execute o arquivo .MSI como administrador;
3. Inicie a instalação clicando em Next;
4. Após ler e aceitar o contrato clique em Next;
5. Selecione a opção Custom;
6. Em seguida, escolha como local de instalação C:\MongoDB\, provavelmente será necessário criar a pasta MongoDB na máquina;
7. Clique em Next;
8. Clique em Next;
9. Desmarque a opção MongoDB Compass e clique em Next;
10. Clique em Install;
11. Clique em Finish;
12. Acesse no sistema eDocs a tela do Configurações > Gerais > MongoDB;
13. Informe no campo Exige autenticação o valor Não;
14. Informe o valor edocs no campo Base de dados;
15. Informe o nome da máquina ou localhost no campo Servidor, caso o MongoDB e o eDocs estejam instalados na mesma máquina;
16. Informe o valor 27017 no campo Porta;
17. Clique no botão Salvar para concluir a instalação do MongoDB.

Em casos onde o RabbitMQ é instalado utilizando dados de conexão fora do padrão, é necessário realizar a configuração do cliente para a conexão. Para isso é necessário configurar o RabbitMQ no cliente remoto, o arquivo SdeCliente.exe.config tem as seguintes novas linhas:

<appSettings>
	<add key="portaBroker" value="" />
	<add key="portaBrokerGerenciamento" value="" />
	<add key="usuarioBroker" value="" />
	<add key="senhaBroker" value="" />
	<add key="virtualHostBroker" value="" />
</appSettings>	

Essa configuração é necessária somente quando o RabbitMQ não utiliza as configurações padrões de porta e usuários, caso contrário o sistema realiza a conexão sem a necessidade de configurações. Elas sobrescrevem as configurações feitas por dentro do sistema e permitem alterar os dados de conexão do RabbitMQ, é possível alterar os seguintes valores:

• portaBroker: Porta em que o broker de mensagens do RabbitMQ se conecta;
• portaBrokerGerenciamento: Porta do console de gerenciamento do RabbitMQ;
• usuarioBroker: Usuário usado para se conectar no RabbitMQ (deve ser diferente de guest);
• senhaBroker: Senha usada para se conectar no RabbitMQ (deve ser diferente de guest);
• virtualHostBroker: Virtual host onde serão criadas as filas do eDocs;

Instalação em diretório de rede (compartilhamento)

Caso a instalação seja realizada em um diretório compartilhado na rede, é necessário executar a ferramenta Caspol para identificar o diretório como confiável. Para isso execute o comando CasPol.exe -m -ag 1.2 -url file://<caminho de instalação>/Sde/* FullTrust.

Em <caminho de instalação> informe o caminho onde será instalado o serviço do eDocs, incluindo a pasta /Sde que será criada pelo instalador.

Exemplo: CasPol.exe -m -ag 1.2 -url file://\\servidor\diretorio\Senior\NomeInstalacao\Sde/* FullTrust

Quando instalado em um diretório na rede deve-se também alterar a propriedade Carregar Perfil do Usuário para true nas opções avançadas do Pools de Aplicativos no IIS.

Mais informações no site da Microsoft.

RabbitMQ

Neste ambiente, o instalador do produto não consegue realizar a instalação do RabbitMQ de forma automática, sendo necessário a instalação e configuração antes da instalação do produto.

Devem também ser adicionados os plugins: "rabbitmq_management", "rabbitmq_shovel" e "rabbitmq_shovel_management"

Comandos para ativação dos plugins (executar dentro do diretório de instalação do RabbitMQ na basta "sbin"):

• rabbitmq-plugins enable rabbitmq_management
• rabbitmq-plugins enable rabbitmq_shovel
• rabbitmq-plugins enable rabbitmq_shovel_management

Para detalhes dos procedimentos para habilitação de plugins no RabbitMQconsulte a documentação oficial.

Durante a instalação podem ser apresentadas mensagens informando que não foi possível realizar a configuração dos plugins do RabbitMQ, uma vez que esse processo foi realizado de forma manual o sistema deve operar normalmente.

A instalação e ativação do RabbitMQsó deve ser realizada uma vez, não sendo necessário realizar esse procedimento nas atualizações do produto. Uma vez que não existam mudanças nos requisitos mínimos de versão do RabbitMQ.

Atualização automática do RabbitMQ

No momento da instalação ou atualização do RabbitMQ, será realizada a criação ou alteração, respectivamente, do arquivo de configuração desta funcionalidade. Este comportamento realizará a limpeza do arquivo de log e a alteração do nível de log do RabbitMQ. Isso pode acontecer de acordo com os seguintes cenários:

1. Caso na pasta principal de configuração do RabbitMQ não exista o arquivo rabbitmq.conf e na pasta config do RabbitMQ não exista o arquivo rabbitmq.config, a rotina criará o arquivo rabbitmq.conf com as configurações padrões;
2. Caso exista o arquivo rabbitmq.conf, a rotina vai verificar se as configurações aplicadas já existem dentro do arquivo. Se existirem mesmo que seja com outros valores, as informações existentes não serão alteradas e somente serão adicionadas as informações faltantes. Caso todas informações já existam no arquivo, a rotina não altera nada;
3. Caso não exista um rabbitmq.conf, mas exista um rabbitmq.config, a rotina não realizará nenhuma alteração.

Segue abaixo o exemplo de locais dos arquivos de configuração do RabbitMQ:

• Local da pasta raiz de configuração: C:\Users{usuário}\AppData\Roaming\RabbitMQ\rabbitmq.conf
• Local da pasta config: C:\Users{usuário}\AppData\Roaming\RabbitMQ\config\rabbitmq.config

Quando for necessário aplicar ou alterar os valores do RabbitMQ, as configurações a serem aplicadas são:

• log.file.rotation.size = 10485760
• log.file.rotation.count = 1
• log.file.level = error

A efetivação das alterações realizadas pela criação ou alteração do arquivo de configuração (rabbitmq.conf) passam a valer de forma natural quando o sistema for iniciado novamente.

1. Ao executar o instalador pela primeira vez, será exibida a tela de “Boas Vindas” onde o usuário apenas precisa clicar em Próximo.

2. A próxima tela é de “Identificação das instalações”. Se não tiver nenhuma instalação do produto na máquina, essa tela aparecerá em branco, conforme mostra a imagem abaixo:

3. No campo Nova Instalação o usuário deverá informar o nome que deseja dar para essa instalação. Esse mesmo nome será utilizado para acessar o Monitor através do browser, onde na versão anterior era acessado por http://localhost/monitor, por exemplo, agora será acessado por http://localhost/[nome da instalação].

Nesse campo não deve ser informado diretório de instalação, apenas o nome da instalação.

4. O nome da instalação não pode conter caracteres especiais. Após informado o nome, basta clicar em Próximo. O sistema irá mostrar a tela para a escolha do local de instalação:
   

O instalador continua sugerindo o local padrão de instalação como “C:\Senior\SDE” e em seguida coloca o nome da instalação que foi informada anteriormente. Para cada instalação do eDocs será criada uma nova pasta. O usuário pode mudar esse caminho.

5. A próxima tela é para escolha do local do Menu Iniciar onde será criado o atalho para essa instalação. Basta escolher e clicar em Próximo.

6. Em seguida deve-se selecionar quais os componentes que se deseja instalar, por padrão todos serão marcados.

7. Logo após será exibido o Gerenciador Senior de Banco de Dados (GSBD) para realizar a configuração do banco de dados.

Ao selecionar o banco de dados, serão habilitados os campos respectivos à conexão:

• Servidor: IP ou endereço do servidor;
• Porta: Será sugerida a porta padrão de conexão, podendo ser alterada conforme a necessidade;
• Usuário e senha: conforme cadastro;
• Base de dados: em caso de banco de dados SQL Server, preencher com o nome da base de dados a ser utilizada;
• Nome do serviço: em caso de banco de dados Oracle, Service name ou SID do banco de dados.

Para configurar o acesso a uma base do eDocs já existente, as informações de acesso à base devem ser preenchidas e deve-se clicar em Executar. Neste caso, o sistema verifica a versão da base de dados e caso seja a mesma do executável, não faz a instalação e grava as informações de acesso.

Ao clicar no botão Executar será realizada a mesma validação que é executada no botão Testar Conexão, como forma de garantir a consistência das informações, evitando problemas na criação/atualização da base de dados.

8. Em seguida será realizada uma verificação na base de dados para garantir a versão do banco de dados, permissões do usuário e a integridade das constraints do banco.

Caso forem encontradas inconsistências na base de dados, elas serão exibidas na tela de alterações do banco de dados e a instalação será cancelada. O botão Salvar Log permite salvar o arquivo de log gerado com as inconsistências encontradas ou o log de instalação Instalação.log é salvo no diretório de destino, mesmo quando ocorrerem erros. E caso o processo de verificação não encontre nenhuma inconsistência a instalação pode ser iniciada.

Erros ou problemas que não foram detectados pelas validações continuarão ocorrendo, tais como questões de ambiente (FrameWork, IIS ou outros).

Caso a verificação ocorra sem nenhuma inconsistência encontrada, ao clicar em Fechar a instalação será iniciada.

9. Após a instalação finalizar deve-se clicar em Próximo.

10. Será apresentada a tela para executar o aplicativo Configurador. No caso de instalação é obrigatório executar este aplicativo, então a opção já vem marcada. Basta clicar em Terminar.

Instalação do cliente remoto

Ao realizar o download das mídias SDE (Senior Documentos Eletrônicos), execute o arquivo localizado na pasta Instalador PDV para executar a instalação do cliente remoto. Quando o arquivo for executado, siga os seguintes passos:

1. Na tela inicial da instalação do cliente remoto clique no botão Próximo para selecionar o local da instalação
   

2. Na tela de seleção do local da instalação, clique em Próximo para que o instalador utilize o local padrão;

3. Após a seleção do local, selecione a pasta do menu Iniciar que será utilizada pela instalação do cliente remoto. Recomendamos que utilize a pasta sugerida pelo instalador. Clique em Instalar para que a instalação seja realizada.

4. Quando a instalação for concluída com sucesso, clique em Fechar para sair da tela do instalador.

Configurar RabbitMQ no cliente remoto

Para realizar a instalação do cliente remoto no sistema operacional Windows primeiramente é necessário ter o sistema eDocs instalado, seguindo os passos do item Instalação, para depois configurar o RabbitMQ no cliente remoto de acordo com os seguintes passos:

• Criar um usuário específico para o eDocs utilizando a interface de gerenciamento do RabbitMQ;
• Nos parâmetros do cliente remoto, localizados na pasta de instalação e denominados como SdeCliente.exe.config, configurar o usuário, a senha e o virtual host. Obrigatoriamente o virtual host precisa ser diferente de eDocs para a instalação do cliente remoto;
• Após concluir as etapas destacadas acima, é necessário reiniciar o serviço Senior Documentos Eletrônicos - Cliente usando a interface do Windows;
• Quando reiniciado, validar que o virtual host e filas do cliente remoto foram criadas corretamente utilizando a interface de gerenciamento do RabbitMQ.

Configurar conexão com o cliente remoto no servidor

Para realizar a configuração do cliente remoto no servidor, é necessário seguir os seguintes passos:

• No caminho Configurações > Filiais > Geral > Clientes Remotos configure os dados de conexão atribuídos no config do cliente remoto;
• Realize o teste de conexão para validar que está funcionando corretamente;
• Sincronize as configurações do servidor com o cliente remoto utilizando o botão Sincronizar da tela de Clientes Remotos;
• Valide se a sincronização finalizou corretamente pela tela de processamentos na tela de Monitoramento de processamentos em segundo plano;
• Verifique se os arquivos .sde foram criados corretamente na pasta de instalação do cliente remoto.

Caso exista uma ou mais instalações do produto na máquina, ao executar o instalador/atualizador, elas serão mostradas na tela inicial.

Para atualizar uma instalação, basta clicar sobre ela na tela de Instalações Existentes e depois clicar em Próximo.

No caso da atualização, o atualizador detecta o caminho onde a instalação selecionada está, o menu e os componentes e não permite que seja alterado. Basta clicar em Próximo.

As próximas telas aparecem desabilitadas para o usuário e só é possível clicar em Próximo e depois em Instalar. Nesta etapa, o atualizador do eDocs realizará automaticamente a conexão com o banco de dados configurado. Caso a conexão não seja estabelecida, ou quando o atualizador não encontrar o registro dos dados de conexão com o banco de dados, a tela do GSBD será apresentada para que as informações dos dados de conexão com o banco de dados sejam registradas. Caso a conexão com o banco de dados seja estabelecida com sucesso, a rotina prosseguirá automaticamente para a etapa de verificação da base de dados.

Logo após o estabelecimento da conexão, será realizada uma verificação na base de dados para garantir que não faltem parâmetros necessários no banco de dados, permissões do usuário e que não haja chaves duplicadas.

Se forem encontradas inconsistências na base de dados, elas serão exibidas na tela de alterações do banco de dados e a atualização será cancelada sem a necessidade de remover a versão já instalada do produto. O botão Salvar Log permite salvar o arquivo de log gerado com as inconsistências encontradas ou o log de instalação Instalação.log é salvo no diretório de destino, mesmo quando ocorrerem erros. E caso o processo de verificação não encontre nenhuma inconsistência, a atualização pode ser iniciada.

O backup da base de dados é obrigatório, erros ou problemas que não foram detectados pelas validações continuarão ocorrendo, como por exemplo, questões de ambiente. Porém, antes da remoção do produto, não é necessário reinstalar a versão anterior do produto, basta apenas restaurar a base de dados. Para os ambientes que utilizam o banco de dados Oracle, é necessário realizar o backup da base de dados via EXPDP para garantir a integridade dos dados.

Caso a verificação ocorra sem nenhuma inconsistência encontrada, ao clicar em Fechar a instalação será iniciada.

Acessar o Instalador, selecionar a instância desejada e clicar em Próximo.

Com isso, será mostrado o caminho onde está instalada esta instância do eDocs.

Para que todas as funcionalidades do Monitor sejam executadas corretamente, existem parametrizações específicas a serem efetuadas no IIS do Servidor onde está instalado o Monitor, após o término da instalação. Estas informações são imprescindíveis de serem realizadas e podem ser encontradas no tópico Configurando IIS Windows 2008 Server ou superior.