From 7fadd172600aaf8fc9e6f7926ac8ec8e7ade1a37 Mon Sep 17 00:00:00 2001 From: andre.guimaraes Date: Wed, 10 Oct 2018 15:11:46 -0300 Subject: [PATCH] Documenta os requisitos do broker no README.md --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dd9ef21..c4fe443 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ # SEI-Broker - Camada REST de acesso ao SEI +O SEI-Broker é uma camada de integração que foi desenvolvida para integrar os sistemas corporativos da ANS e o SEI, Sistema Eletrônico de Informações do TRF 4. Toda essa camada foi criada utilizando o padrão RESTful de serviços web, sua função é facilitar a integração dos sistemas da ANS com o SEI, utilizando um protocolo mais simples, moderno e performático. A adoção do broker nos permite criar uma camada de abstração para evitar que mudanças no SEI afetem as integrações, isso é possivel pelo fato do broker utilizar REST e possuir contrato fraco. + +O Broker atualmente está na versão 2.9, essa versão é compatível com o SEI 3.0.13. É importante destacar que é necessário atualizar o SEI-Broker a cada atualização do SEI que altere os serviços web. + +Alguns serviços adicionais foram desenvolvidos extrair dados que não são ofertados pelos serviços nativos do SEI, estes serviços fazem acesso a base de dados do SEI e realizam operações apenas de consulta. A escrita de dados continua a ser exclusividade dos serviços nativos, desta forma a integridade e coerência das inserções é mantida. ## Requisitos - SEI 3.0.13 instalado/atualizado. - - Verificar valor da constante de versão no arquivo /sei/web/SEI.php ou, após logado no sistema, parando o mouse sobre a logo do SEI no canto superior esquerdo. -- Os códigos-fonte do Broker podem ser baixados a partir do link a seguir, sempre utilizer a versão compatível com o SEI: [https://softwarepublico.gov.br/gitlab/ans/sei-broker/tags](https://softwarepublico.gov.br/gitlab/ans/sei-broker/tags "Clique e acesse") +- Código-fonte do Broker pode ser baixado a partir do link a seguir, sempre utilize uma versão compatível com o SEI: [https://softwarepublico.gov.br/gitlab/ans/sei-broker/tags](https://softwarepublico.gov.br/gitlab/ans/sei-broker/tags "Clique e acesse") +- Apache Maven para baixar as dependências e compilar o pacote. +- Servidor JBoss EAP 7.0.4 ou Wildfly 10. +- Banco relacional, o Broker foi desenvolvido usando Oracle 12g, mas com pouco esforço pode utilizar o MySQL. +- Conexão com a internet para que o Maven acesse os repositórios hospedeiros das dependências. \ No newline at end of file -- libgit2 0.21.2