Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                

Roteirode Instalao SISPG1

Fazer download em pdf ou txt
Fazer download em pdf ou txt
Você está na página 1de 17

SISPG - versão 4.0 | Roteiro - versão 2.

0
SISPG - versão 4.0 | Roteiro - versão 2.0

PROGRAMA DE GESTÃO

Este roteiro de instalação refere-se ao código disponibilizado pela SUSEP.

Arquivos de instalação – versão 4.0

https://github.com/spbgovbr/Sistema_Programa_de_Gestao_Susep

PARCEIROS

SUSEP - Superintendência de Seguros Privados


DTI ME - Diretoria de Tecnologia da Informação do Ministério da Economia
SISPG - versão 4.0 | Roteiro - versão 2.0

INTRODUÇÃO

Esse roteiro visa detalhar os procedimentos a serem seguidos para instalar e configurar o

Sistema de Programa de Gestão, aqui chamado SISPG, ferramenta de apoio tecnológico para
acompanhamento e controle do cumprimento de metas e alcance de resultados nos termos da

Instrução Normativa Nº 65, de 30 de julho de 2020.


Esse é um documento técnico destinado às áreas de tecnologia dos órgãos que visam

adotar o SISPG como ferramenta de gestão do teletrabalho. Detalha tecnologias, padrões e


pacotes que devem ser implantados para ter o sistema funcionando dentro dos ambientes de

cada órgão.
SISPG - versão 4.0 | Roteiro - versão 2.0

SUMÁRIO

LISTA DE RECURSOS MÍNIMOS ........................................................................................................................ 5


DIAGRAMA DE INSTALAÇÃO ............................................................................................................................ 6
BASE DE DADOS ................................................................................................................................................... 7
Sequência de passos (SQL Server) .............................................................................................................. 7
Importação de usuários (desenvolvimento/homologação/produção) ................................................ 7
Carga de dados do Programa de Gestão (SIAPE) ................................................................................... 8
Configurar gestores do sistema ................................................................................................................... 9
APLICAÇÃO .......................................................................................................................................................... 10
Sequência de passos (.NET) ......................................................................................................................... 11
BACK-END ............................................................................................................................................................ 12
API ...................................................................................................................................................................... 12
Sequência de passos (pasta “API”) ......................................................................................................... 12
VALIDAÇÃO DA INSTALAÇÃO – 1ª ETAPA ................................................................................................... 13
GATEWAY .......................................................................................................................................................... 14
Sequência de passos (pasta “gateway”) ............................................................................................... 14
VALIDAÇÃO DA INSTALAÇÃO – 2ª ETAPA .................................................................................................. 15
FRONT-END ......................................................................................................................................................... 16
APP ..................................................................................................................................................................... 16
Sequência de passos (pasta “app”) ....................................................................................................... 16
CONTRIBUIÇÃO, SUGESTÃO OU COMENTÁRIOS ..................................................................................... 17
SISPG - versão 4.0 | Roteiro - versão 2.0

LISTA DE RECURSOS MÍNIMOS

Dimensionamento de recursos, pré-requisitos, dependências, etc.

✔ Internet Information Services (IIS) 7.5 ou mais novo

✔ Microsoft SQL Server 2012 ou, Microsoft SQL Server 2016 SP2 Express ou, Microsoft SQL

Server 2019

✔ Microsoft .NET Core 2.2 1 - Windows Server Hosting

✔ Microsoft .NET Core Runtime – 2.2.1 (x64)

✔ Microsoft .NET Core Runtime – 2.2.1 (x86)

✔ Microsoft .NET Core Runtime – 3.1.8 (x64)

✔ Microsoft .NET Core Runtime – 3.1.8 (x86)

✔ Microsoft .NET Core SDK 3.1.403 (x64)

✔ Microsoft Visual C++ 2015-2019 Redistributable (x64)

✔ Microsoft Visual C++ 2017 Redistributable (x86)

✔ Microsoft Windows Desktop Runtime – 3.1.9 (x64)


SISPG - versão 4.0 | Roteiro - versão 2.0

DIAGRAMA DE INSTALAÇÃO

Passa-se, então, à configuração dos componentes da aplicação. O sistema segue

modelos de arquitetura de micro serviços e utiliza estruturas separadas para o front-end


e para o back-end. Diante disso, faz-se necessário configurar diferentes pacotes para o

correto funcionamento da aplicação.

Figura 1 - Sequência de instalação sugerida

TOME NOTA

Sugere-se as etapas acima destacadas para a correta instalação do SISGP.


SISPG - versão 4.0 | Roteiro - versão 2.0

BASE DE DADOS

O sistema foi desenvolvido utilizando o banco de dados Microsoft SQL Server com a

ferramenta ORM da Microsoft Entity Framework Core nas funções de persistência e com SQL
ANSI nas funções de consulta a dados.

Em teoria, essa configuração permite que diferentes tecnologias de bancos de dados


sejam utilizadas. Entretanto, a equipe de tecnologia da Susep garante a compatibilidade e

realizou testes apenas com o Microsoft SQL Server.

Sequência de passos (SQL Server)

1. Criar banco de dados DBSISGP.

2. Executar o script “scripts/cria_estrutura.sql”.

3. Executar o script “scripts/insert_dominio.sql”.

4. Se for ambiente de desenvolvimento/homologação, executar o script


“scripts/insert_carga_teste.sql”.

5. Criar um usuário de aplicação com permissões de leitura e escrita.

Importação de usuários (desenvolvimento/homologação/produção)

Uma vez criada a estrutura de banco de dados, é necessário fazer a importação dos dados

do órgão no SIAPE para a estrutura do sistema.

TOME NOTA

O script “Inserir dados de teste” traz um exemplo de carga com dados fictícios
(CPFs gerados aleatoriamente e unidades da estrutura da Susep), serve para permitir o
acesso e a validação do sistema. Assim que o sistema entrar em produção, os dados da
tabela Pessoa e Unidade cadastrados por esse script devem ser apagados da base de

dados.
SISPG - versão 4.0 | Roteiro - versão 2.0

Os perfis do sistema serão derivados da estrutura real do órgão. Desse modo, servidores

que não tem função de chefia no órgão recebem valor null na coluna tipoFuncaoId da tabela

Pessoa e deste modo terão habilitadas apenas funções de acompanhamento dos seus próprios
planos de trabalho, ao passo que servidores com função de chefia poderão ter acesso aos planos

de trabalho das suas respectivas equipes e terão acesso às funções de programas de gestão
(cadastro, seleção, avaliação, etc). Servidores que trabalham na área de indicadores poderão,

além de acompanhar seus próprios planos de trabalho, cadastrar as listas de atividades do órgão
e dos demais setores.

Carga de dados do Programa de Gestão (SIAPE)

A carga de dados se dá a partir do sistema de recursos humanos do órgão para a base


do SISPG pela extração dos dados do SIAPE. As tabelas que devem ser populadas são: Unidade,

Pessoa e Função.

Para dar carga dos dados, executar:

1. CargaSiape_TipoFuncao

2. CargaSiape_Unidade
3. CargaSiape_Pessoa

4. AtualizaUnidadeModalidadeExecucao (necessário para corrigir um problema que ocorre


na aplicação ao selecionar a Modalidade de Execução da Unidade no cadastro do Plano

de Trabalho).
5. Carga_gestores (para essa carga não dar erro nas atualizações, não alterar a ordem dos

servidores na planilha)

Sugere-se a utilização do Pentaho, e em utilização do Pentaho com SQL Server, é nece-


sário adicionar na pasta lib o arquivo jtds-1.3.1.jar

https://sourceforge.net/projects/jtds/
SISPG - versão 4.0 | Roteiro - versão 2.0

No Ministério da Economia o processo foi alinhado com a DGP, que montou script de

tratamento dos dados extraídos do SIAPE e montagem da planilha de carga. Há uma ferramenta

em fase de construção que fará a carga e manutenção dos dados atualizados a partir do SIAPE.

Configurar gestores do sistema

Em determinadas situações como, por exemplo, no caso fictício em que o titular da

unidade está de férias e o substituto de licença, pode ser necessário ter pessoas no órgão com
acesso total ao sistema para evitar que o trabalho do setor fique parado. Para suprir tal

necessidade, existe o perfil Gestor com controle total da ferramenta.

O cadastro de gestores do sistema é feito na tabela CatalogoDominio. Basta inserir um


registro nessa tabela com a coluna classificação preenchida com o valor ‘GestorSistema’ e a

coluna descrição preenchida com o id da pessoa que terá perfil de gestor.


SISPG - versão 4.0 | Roteiro - versão 2.0

APLICAÇÃO

A publicação deve ser feita em algum servidor de aplicação. Sugere-se o Internet

Information Services (IIS) na seguinte estrutura:

I. Servidor web, acessível apenas por meio da máquina do Gateway, em que fica publicada

a API.
◦ SISGP

▪ API
II. Servidor web, aberto para a internet, em que ficam publicados o Gateway (pasta Gateway)

e o front-end (pasta APP).

◦ SISGP
▪ APP

▪ Gateway

As pastas APP, gateway e API devem ser convertidas em aplicações no IIS e sugere-se
que rodem sob um mesmo Application Pool.

TOME NOTA

Para ambiente de desenvolvimento/homologação, é suficiente apenas servidor interno. Já para


produção, faz-se necessário um servidor interno e outro externo, e nesse caso as pastas

“Gateway” e “APP” deverão estar no servidor externo enquanto a pasta “API” estará no servidor
interno.
SISPG - versão 4.0 | Roteiro - versão 2.0

As pastas APP, Gateway e API devem ser convertidas em aplicações no IIS e sugere-se que rodem

sob um mesmo Application Pool. Os nomes e as estruturas das pastas poderão variar de acordo
com a conveniência do Órgão, todavia será importante conhecer o caminho para cada uma

delas.
Para facilitar o entendimento do roteiro, considera-se que os seguintes caminhos foram

configurados:
APP: https://servidorExterno/sisgp/app

Gateway: https://servidorExterno/sisgp/gateway

API: https://servidorInterno/sisgp/api

Sequência de passos (.NET)

1. Criar um Pool de Aplicativos chamado “sisgp”.

2. Criar um novo site vinculado ao pool “sisgp” e apontando para o


caminho físico da pasta “api”.

3. Criar um novo site vinculado ao pool “sisgp” e apontando para o

caminho físico da pasta “gateway”.

4. Criar um novo site vinculado ao pool “sisgp” e apontando para o


caminho físico da pasta “app”.
SISPG - versão 4.0 | Roteiro - versão 2.0

BACK-END

O back-end concentra as regras de negócio e a interação da aplicação com o banco de


dados e é composto por dois pacotes, API e Gateway.

API
A API é onde estão as regras de negócio, funcionalidades, operações de persistência e de
consulta aos dados do sistema.

TOME NOTA

Alguns métodos só funcionarão quando invocadas por meio do Gateway. Entretanto, com

algum conhecimento de chamadas HTTP é possível executar chamadas a alguns métodos


da API. Por isso, recomenda-se que esse pacote fique em um ambiente acessível apenas

por meio da máquina onde está hospedado o Gateway.

Sequência de passos (pasta “API”)

1. No arquivo “web.config”, alterar o valor da variável ASPNETCORE_ENVIRONMENT com

um dos valores a seguir, de acordo com o ambiente: Dev, Homolog ou Prod.

2. Em “Settings/connectionstrings.<AMBIENTE>.json”, informar os valores para conexão com

o banco de dados, sendo “data source” o servidor, “initial catalog” o nome do banco, “User
ID” o usuário e “Password” a senha.

1. Em “Settings/appsettings.<AMBIENTE>.json”, configurar o servidor de e-mail SMTP e o

LDAP para autenticação dos usuários.


SISPG - versão 4.0 | Roteiro - versão 2.0

VALIDAÇÃO DA INSTALAÇÃO – 1ª ETAPA

Após instalação e configuração da base de dados e API, recomenda-se a validação dessas

etapas pela seguinte URL:

<URL da API>/api/v1/dominio/ModalidadeExecucao

Se a instalação foi realizada corretamente, deverá retornar um json com as modalidades

de trabalho da tabela catálogo domínio.

Em caso de erro:

I. Abra um prompt de comando


II. Navegue até a pasta da API e digite o comando

Dotnet susep.sisrh.webapi.dll

O retorno é o possível erro.


SISPG - versão 4.0 | Roteiro - versão 2.0

GATEWAY
O Gateway adiciona camadas de segurança, cache e outros recursos à API. É essencial
para o funcionamento do sistema, para a prevenção de ataques e outros problemas.

Sequência de passos (pasta “gateway”)

1. No arquivo “web.config”, alterar o valor da variável ASPNETCORE_ENVDQRONMENT com

um dos valores a seguir, de acordo com o ambiente: Dev, Homolog ou Prod.

2. Em “Settings/appsettings.<AMBIENTE>.json”, informar a url da API no campo “authority”.

3. Em “Settings/ocelot.<AMBIENTE>.json”, dentro do objeto “ReRoutes”, substituir todos os

campos “Host” e “Port” pelas do servidor da API. Caso a API esteja com https, alterar todos

os "DownstreamScheme". Caso a API não esteja na raiz do servidor, completar os


caminhos em todos os "DownstreamPathTemplate". Já no final do arquivo substituir o

campo "BaseUrl" pela url do gateway.


SISPG - versão 4.0 | Roteiro - versão 2.0

VALIDAÇÃO DA INSTALAÇÃO – 2ª ETAPA

Após instalação e configuração do Gateway, recomenda-se a validação dessa etapa pela

seguinte URL:

<URL da API>/dominio/ModalidadeExecucao

Se a instalação foi realizada corretamente, deverá retornar um json com as modalidades


de trabalho da tabela catálogo domínio (mesmo retorno da validação da API).

Em caso de erro:

III. Abra um prompt de comando


IV. Navegue até a pasta do Gateway e digite o comando

Dotnet susep.sisrh.webapi.dll

O retorno é o possível erro.


SISPG - versão 4.0 | Roteiro - versão 2.0

FRONT-END

O front-end é a camada de apresentação do sistema. Construída em angular,

teoricamente, pode ser publicada em qualquer servidor de aplicação que rode node.js.

APP
Sequência de passos (pasta “app”)
1. No arquivo “ClientApp/dist/env.js”, alterar o valor das variáveis “window.__env.identityUrl”

e “window.__env.apiGatewayUrl” para a url do gateway.

2. No arquivo “ClientApp/dist/index.html”, dentro da tag “<base />”, colocar no href o


caminho da publicação da pasta app no servidor.

3. No arquivo “ClientApp/dist/web.config”, dentro da tag “<action />” do tipo Rewrite,


colocar na url o caminho da publicação da pasta app no servidor.

4. Acessar a url do app e verificar se a instalação foi realizada corretamente. Ela deverá

retornar a tela de login do sistema.


SISPG - versão 4.0 | Roteiro - versão 2.0

CONTRIBUIÇÃO, SUGESTÃO OU COMENTÁRIOS

Para contribuições, sugestões ou comentários encaminhe-nos mensagens para


pgd@economia.gov.br.

Você também pode gostar