Instalação do sistema

A seguir são descritos os procedimentos que devem ser realizados para instalar o sistema. Antes de proceder com a instalação, verifique os requisitos do sistema e as recomendações de segurança que devem ser observadas na instalação e no uso do sistema.

Configuração do banco de dados

  1. Instale e configure um SGBD compatível com o sistema. Mais detalhes da instalação podem ser obtidos no manual Bancos de dados.
  2. No servidor de aplicação, instale e configure o cliente do banco de dados, caso utilize o Oracle ou o Microsoft SQL Server, ou habilite a comunicação entre o servidor de aplicação e o banco de dados no arquivo pg_hba.conf, no caso do PostgreSQL.

Configuração inicial do servidor de aplicação

  1. Descompacte em um diretório do servidor o executável Engine e suas dependências. Esses binários são disponibilizados pelo fornecedor do sistema ou podem ser obtidos a partir da página “/install” de um servidor Engine que esteja executando a mesma versão que será instalada.
  2. Instale o Engine como serviço seguindo as instruções da página /install.
  3. Execute o Engine e abra o navegador no endereço http://127.0.0.1:<porta>/manage. No Windows, essa porta será por padrão a 80. No Linux, será a 8080. O Engine poderá utilizar uma porta diferente caso exista um outro serviço utilizando essas portas. Nesse caso, a porta utilizada pelo Engine pode ser consultada no arquivo “logs/engine.log”, localizado no diretório de instalação do sistema.
  4. Na interface do Manage, devem ser realizadas as seguintes configurações:
    1. Altere a senha de acesso ao Manage em “Configuration > General”.
    2. Ative a opção “Profiler Enabled” em “Configuration > General”. Observação: a opção “Automatic Profiler Active” nunca deve ser ativada em um servidor de produção.
    3. Em “Configuration > Ports”, configure as portas TCP que serão utilizadas pelo sistema. Deve ser ao menos configurada uma porta no protocolo “HTTP”, sendo recomendado o uso da porta padrão 80. Atualmente, a emissão de certificados digitais pode ser realizada sem custos adicionais, portanto é recomendada a configuração de uma porta HTTPS para permitir o acesso seguro ao sistema e evitar a interferência de softwares de terceiros na comunicação do sistema, como firewalls, proxies e aplicativos de antivírus. Mais detalhes dessa configuração no manual Configuração do HTTPS no Engine.
    4. Em “Configuration > Databases”, configure o acesso ao banco de dados. Mais detalhes dessa configuração no manual Bancos de dados.
    5. Em “Configuration > Domains”, deve ser configurado o acesso HTTP do sistema. Exceto nos cenários de uso de múltiplas bases de dados em um mesmo servidor Engine, essa configuração deve ser preenchida com os seguintes valores:
      • Host: default
      • Port: deixar o campo vazio
      • DB Server Host: 127.0.0.1
      • DB Server Port: porta do protocolo HTTP configurada em Ports
      • DB Name: nome da base de dados configurado em Databases
      • Disable VirtualFS: desmarcado
      • Enable: marcado
    6. É recomendado que a opção “Configuration > Others > SyncToDisk” seja alterada para “off” se forem instalados vários Engines em um mesmo servidor, operando em um mesmo disco físico ou em discos persistentes servidos por um storage externo. Ao desativar a opção “SyncToDisk”, há um aumento no risco de corrupção do cache local do Engine em um eventual desligamento forçado do sistema, portanto essa opção deve ser desativada apenas em servidores de alta disponibilidade e se houver benefício de desempenho com a sua desativação.
  5. Após a configuração do Manage, reinicie o servidor e acesse novamente o Manage na porta HTTP configurada. Verifique em “Log > dbCache.log” se o sistema falhou ao montar o cache local, indicando as ausências das tabelas do sistema na base de dados. Caso positivo, a base de dados está pronta para ser restaurada. Caso haja alguma falha de conectividade com a base de dados, revise a configuração do SGBD e a configuração “Configuration > Databases” no Manage. Caso esteja utilizando o Oracle ou o Microsoft SQL Server, verifique se o cliente instalado no servidor de aplicação está instalado e configurado corretamente, na mesma arquitetura (32 ou 64 bits) do Engine.

Importante: os servidores dos Engines com acesso à base de dados devem estar configurados no mesmo fuso horário. Esse fuso horário será utilizado para registrar os eventos nas tabelas de log de auditoria do sistema.

Restauração da base de dados a partir de um template

  1. O fornecedor do sistema disponibilizará uma cópia de uma base de dados “template” adequada para o perfil do negócio. Essa cópia será disponibilizada em um arquivo proprietário com extensão “.isdbcef”.
  2. Instale um Engine cliente de uma base de dados que já esteja em funcionamento no servidor de aplicação. Esse Engine será necessário para executar o processo de restauração da cópia da base de dados “template”. Esse procedimento deverá ser realizado pelo fornecedor do sistema caso seja a instalação da primeira base de dados e não tenha acesso a uma outra base de dados já configurada.
  3. No Engine cliente, execute o processo “Desenvolvimento > Bases de dados > Migração > Restaurar cópia” informando os seguintes campos:
    • Caminho do arquivo: caminho para o arquivo com extensão “.isdbcef”.
    • IP ou URL: 127.0.0.1:<porta do novo servidor>
    • Nome da base: <nome da nova base de dados>
    • Os demais campos, incluindo usuário e senha, devem ser deixados em branco.
  4. Após concluir a restauração da cópia, deve ser reiniciado o Engine. Se a restauração tiver sido bem sucedida, ao acessar “http://127.0.0.1:<porta do novo servidor>” deverá ser exibida a tela de login do sistema.

Licenciamento do sistema

  1. O usuário e senha inicial de acesso ao sistema deverão ser disponibilizados pelo fornecedor do sistema.
  2. O fornecedor do sistema fornecerá os dados de licenciamento por meio de um ou mais códigos de licenciamento. Esses códigos deverão ser inseridos no sistema por meio do processo “Admin > Licenciamento > Produtos licenciados”. Caso já exista um licenciamento inicial da base de dados, é recomendado que os produtos licenciados sejam removidos antes que os novos códigos sejam inseridos.
  3. Ao inserir o primeiro código de licenciamento, será solicitada a criação de uma senha para o usuário “administrator”. É fortemente recomendado que o administrador realize a criação da senha, caso contrário, o usuário “administrator” permanecerá com a senha padrão definida pelo fornecedor do sistema até que realize a solicitação de troca de senha. A senha cadastrada deve ser guardada e não deve ser compartilhada com o fornecedor do sistema, pois “administrator” é um usuário do sistema com privilégios especiais, entre eles o acesso irrestrito aos dados do sistema. A conta “administrator” não deve ser utilizada nas operações do dia-a-dia, sendo requerida apenas em operações muito específicas do sistema.

Observação: ao criar cópias da base de produção para fins de desenvolvimento ou homologação, esta etapa de licenciamento não é necessária. A cópia restaurada já estará licenciada com as mesmas definições da base de produção.

Criação dos índices e estatísticas

  1. Utilize o processo “Desenvolvimento > Base de dados > Atualizar estrutura” e crie todos os índices no banco de dados que forem sugeridos por esse processo.
  2. Solicite ao DBA para atualizar as estatísticas das tabelas e índices da nova base de dados, incluindo os histogramas das colunas. A atualização dessas estatísticas deve ser periódica, sendo recomendado que elas sejam atualizadas ao menos uma vez por mês.

Configuração dos administradores do sistema

  1. Crie grupos e papéis dos usuários que farão a parametrização inicial do sistema. Para esses usuários, é comum que seja dado acesso a todas as classes de dados do sistema, permissões que poderão ser revogadas posteriormente durante a evolução da parametrização da base de dados. Para fins de praticidade, o sistema já possui os grupos padrões “Administradores” e “Desenvolvedores” que podem ser utilizados para esse fim. Mais detalhes nos manuais Grupos e Papéis e Permissões.
  2. Crie os usuários que irão realizar a parametrização inicial do sistema e associe aos grupos “Administradores” e “Desenvolvedores”, ou aos outros grupos e papéis criados. Mais detalhes no manual Usuários.
  3. A partir deste momento, o usuário “administrator” não deve ser mais utilizado nas configurações do sistema e no seu lugar deve ser utilizada uma conta de usuário que identifique o profissional responsável pelas configurações.

Observação: ao criar cópias da base de produção para fins de desenvolvimento ou homologação, essa configuração não será necessária por ser uma cópia da base de produção. No entanto, é recomendado que as contas de usuários que não precisem ter acesso a esses ambientes sejam desativadas.

Configurações gerais

  1. Configure o título e subtítulo da base de dados que serão exibidos na tela de login do sistema. É recomendado que o subtítulo das bases de desenvolvimento e homologação seja configurado para diferenciá-las da base de produção. Mais detalhes no manual Tela de login.
  2. Configure a política de privacidade do sistema.
  3. Configure os endereços de acesso ao sistema.
  4. Cadastre todos os Engines configurados como servidores de aplicação e de borda no processo “Admin > Servidores > Engines servidores”. Esse cadastro permite a atualização e reinicialização automática dessas instâncias durante as atualizações do sistema.

Servidor SMTP padrão para o envio de e-mails

Para que o sistema possa enviar e-mails é necessário que seja configurado um servidor SMTP no processo “Admin > E-mails > Servidores SMTP”. É importante que sempre haja um servidor SMTP padrão configurado para que os fluxos automatizados de envio de e-mail, como o de redefinição de senha do usuário, funcionem corretamente.

Observação: na versão 70 ou inferior do Engine, a configuração do servidor SMTP também deve ser realizada na página “Configuration > General” do Manage de todos os Engines configurados como servidores de aplicação. Nela devem ser informados os campos “Administrator Full Name”, “Administrator Email Address”, “SMTP Server”, “SMTP Username”, “SMTP Secure Connection”, “SMTP Password” e “Confirm SMTP Password”.

Integração com o Java

As APIs de integração do Engine com o Java requerem que o runtime Java 8 ou superior esteja instalado no sistema operacional com a mesma arquitetura do Engine (32 ou 64 bits). O runtime Java é detectado pelo Engine utilizando as configurações e aplicativos abaixo, na seguinte ordem:

  1. Parâmetro de linha de comando do Engine --JavaHome="<path>".
  2. Variável de ambiente NGIN_JAVA_HOME.
  3. Configuração “HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Java Runtime Environment” do registro do Windows.
  4. Variável de ambiente JAVA_HOME.
  5. Aplicativo “java” encontrado no PATH.

Conclusão

Uma vez configurada a base de dados, disponibilize o endereço do servidor para os usuários, preferencialmente via o protocolo seguro HTTPS.

Última atualização em 22 Mar 2024