Sistemas Correcionais Manual de Implantação …...Sistemas Correcionais Manual de Implantação Versão: 1.1 Nome do arquivo: Siscor_Manual_Implantação.docx Controladoria Geral

Sistemas Correcionais Manual de Implantação Versão: 1.1

Nome do arquivo: Siscor_Manual_Implantação.docx

Controladoria Geral da União – Divisão de Sistemas e Informação - Página 1 de 39

Sistemas Correcionais – Siscor

Manual de Implantação

Versão 1.2

Histórico de Revisão

Autor Data Descrição Versão

Lucas Emanuel 26/04/2019 Criação do Documento 1.0

Marcio Otta 06/05/2019 Revisão 1.1

Marcio Otta 27/05/2019 Inclusão do Reporting services 1.2




Sumário Introdução ................................................................................................................................... 3

Pré-Requisitos ......................................................................................................................... 3

Arquitetura do SISCOR .......................................................................................................... 3

Estrutura do Documento ........................................................................................................ 3

Parte 1 – Obtendo os arquivos do Siscor........................................................................... 4

1.1 - Localização dos arquivos ........................................................................................ 4

1.2 - Download dos arquivos do repositório ........................................................................ 4

Parte 2 – Instalação do ambiente de desenvolvimento .................................................. 5

2.1 - Versões ............................................................................................................................ 5

2.2 - Instalação do Microsoft .NET Framework .................................................................. 5

2.3 - Instalação do Microsoft Visual Studio ......................................................................... 6

2.4 - Instalação do Microsoft SQL Server, SQL Reporting Services e SQL Server

Management Studio ................................................................................................................ 7

2.5 - Instalação do Microsoft Report Viewer ..................................................................... 15

Parte 3 – Configurações da Aplicação .............................................................................. 16

3.1- Preparação do Banco de Dados ................................................................................. 16

3.2 – Plugins do Visual Studio para relatórios .................................................................. 23

3.3 - Configuração da Solução no Visual Studio.............................................................. 24

3.4 - Configuração do Reporting Services ........................................................................ 29

Verificando erros ..................................................................................................................... 38

Referências ............................................................................................................................... 38




Introdução

Este manual tem como finalidade fornecer um guia prático de implantação do sistema Siscor,

ferramenta produzida pela CGU e disponibilizada para entes parceiros.

Este documento contém todas as informações necessárias para instalação e operacionalização

do ambiente de desenvolvimento do sistema, tendo como público-alvo a área técnica

especializada do ente parceiro.

Este documento não inclui procedimentos para a instalação do sistema em produção nem

suporte ao sistema, ficando a cargo da área técnica do parceiro estas etapas, que seguem

como padrão para qualquer sistema desenvolvido na tecnologia .NET

Pré-Requisitos Para o profissional:

• Conhecimentos técnicos na linguagem C#, Javascript e Asp.Net

• Conhecimentos de banco de dados SQL Server

De Infraestrutura para o ambiente de desenvolvimento:

• Windows 10

• Demais softwares a serem instalados são versões gratuitas.

Arquitetura do SISCOR O sistema SISCOR usa as seguintes tecnologias:

• ASP.Net Webforms (Framework 4.6 ou superior)

• Banco de dados: SQL Server 2012 ou superior

• Servidor de aplicação: IIS 8.5 ou IIS Express ou superior

• Servidor de relatórios: SQL Server Reporting Services

Estrutura do Documento Este manual está organizado nas seguintes seções:

Parte 1 – Obtendo os arquivos do Siscor – Lista os procedimentos necessários para obter

acesso ao código-fonte do sistema a partir de uma máquina Windows 10;

Parte 2 – Instalação do ambiente de desenvolvimento – Lista os passos necessários para

instalação das ferramentas necessárias para suportar o desenvolvimento do sistema;

Parte 3 – Configurações da Aplicação – Explica as configurações necessárias para configuração

e compilação da solução, da base de dados, além de explicar as configurações a serem

realizadas quando da implantação do ambiente de produção.




Parte 1 – Obtendo os arquivos do Siscor

1.1 - Localização dos arquivos Os arquivos do Siscor estão disponíveis no repositório da CGU no GitLab[1]. Deverá ser indicado

um responsável técnico que terá acesso ao repositório. O responsável técnico será adicionado

ao grupo time.fontes.siscor, o que dará permissão para clonar o repositório ou fazer o download

em formato “ZIP”.

1.2 - Download dos arquivos do repositório Para realizar download dos arquivos será necessário utilizar a ferramenta Git[2] para clonar o

repositório no endereço https://gitlab.com/sistemas-cgu/time.dev/siscor.git. Serão ilustrados

abaixo os passos necessários para realizar o download dos arquivos.

Com o git instalado na máquina, clique com o botão direito no local aonde deseja baixar os

arquivos e selecione a opção “Git Bash here”.

No terminal do git, utilize o comando:

git clone https://gitlab.com/sistemas-cgu/time.dev/siscor.git

Isso irá realizar o download dos códigos-fontes na pasta, ao realizar a operação podem ser

requisitados seus dados de acesso do gitlab.

https://gitlab.com/sistemas-cgu/time.dev/siscor.git

https://gitlab.com/sistemas-cgu/time.dev/siscor.git




Parte 2 – Instalação do ambiente de desenvolvimento

2.1 - Versões Esta seção apresenta os passos necessários para a instalação desse ambiente em uma máquina

com sistema operacional Windows 10. Para este manual, foram adotadas as seguintes versões

de recursos:

• Microsoft.NET Framework: versão 4.6.1;

• Microsoft Visual Studio – IDE de desenvolvimento da Microsoft – Versão 2019

Community;

• Microsoft SQL Server - Banco de dados da Microsoft - Versão Express with Advanced

Services 2017;

• SQL Server Management Studio (SSMS) – Ambiente para gerenciamento do banco de

dados – versão 2018;

• Microsoft Report Viewer - para renderização e visualização de relatórios – versão

2010.

• Microsoft Reporting Services – Versão Express 2017

2.2 - Instalação do Microsoft .NET Framework O Siscor usa o Microsoft .NET Framework. Caso a máquina não tenha a versão correta

instalada, é possível baixar o instalador diretamente no site da Microsoft [3]. Execute o

instalador com as configurações padrão sugeridas.




2.3 - Instalação do Microsoft Visual Studio O Visual Studio, ferramenta de IDE desenvolvida pela Microsoft pode ser baixada diretamente

do site da Microsoft [4]. Abaixo estão ilustrados os passos para instalação em uma máquina

Windows 10. Neste manual estamos exemplificando com a versão Community, mas pode ser

utilizada as demais versões (pagas).

Ao executar o instalador e aceitar os termos de uso será apresentada a tela de produtos

disponíveis, selecione a opção ASP.NET e desenvolvimento Web.

Se desejar, selecione a aba “Pacotes de Idiomas” e altere o idioma para a linguagem preferida.




Finalmente pressione o botão instalar no canto inferior direito e aguarde a instalação.

2.4 - Instalação do Microsoft SQL Server, SQL Reporting Services e SQL

Server Management Studio O Siscor utiliza o banco de dados Microsoft SQL Server para persistir os dados. Para podermos

instalar também o Reporting Services, é necessário baixa a versão Express With Advanced

Services, no endereço: https://www.microsoft.com/pt-br/sql-server/sql-server-editions-

express

Estando nesta página, localize abaixo o link para a versão desejada:

Será necessário subscrever-se no programa “Dev Essentials” do Visual Studio:

https://www.microsoft.com/pt-br/sql-server/sql-server-editions-express





Uma vez subscrito, ao acessar a URL anterior, a página de download do SQL Server Express se

abrirá - ou entre diretamente o endereço abaixo:

https://my.visualstudio.com/Downloads?q=sql%20server%202017%20express

Obtenha a versão “Advanced”:

https://my.visualstudio.com/Downloads?q=sql%20server%202017%20express




Após o download, inicie o instalador do SQL Server.

Deixe as opções pré-definidas, exceto nestas telas abaixo:




Anote a senha do usuário “sa":

Aguarde a instalação ser finalizada, a tela abaixo confirmará que a instalação ocorreu com

sucesso.




Nesta mesma tela, clique no botão “Instalar Sql Server Management Tools”.

Você será redirecionado para a página de download da versão mais atual do SQL Server

Management Studio. Selecione a opção Download SQL Server Management Studio (GA).

Feche o instalador do SQL Server Express e execute o instalador do SQL Server Management

Studio que foi baixado no passo anterior.

Quando o instalador for aberto, selecione o local da instalação que desejar e pressione o botão

Install




Aguarde o instalador finalizar e pressione o botão Close.




Voltando para o instalador do SQL Server, selecione agora a instalação do Reporting Services:

Este link irá redirecionar para o download do Reporting services. Faça o download e inicie o

instalador.

Na tela abaixo, selecione a opção express:




Termine a instalação. Talvez seja necessário reiniciar o computador.




2.5 - Instalação do Microsoft Report Viewer O instalador do Report Viewer 2010 também está disponível no site da Microsoft [6]. A

instalação é extremamente simples, não é necessária nenhuma configuração adicional durante

a instalação, somente executar o instalador e aguardar o processo terminar conforme as

imagens abaixo.




Parte 3 – Configurações da Aplicação Esta seção discorre sobre os passos necessários para a correta configuração da aplicação no

ambiente de desenvolvimento, suportado pelas ferramentas instaladas nos passos anteriores.

3.1- Preparação do Banco de Dados Para criação do banco de dados do Siscor será necessário restaurar um backup disponível no

repositório. Este backup está na pasta \BancoDados\Versao_2_5_0 e está com o nome

Correicao_250.zip.

Descompacte este arquivo em uma pasta do seu computador.

Para restaurar o banco de dados, abra o SQL Server Management Studio.

Na tela de conexão, conecte-se na instância que foi criada para o SQL Server Express

(geralmente é localhost\sqlexpress) com a Autenticação do Windows ou a autenticação do

usuário “sa":




No menu lateral, clique com o botão direito em Databases e selecione a opção Restore

Database...

Certifique-se que a opção Device está marcada em Source e clique no botão de Navegação




Na janela que será aberta, pressione o botão Add

E selecione o backup que foi baixado do repositório então confirme no botão Ok.




No menu lateral, clique em Options e marque a opção Overwrite the existing database (WITH

REPLACE) então confirme a restauração e aguarde a mensagem de sucesso.




De volta no menu lateral, expanda a pasta Security e clique com o botão direito na pasta

Logins e então selecione a opção New Login...




Na janela que será aberta digite uscorreicao, selecione a opção SQL Server Authentication, em

seguida crie uma senha para o usuário (neste tutorial usamos uscorreicao). Desmarque a

opção Enforce Password Policy.

No canto direito, clique em User Mapping, marque o banco de dados “Correicao” e role

dbowner:




Na aba Server Roles, marque a opção “dbcreator” (será necessária para a configuração do

Reporting services).




Por fim, confirme a criação do novo usuário de banco de dados. Guarde o usuário e a senha,

eles serão usados na configuração do sistema.

3.2 – Plugins do Visual Studio para relatórios Para editar os relatórios do sistema no Visual Studio, é necessário instalar alguns plugins.

Instalação:

• Feche o visual studio;

• Faça o download e execute o instalador das seguintes extensões:

https://marketplace.visualstudio.com/items?itemName=ProBITools.MicrosoftReportProj

ectsforVisualStudio

https://marketplace.visualstudio.com/items?itemName=ProBITools.MicrosoftRdlcReport

DesignerforVisualStudio-18001

• Inicie o Visual Studio.

• Se o projeto Correicao.Reporting nao abrir, clique com botão direito do mouse no

projeto e selecione Recarregar (reload)




3.3 - Configuração da Solução no Visual Studio

Abra o Visual Studio e selecione a solução Siscor.SLN dentro da pasta FONTES do repositório:

Serão abertos os projetos que compõem o Siscor. Os principais são:

- Siscor.Forms: camada de apresentação (formulários, relatórios, imagens, etc.)

- Siscor.Business: classes de negócios

- Siscor.Data: camada de dados (mapeamento objeto-relacional)

- Siscor.Model: classes de objetos de negócio

- Siscor.TarefasAutomaticas: aplicativo para executar tarefas em lote

- Siscor.Tests: testes automatizados (unidade e integração)

Torne o projeto Siscor.Forms o “Startup Project”, clicando com o botão direito no projeto e

selecionando a opção “Set as StartUp Project” ou “Definir como Projeto de Inicialização”




No seletor de Configurações, selecione a configuração DebugLocal:

Explicação: com esta configuração, toda vez que o sistema for compilado, o arquivo

web.DebugLocal.config transformará o arquivo web.template.config no web.config. Portanto,

nunca altere o arquivo Web.Config diretamente, pois ele será sobrescrito; altere sempre no

web.DebugLocal.config ou no web.Template.config.




Clique no projeto Siscor.Forms e selecione Propriedades:

Na aba WEB, selecione o servidor “IIS Express”:




No endereço da aplicação, digite: http://localhost/SisCor:61236 e clique em “Create Virtual

Directory”:

Abra o arquivo web.DebugLocal.config que está na raiz do Siscor.Forms (dentro do

web.config).

Edite nesse arquivo as seguintes chaves:

• ConnectionString: configure a string de conexão com o seu banco de dados,

atualizando a instância (data source) do seu servidor de banco de dados, o nome da

http://localhost/SisCor:61236




base e as informações de usuário e senha de banco que foram criados durante a

restauração do backup do banco. Caso tenha seguido as instruções do manual, já

deverá estar corretamente configurado:

o Data Source: nome da instância do seu banco de dados (ver na seção onde

instalou o sql server, o padrão é localhost\sqlexpress

o Initial Catalog: o nome do seu banco de dados (se seguiu o manual, deve ser

Correicao)

o User ID: nome de usuário dbower criado (se seguiu o manual deve ser

usCorreicao)

o Password: o password do usuário dbowner

o Ex.: <add name="DBUnitOfWork" connectionString="Data Source=localhost\sqlexpress;Initial Catalog=Correicao;persist

security info=True;user

id=uscorreicao;password=XXXXXXXXXX;MultipleActiveResultSets=True"

providerName="System.Data.SqlClient" xdt:Transform="SetAttributes"

xdt:Locator="Match(name)"/>

• NLOG: são as configurações para a gravação de log de erros no banco de dados. Altere

a connectionstring para a mesma que foi configurada acima, caso seu banco/senha

tenha ficado diferente do que está neste manual:

Em seguida compile o projeto - tecle F5 ou clique no botão

O banco de dados já vem com um usuário na tabela de usuários, seu login é 11111111111 e a

senha teste123, é recomendável utilizar este usuário para criar os usuários iniciais e em

seguida desativá-lo ou alterar sua senha.




OBS.: O sistema não tem um cadastro de órgãos, pois na esfera federal, os órgãos são lidos do

SIORG.

Para criar e excluir órgãos, é necessário que seja feito através do SQL Server Management

Studio, para isso é necessário ter conhecimentos de SQL. Um exemplo de script de inclusão de

órgãos (inclui_orgao.sql) está na pasta \\BancoDados\Versao_2_5_0 do repositório.

3.4 - Configuração do Reporting Services Para os relatórios serem executados, é necessário configurar o Reporting Services e criar um

usuário para acessar este serviço. Por simplicidade, usaremos o usuário uscorreicao, mas pode

ser criado um outro para este fim.

Primeiramente vamos configurar o Reporting Services. Localize no menu de programas o

“Reporting Services Configuration Manager” e o execute:




A primeira tela é para conectar ao servidor. O endereço local já vem por padrão, clique em

Conectar:




Vamos passar por cada uma das opções no menu vertical do programa:

• Service account: deixe padrão;

• Web service URL: deixe padrão e clique em Apply

• Database: clique em Change Database, será aberto outro “wizard”:

Altere o nome do servidor para localhost\sqlexpress deixe autenticação integrada:




Na tela seguinte, credenciais, vamos usar por simplicidade o usuário uscorreicao já

criado:

• Web Portal URL: deixe padrão e clique em Apply




• Demais opções: nada a configurar.

Agora vamos configurar no Windows um usuário para acessar o Reporting Services. Entre no

gerenciador de usuários locais (na caixa de pesquisa digite lusrmgr.msc)

Clique em usuários e no menu de contexto (botão direito do mouse), acesse a opção “Criar

novo usuário”.

Crie um usuário com nome uscorreicao (se você criou outro usuário de banco de dados para

acessar o reporting services, então este usuário deve ter o mesmo nome do usuário de banco

criado).




Voltando para o Visual Studio, ainda é necessário configurar o endereço do servidor de banco

de dados em mais um lugar. No Solution explorer, encontre o projeto Correicao.Reporting e

abra o arquivo CorreicaoShared.rds:

Configure o endereço do banco de dados conforme abaixo:




Execute novamente o sistema Siscor a partir do Visual Studio (teclando F5) e note se os

relatórios são publicados, como abaixo:

Em um browser digite o endereço do Reporting services (http://localhost/reportserver)

Deve haver uma pasta “Correicao", abra-a e os relatórios deverão estar publicados:




Clique em “Gerenciar Pasta” para dar acesso ao usuário uscorreicao a estes relatórios:




Feito isso, volte ao Siscor e faça um teste no relatório:

• Selecione o sistema CGU-Pad

• Clique no ícone de relatórios/consultas

• Selecione o relatório “por situação atual do procedimento”

• Preencha conforme a tela abaixo e clique em emitir relatório:




Verificando erros

1) Para ver os erros de tempo de execução do sistema, entre no SQL Server Management

Studio e faça um select na tabela LogComum:

select * from LogComum

Desta forma, será possível verificar a mensagem de erro e stack do código onde

ocorreu o erro.

Referências

[1]. Repositório do Siscor no Gitlab - https://gitlab.com/sistemas-cgu/time.dev/siscor

[2]. Sistema de controle de versão Git - https://git-scm.com/downloads

[3]. Microsoft .NET Framework - http://www.microsoft.com/pt-

br/download/details.aspx?id=17718

[4]. Microsoft Visual Studio - https://visualstudio.microsoft.com/downloads/

https://gitlab.com/sistemas-cgu/time.dev/siscor

https://git-scm.com/downloads

http://www.microsoft.com/pt-br/download/details.aspx?id=17718

http://www.microsoft.com/pt-br/download/details.aspx?id=17718

https://visualstudio.microsoft.com/downloads/




[5]. SQL Server Express – https://www.microsoft.com/pt-br/sql-server/sql-server-editions-

express

[6]. Report Viewer 2010 - http://www.microsoft.com/en-

us/download/details.aspx?id=6442



http://www.microsoft.com/en-us/download/details.aspx?id=6442

http://www.microsoft.com/en-us/download/details.aspx?id=6442

Documents

Sistemas Correcionais Manual de Implantação …...Sistemas Correcionais Manual de Implantação Versão: 1.1 Nome do arquivo: Siscor_Manual_Implantação.docx Controladoria Geral