SARA | RESTServer - Manual Técnico de Instalação e Atualização

Tempo aproximado para leitura: 2 min

CONTEÚDO

01. OBJETIVO

Auxiliar no processo de instalação e configuração ou atualização do serviço SARA | RESTServer.

02. ARQUIVOS PARA INSTALAÇÃO

Os arquivos para a instalação do serviço podem ser encontrados dentro do pacote de expedição oficial do sistema SARA, ou por meio de pacotes incrementais destinados ao RESTServer publicados na Central de Downloads, da página de suporte da TOTVS.

Como exemplo, abaixo segue a pasta com os arquivos localizados dentro do pacote de expedição da versão/release 12.01.44. 

Na pasta RESTServer haverá um arquivo com a versão/build do RESTServer.

Normalmente será o mesmo número da versão do pacote oficial e durante a release poderão ser gerados builds contendo manutenções ou melhorias.

Na pasta da versão existirão os seguintes arquivos:

03. INSTALAÇÃO DO SARA | RESTSERVER

3.1.  O serviço RESTServer possui incompatibilidade com servidores que possuem Sistema Operacional:

1. Windows Server 2008 R2
2. Windows Server 2008, Windows 8
3. Windows 8.1

Recomendamos a instalação do serviço RESTServer em servidores Windows Server 2012 R2 ou superior.

Não é necessário estar no mesmo servidor de Banco de Dados ou no Servidor utilizado para repositório dos executáveis dos módulos e arquivos INI do Sistema SARA.

A Instalação pode ser efetuada sem nenhuma dependência do legado. Por recomendação e organização, o serviço poderá estar instalado no Servidor de repositório dos executáveis, criando uma pasta chamada SERVICES e uma subpasta chamada RESTServer (sugestão).

Exemplo

Observe neste exemplo, que na pasta SERVICES já existe o serviço do EAIService instalado, que também não possui nenhuma dependência com o RESTServer atualmente.

Na pasta RESTServer, crie uma nova pasta chamada Bin.

Copie os arquivos de instalação mencionados no tópico 02 - Arquivos Para Instalação para dentro desta pasta.

3.2.  Para a instalação do serviço, deverá ser executado o arquivo AppServerM.exe como Administrador.

3.3.  Ao executar o instalador serão solicitados os parâmetros iniciais para conexão com o Banco de Dados.

         Informe o driver de Banco, o nome e instância do banco de dados, o nome da base de dados, o usuário (operador do serviço) e a senha.

         O usuário (Operador de serviço), poderá ser o usuário SA ou um usuário criado apenas para a execução do serviço. Não é recomendado vincular um usuário do Sistema
         (Pessoa).

3.4.  Na pasta Arquivos poderá ser configurado os diretórios para LOG de erros, execução e tradução do RESTServer. Por padrão o instalador sugere os nomes de acordo com o
        diretório de instalação.

3.5.  Na pasta Outros, configure o idioma, a porta e o nome do serviço para o Windows.

3.6.  Após informar os parâmetros, clique em Salvar Fechar. Neste momento, o Sistema apresentará a mensagem abaixo.

3.7.  Ao clicar em OK, o instalador começará a instalação do serviço exibindo a imagem do SARA abaixo.      
        Neste momento o instalador fará a extração dos arquivos necessários para o serviço.

Pastas geradas

Abaixo segue o objetivo de cada uma das pastas geradas:

1. Bin: Pasta de arquivos executáveis referente ao RESTServer e dos módulos (BPL) contendo as funcionalidades do Sistema.
2. config: Pasta de arquivos de configuração .INI. Para alterar a conexão com o Banco de Dados, usuário entre outras configurações.
3. log: Pasta de arquivos de log de erros, execução e tradução do RESTServer. Erros de instalação, atualização e execução poderão ser consultados nestes arquivos.
4. server: Pasta de arquivos de instalação do APACHE (Serviço WEB).
5. temp: Pasta temporária utilizada no processo de instalação e atualização do RESTServer.  Na pasta SQL, por exemplo, é possível encontrar todos os scripts executados
     para o banco de dados por release/build.
6. translate: Pasta utilizada para traduções de outros idiomas (tradução não implementada até o momento).
7. update: Pasta não utilizada até o momento.

3.8.  Após as extrações dos arquivos e atualização do Banco de Dados será aberta uma tela para a configuração do APACHE.

Um serviço APACHE é instalado em conjunto para permitir a execução do  RESTServer.

Também é possível configurar o local onde (pasta) do Servidor APACHE que rodará as páginas estáticas, podendo ser uma documentação ou uma aplicação WEB.

Os valores poderão ser mantidos os recomendados (padrão).

Após as configurações, clique em Salvar Fechar.

3.9.  Após a configuração do Apache, será exibida a mensagem abaixo e continuará com a instalação efetuando a atualização do banco de dados por meio das scripts enviadas
         no pacote.

3.10.  Após a finalização, o instalador subirá o serviço do APACHE e o RESTServer estará pronto para utilização.

3.11.  Em caso de inconsistências no processo de instalação, o serviço não será executado e as inconsistências deverão ser verificadas nos arquivos de log de erros ou log de
          execução contidos na pasta parametrizada por meio do arquivo CONFIG.INI, mencionado anteriormente.

04. ATUALIZAÇÃO DO SERVIÇO SARA | RESTSERVER

Para efetuar a atualização do serviço SARA | RESTServer, seguir os seguintes passos:

4.1.  Para consultar o histórico de atualizações do RESTServer, você poderá efetuar a consulta na tabela APP_PACKAGE_ATUALIZATION, publicada na base SARA_DB do
        Banco de Dados.

Na imagem abaixo é possível verificar a data de atualização de cada release/build.

4.2.  Também é possível consultar os nomes dos arquivos de scripts que foram atualizados no banco de dados em cada uma das versões, para isto basta consulta a tabela
        APP_PACKAGE_ATUALIZATION_ITEM.

O conteúdo de cada arquivo poderá ser consultado na pasta TEMP / SQL no diretório de instalação do RESTServer.

4.3.  Para o processo de atualização, deverá ser baixado o pacote oficial da release ou apenas o patch de atualização do RESTServer, ambos podem ser encontrados em
        downloads na página de Suporte da TOTVS.

4.4.  No processo de atualização, não é necessário atualizar todas as versões pendentes para atualizar a última versão. Atualizando a última versão o instalador efetuará a
         instalação dos pacotes anteriores automaticamente. Portanto, para instalar uma nova versão ou atualizar para a última versão, basta aplicar o último pacote.

4.5.  Após download, deve ser extraído os arquivos de dentro da pasta da release/build e copiados para dentro da pasta Bin, no diretório de instalação do RESTServer.

Arquivos de atualização

Arquivos copiados para a pasta Bin

4.6.  Para executar o processo de atualização, basta executar o arquivo AppServerM.exe como Administrador.

Assim que executar será exibido a tela abaixo:

4.7.  Para o processo de atualização, não será necessário nenhuma informação ou interação, o próprio instalador irá parar o serviço do SARA | RESTServer, efetuará a atualização
         dos arquivos necessários e scripts de atualização de Banco de Dados, se houver.

4.8.  Após o término da atualização o instalador será fechado. Neste momento, será verificado se o serviço SARA | RESTServer foi iniciado novamente. Também poderão ser
         consultados os arquivos de Logs, para identificar se houve alguma falha durante o processo de instalação.

4.9.  Após a conclusão da atualização, poderá ser consultado o histórico de atualização do RESTServer na tabela do Sistema.

05. CONTROLE DE SEGURANÇA PARA EXECUÇÃO DE APIS POR MÉTODO

Após o processo de instalação ou atualização do SARA | RESTServer deve ser realizado o processo de permissões para a execução das APIs por perfil de usuário.

No Módulo Segurança do Sistema SARA (legado), foi criado um módulo chamado REST SERVER, e desenvolvido 3 menus principais, conforme imagem abaixo:

Na pasta:

1. API | LOCAL - estão localizadas as APIs que não possuem restrições de acesso relacionadas ao PORTAL, ou seja,  um determinado LOGIN somente pode acessar
     informações de alguns clientes, de acordo com o cadastro das permissões relacionadas ao PORTAL.

2. API | PORTAL - estão localizadas as APIS que possuem restrições de acesso relacionadas ao PORTAL, portanto, um determinado LOGIN somente pode acessar as
     informações dos clientes, de acordo com cadastro das permissões relacionadas ao PORTAL.

3. API | PÚBLICA - estão localizadas as APIS que não precisam de autenticação para serem executadas.

O processo de permissões permaneceu igual ao legado do SARA, ou seja, para as APIs e métodos serão dadas as permissões por perfil de usuário.

Para um determinado Perfil pode ser dada a permissão de GET (consulta) e restringir a permissão de POST (Inserção).

Após as permissões, os usuários vinculados ao perfil poderão executar as APIs e métodos normalmente.