Histórico da Página

Tempo aproximado para leitura: 2 min

01. Objetivo

Este manual tem como 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.41.00, 

Dentro da pasta RESTServer, terá 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 build´s contendo manutenções ou melhorias.

Dentro da pasta da versão, conterão os seguintes arquivos:

03. Instalando o SARA | RESTServer

1) O serviço RESTServer possui incompatibilidade com servidores que possuem sistema operacional Windows Server 2008 R2 e Windows 8.

Nas demais versões do Windows é recomendada a instalação do serviço RESTServer. Não poderá ser instalado em qualquer servidor Windows, 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 poderá ser feita 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:

Veja nesta exemplo, que dentro da pasta Service, já tem o serviço do EAIService instalado que também não possui nenhuma dependência com o RESTServer atualmente.

Na pasta RESTServer, criar uma nova pasta chamada "Bin", e copiar os arquivos de instalação mencionados no item 2 para dentro desta pasta.

NOTA: A instalação do RESTServer ocorre de forma incremental, ou seja, ao instalar a última versão, todas as dependências e versões anteriores serão automaticamente instaladas.

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

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).

4) Na pasta "Arquivos", poderá ser configurado os diretórios para LOG de erros, execução e tradução do RESTServer. Por Default, o instalador sugere os nomes conforme o diretório de instalação.

5) Na pasta "Outros", configurar o idioma, porta e nome do serviço para o WINDOWS.

6) Após informar os parâmetros, acionar o botão "SALVAR FECHAR". Neste momento o sistema exibirá a mensagem abaixo.

7) Ao acionar o botão 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 criadas:

Abaixo segue o objetivo de cada uma das pastas criada:

Bin: Pasta de arquivos executáveis referente ao RESTServer e dos módulos (BPL) contendo as funcionalidades do sistema.

Config: Pasta de arquivos de configuração .INI. Para alterar a conexão com o banco de dados, usuário entre outras configurações.

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.

server: Pasta de arquivos de instalação do APACHE (Serviço WEB).

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.

translate: Pasta utilizada para traduções de outros idiomas (Tradução não implementada até o momento).

update: Para não utilizada até o momento.

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 (default).

Após as configurações, acionar o botão "Salvar fechar".

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.

10) Após a finalização, o instalador irá subir o serviço do APACHE e o RESTServer estará pronto para USO.

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. Atualizando o serviço SARA | RESTServer

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

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.

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.

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) 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) 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

5) Para executar o processo de atualização, basta executar o arquivo AppServerM.exe como administrador. Assim que executar será exibido a tela abaixo:

6) 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 caso houver. 

7) Após o término da atualização o instalador será fechado. Neste momento dever ser verificado se o serviço SARA | RESTServer foi iniciado novamente.

Também poderá se consultado os arquivos de LOG´s para identificar se houve alguma falha durante o processo de instalação.

8) 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 das API´s por método.

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

No Módulo segurança do sistema SARA (legado), foi criado o módulo chamado "REST SERVER", e criado 3 menus principais conforme imagem abaixo.

Na pasta API | LOCAL, estarão localizadas as API´s que não possuem restrições de acesso relacionadas a PORTAL, ou seja,  um determinado LOGIN somente poderá acessar informações de alguns CLIENTES conforme o cadastro das permissões relacionadas ao PORTAL.

Na pasta API | PORTAL, estarão localizadas as API´S que possuem restrições de acesso relacionadas a PORTAL, portando um determinado LOGIN somente poderá acessar as informações dos CLIENTES conforme o cadastro das permissões relacionadas ao PORTAL.

Na pasta API | PÚBLICA, estarão localizadas as API´S que não precisão de autenticação para serem executadas.

O processo de permissões ficou igual ao legado do SARA, as API´s e métodos serão dadas as permissões por PERFIL de usuário.

Para um determinado PERFIL, poderá 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 API´s e métodos normalmente.

<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>