Mudanças entre as edições de "Logs"

De Manuais de Sistemas
Ir para: navegação, pesquisa
(Consultar Registros)
Linha 1: Linha 1:
== Inclusão de registros ==<!--T:5-->
+
== Inclusão de registros ==
  
Funcionalidade responsável por incluir um registro no banco de dados da aplicação para cada operação auditável. São elas:
+
Funcionalidade interna responsável por incluir um registro no banco de dados da aplicação para cada operação auditável.  
  
'''1. Login:''' Registrada cada vez que o usuário realizar, com sucesso, o login no sistema; sendo assim, o resultado do acesso é dado como "Sucesso". Caso o mesmo seja mal sucedido, o resultado do acesso será dado como "Fracasso".
+
=== Operações ===
 +
 
 +
'''1. Login:''' Registrada cada vez que o usuário realizar, com sucesso, o login no sistema; sendo assim, o resultado do acesso é dado como '''"Sucesso"'''. Caso o mesmo seja mal sucedido, o resultado do acesso será dado como '''"Fracasso"'''.
  
 
'''2. Logout:''' Registrado quando um usuário realiza logout do sistema ou quando a sessão expirar.
 
'''2. Logout:''' Registrado quando um usuário realiza logout do sistema ou quando a sessão expirar.
  
'''3. Consulta:''' Registrado quando o usuário utiliza uma funcionalidade que possua filtros e realizam algum tipo de pesquisa interna no sistema. Nessa operação, é salvo a consulta feita pelo usuário em formato SQL.
+
'''3. Consulta:''' Registrado quando o usuário utiliza uma funcionalidade que possua filtros e realizam algum tipo de pesquisa interna no sistema. Nessa operação, é salvo, também, a consulta feita pelo usuário em formato SQL.
  
 
'''4. Edição:''' Salva um registro quando o usuário realiza uma edição em alguma funcionalidade do sistema.
 
'''4. Edição:''' Salva um registro quando o usuário realiza uma edição em alguma funcionalidade do sistema.
Linha 15: Linha 17:
 
'''6. Exclusão:''' Registrada quando o usuário realiza a exclusão de dados no sistema.
 
'''6. Exclusão:''' Registrada quando o usuário realiza a exclusão de dados no sistema.
  
Em todas as operações, são salvos campos que vão servir para consultar os registros futuramente. Estes estão detalhados na seção Consultar Registros.
+
=== Dados auditados ===
 +
 
 +
'''Data'''
 +
-----
 +
Refere-se à data em que a ação foi realizada pelo usuário.
 +
 
 +
O formato segue o padrão ''DD/MM/AAAA hh:mm:ss''.
 +
 
 +
'''Login de Acesso'''
 +
------
 +
Refere-se ao login de acesso do usuário (SAA), no qual foi usado para iniciar uma sessão no sistema.
 +
 
 +
'''Resultado de Acesso'''
 +
------
 +
Indica o resultado do login.
 +
* '''Sucesso''': indica que o login do usuário foi bem-sucedido.
 +
* '''Falha''': indica que o usuário, por alguma razão (senha incorreta, falta de permissões etc.), não conseguiu realizar o login. 
 +
 
 +
'''IP de Acesso'''
 +
------
 +
Refere-se ao IP do usuário que realizou a ação.
 +
 
 +
'''Identificador da funcionalidade'''
 +
------
 +
Refere-se ao identificador da funcionalidade (SAA) na qual o usuário realizou a ação.
 +
 
 +
'''Antes'''
 +
------
 +
Refere-se ao valor de um registro '''antes''' do mesmo ter sido alterado, criado ou excluído.
 +
 
 +
'''Depois'''
 +
------
 +
Refere-se ao valor de um registro '''após''' o mesmo ter sido alterado, criado ou excluído.
 +
 
 +
'''Consulta'''
 +
------
 +
Refere-se à uma consulta realizada pelo usuário em alguma funcionalidade que possua filtros ou pesquisa interna no sistema. A mesma é salva em formato SQL.
 +
 
 +
=== Mapeamento: Operação x Dados auditados ===
  
Obs: Somente nas operações de '''Edição, Criação e Exclusão''', são salvos 2 campos adicionais - 'Antes' e 'Depois' - utilizados para identificar como estavam os registros no momento que foram criados e/ou no momento que foram alterados.
+
{|class="wikitable"
 +
!Operação efetuada
 +
!Dados armazenados
 +
|-
 +
|Login
 +
|Data, IP de Acesso, Login de Acesso, Resultado
 +
|-
 +
|Logout
 +
|Data, IP de Acesso, Login de Acesso, Resultado
 +
|-
 +
|Criação
 +
|Antes, Data, Depois, Identificador da Funcionalidade, IP de Acesso, Login de Acesso
 +
|-
 +
|Consulta
 +
|Consulta, Data, Identificador da Funcionalidade, IP de Acesso, Login de Acesso
 +
|-
 +
|Deleção
 +
|Antes, Data, Depois, Identificador da Funcionalidade, IP de Acesso, Login de Acesso
 +
|-
 +
|Edição
 +
|Antes, Data, Depois, Identificador da Funcionalidade, IP de Acesso, Login de Acesso
 +
|}
  
== Consulta de Logs ==  
+
== Logs de Auditoria (Consulta) ==  
  
 
=== Como acessar esta funcionalidade? ===
 
=== Como acessar esta funcionalidade? ===
  
Acesse o link: https://rails-appref:8092/login. Após ter logado, na página inicial do sistema, posicione o mouse sobre o menu Administração e em seguida, clique em Logs. Será exibida a tela "Logs", conforme imagem 1.
+
Acesse o link: https://rails-appref/ (ou https://rails-appref:8092/login). Após ter [[Login APPREF (RoR)|efetuado o login]], posicione o mouse sobre a opção '''Administração''' no menu do sistema e em seguida, clique na opção '''Logs'''.
 +
 
 +
[[Arquivo:Sidebar - APPREF.png|center]]
 +
 
 +
<p style="text-align:center; font-style: italic">Imagem 1: Menu principal do sistema.</p>
 +
 
 +
Será exibida a tela "Logs de Auditoria", conforme imagem 2.
  
 
[[Arquivo:filtros_pesquisa_logs.png|880px]]
 
[[Arquivo:filtros_pesquisa_logs.png|880px]]
  
''Imagem 1.''
+
''Imagem 2: Tela '''Logs de Auditoria'''.''
  
 
=== Consultar Registros ===
 
=== Consultar Registros ===
 +
 
Esta funcionalidade exibe todos os registros que foram salvos a partir da Inclusão de Registros da auditoria do sistema.
 
Esta funcionalidade exibe todos os registros que foram salvos a partir da Inclusão de Registros da auditoria do sistema.
Inicialmente, serão exibidos todos os registros de Log salvos pelo sistema (padrão: 1000), mas os resultados podem ser filtrados. Para pesquisar por um ou mais filtros em específico, preencha um dos campos e clique no botão "Consultar". Será exibida a tela com o resultado da '''Consulta''' conforme ''imagem 2''.
+
Inicialmente, serão exibidos todos os registros de Log salvos pelo sistema (tendo como limite padrão 1000), mas os resultados podem ser filtrados.  
 +
 
 +
Somente o perfil '''Administrador''' possui acesso a esta funcionalidade.
 +
 
 +
==== Filtros de Pesquisa ====
 +
 
 +
O sistema oferece filtros de pesquisa conforme a imagem abaixo.
 +
 
 +
[[Arquivo:Filtros de Pesquisa - Auditoria.png|880px]]
 +
 
 +
''Imagem 3: Filtros de Pesquisa.''
 +
 
 +
Para filtrar registros, preencha um ou mais campos disponibilizados na seção "Filtros da Pesquisa" (''imagem 3'') e, em seguida, clique no botão [[Arquivo:Botão Buscar.png]].  
 +
 
 +
O resultado da '''Consulta''' será exibido na grid "Resultados da Pesquisa" conforme imagem abaixo.  
  
 
[[Arquivo:ResultadosDaPesquisaDH.png|880px]]
 
[[Arquivo:ResultadosDaPesquisaDH.png|880px]]
  
 +
''Imagem 4: Resultados da Pesquisa.''
 +
 +
Para limpar os filtros da pesquisa que, porventura, tenham sido preenchidos, basta clicar no botão [[Arquivo:Botão Limpar.png]].
 +
 +
O campo '''Resultado do Acesso''' só será ativado se a opção selecionada no campo '''Operação''' for '''Login'''.
 +
 +
==== Recursos presentes no grid Resultados da Pesquisa ====
 +
 +
===== Agrupamento de Resultados =====
 +
 +
Para agrupar os registros do grid de Resultados da Pesquisa, clique no botão '''Exibindo Colunas'''. Nele, serão exibidas as seguintes opções:
 +
 +
Operação, Data/hora, Login, IP, Resultado, Funcionalidade, Consulta, Antes e Depois.
 +
 +
Ao realizar uma seleção, o grid será reordenado, agrupando os registros de acordo com a opção selecionada pelo usuário.
 +
 +
===== Exibição de Colunas =====
 +
 +
O botão '''Exibindo Colunas''' é responsável por exibir ou ocultar colunas do grid. Nele, são exibidas as seguinte opções:
  
''Imagem 2.''
+
Operação, Data/hora, Login, Perfil, IP, Resultado, Funcionalidade, Consulta, Antes e Depois.
  
O sistema realiza a consulta na base de dados e exibe uma listagem de logs, podendo ser filtrado com base em um ou mais parâmetros, listados abaixo:
+
Ao realizar uma seleção, o grid será reordenado, exibindo apenas as colunas selecionadas pelo usuário.
'''Operação:''' Campo de seleção com as opções que podem ser realizadas em uma funcionalidade do sistema: '''Login, Logout, Consulta, Edição, Exclusão e Inclusão.'''
 
  
  '''Data:''' Campo de data para a inserção da Data Inicial e Data Final do período a ser consultado.
+
  Por padrão, são exibidas as colunas: '''Operação, Login, Data/hora, IP, Resultado''' e '''Funcionalidade'''.
  
'''Login de Acesso:''' Campo de texto para a inserção do login de acesso.
+
===== Ordenação de Resultados =====
  
'''Resultado de Acesso:''' Campo de seleção para escolher um dos dois resultados possíveis (sucesso e falha).
+
Para ordenar uma coluna em ordem crescente/decrescente, basta clicar no botão [[Arquivo:Botão ordenação.png]] na coluna desejada.
'''OBS:''' Esse campo só é ativado quando a operação selecionada é ''''Login'.'''
 
  
  '''IP de Acesso:''' Campo de texto para a inserção do IP de acesso do usuário.
+
  Por padrão, o grid exibe os registros por Operação, de forma crescente.
  
'''Identificador da funcionalidade:''' Campo de texto para a inserção de uma funcionalidade qualquer do sistema.
+
===== Personalizar quantidade de Resultados =====
  
'''Registros:''' Campo de seleção para escolher um valor limite para os registros a serem exibidos.
+
Por padrão, são exibidos apenas 10 registros por página no grid; porém, o usuário pode personalizá-la para 25, 50 ou 100 através do campo de seleção '''Resultados por página'''.  
'''OBS:''' Valor padrão: 1000; Valor máximo: 9999.
 
  
'''Antes:''' Campo de texto para a inserção de um valor antes de sua alteração no sistema.
+
===== Realizar Pesquisa =====
  
'''Depois:''' Campo de texto para a inserção de um valor após sua alteração no sistema.
+
O campo de formulário '''Pesquisar''' permite que o usuário pesquise por algum termo a partir dos registros exibidos no grid Resultados da Pesquisa. Ao inserir um termo, o grid será reorganizado, passando a exibir apenas registros que contenham o termo digitado.
  
=== Salvar resultados da pesquisa ===
+
===== Salvar resultados da pesquisa =====
  
A consulta de logs também permite o usuário salvar os resultados da pesquisa em diversos formatos:  
+
A consulta de logs também permite que o usuário salve os resultados da pesquisa em diversos formatos:  
  
 
   '''Copiar''': Copia todo o conteúdo existente na tabela para a área de transferência.
 
   '''Copiar''': Copia todo o conteúdo existente na tabela para a área de transferência.
  
 
   '''Excel, CSV ou PDF''': Gera um arquivo com o resultado da tabela para um destes formatos.
 
   '''Excel, CSV ou PDF''': Gera um arquivo com o resultado da tabela para um destes formatos.

Edição das 19h48min de 15 de outubro de 2020

Inclusão de registros

Funcionalidade interna responsável por incluir um registro no banco de dados da aplicação para cada operação auditável.

Operações

1. Login: Registrada cada vez que o usuário realizar, com sucesso, o login no sistema; sendo assim, o resultado do acesso é dado como "Sucesso". Caso o mesmo seja mal sucedido, o resultado do acesso será dado como "Fracasso".

2. Logout: Registrado quando um usuário realiza logout do sistema ou quando a sessão expirar.

3. Consulta: Registrado quando o usuário utiliza uma funcionalidade que possua filtros e realizam algum tipo de pesquisa interna no sistema. Nessa operação, é salvo, também, a consulta feita pelo usuário em formato SQL.

4. Edição: Salva um registro quando o usuário realiza uma edição em alguma funcionalidade do sistema.

5. Criação. Registrada quando o usuário realiza a inclusão de dados no sistema.

6. Exclusão: Registrada quando o usuário realiza a exclusão de dados no sistema.

Dados auditados

Data


Refere-se à data em que a ação foi realizada pelo usuário.

O formato segue o padrão DD/MM/AAAA hh:mm:ss.

Login de Acesso


Refere-se ao login de acesso do usuário (SAA), no qual foi usado para iniciar uma sessão no sistema.

Resultado de Acesso


Indica o resultado do login.

  • Sucesso: indica que o login do usuário foi bem-sucedido.
  • Falha: indica que o usuário, por alguma razão (senha incorreta, falta de permissões etc.), não conseguiu realizar o login.

IP de Acesso


Refere-se ao IP do usuário que realizou a ação.

Identificador da funcionalidade


Refere-se ao identificador da funcionalidade (SAA) na qual o usuário realizou a ação.

Antes


Refere-se ao valor de um registro antes do mesmo ter sido alterado, criado ou excluído.

Depois


Refere-se ao valor de um registro após o mesmo ter sido alterado, criado ou excluído.

Consulta


Refere-se à uma consulta realizada pelo usuário em alguma funcionalidade que possua filtros ou pesquisa interna no sistema. A mesma é salva em formato SQL.

Mapeamento: Operação x Dados auditados

Operação efetuada Dados armazenados
Login Data, IP de Acesso, Login de Acesso, Resultado
Logout Data, IP de Acesso, Login de Acesso, Resultado
Criação Antes, Data, Depois, Identificador da Funcionalidade, IP de Acesso, Login de Acesso
Consulta Consulta, Data, Identificador da Funcionalidade, IP de Acesso, Login de Acesso
Deleção Antes, Data, Depois, Identificador da Funcionalidade, IP de Acesso, Login de Acesso
Edição Antes, Data, Depois, Identificador da Funcionalidade, IP de Acesso, Login de Acesso

Logs de Auditoria (Consulta)

Como acessar esta funcionalidade?

Acesse o link: https://rails-appref/ (ou https://rails-appref:8092/login). Após ter efetuado o login, posicione o mouse sobre a opção Administração no menu do sistema e em seguida, clique na opção Logs.

Sidebar - APPREF.png

Imagem 1: Menu principal do sistema.

Será exibida a tela "Logs de Auditoria", conforme imagem 2.

Filtros pesquisa logs.png

Imagem 2: Tela Logs de Auditoria.

Consultar Registros

Esta funcionalidade exibe todos os registros que foram salvos a partir da Inclusão de Registros da auditoria do sistema. Inicialmente, serão exibidos todos os registros de Log salvos pelo sistema (tendo como limite padrão 1000), mas os resultados podem ser filtrados.

Somente o perfil Administrador possui acesso a esta funcionalidade.

Filtros de Pesquisa

O sistema oferece filtros de pesquisa conforme a imagem abaixo.

Filtros de Pesquisa - Auditoria.png

Imagem 3: Filtros de Pesquisa.

Para filtrar registros, preencha um ou mais campos disponibilizados na seção "Filtros da Pesquisa" (imagem 3) e, em seguida, clique no botão Botão Buscar.png.

O resultado da Consulta será exibido na grid "Resultados da Pesquisa" conforme imagem abaixo.

ResultadosDaPesquisaDH.png

Imagem 4: Resultados da Pesquisa.

Para limpar os filtros da pesquisa que, porventura, tenham sido preenchidos, basta clicar no botão Botão Limpar.png.

O campo Resultado do Acesso só será ativado se a opção selecionada no campo Operação for Login.

Recursos presentes no grid Resultados da Pesquisa

Agrupamento de Resultados

Para agrupar os registros do grid de Resultados da Pesquisa, clique no botão Exibindo Colunas. Nele, serão exibidas as seguintes opções:

Operação, Data/hora, Login, IP, Resultado, Funcionalidade, Consulta, Antes e Depois.

Ao realizar uma seleção, o grid será reordenado, agrupando os registros de acordo com a opção selecionada pelo usuário.

Exibição de Colunas

O botão Exibindo Colunas é responsável por exibir ou ocultar colunas do grid. Nele, são exibidas as seguinte opções:

Operação, Data/hora, Login, Perfil, IP, Resultado, Funcionalidade, Consulta, Antes e Depois.

Ao realizar uma seleção, o grid será reordenado, exibindo apenas as colunas selecionadas pelo usuário.

Por padrão, são exibidas as colunas: Operação, Login, Data/hora, IP, Resultado e Funcionalidade.
Ordenação de Resultados

Para ordenar uma coluna em ordem crescente/decrescente, basta clicar no botão Botão ordenação.png na coluna desejada.

Por padrão, o grid exibe os registros por Operação, de forma crescente.
Personalizar quantidade de Resultados

Por padrão, são exibidos apenas 10 registros por página no grid; porém, o usuário pode personalizá-la para 25, 50 ou 100 através do campo de seleção Resultados por página.

Realizar Pesquisa

O campo de formulário Pesquisar permite que o usuário pesquise por algum termo a partir dos registros exibidos no grid Resultados da Pesquisa. Ao inserir um termo, o grid será reorganizado, passando a exibir apenas registros que contenham o termo digitado.

Salvar resultados da pesquisa

A consulta de logs também permite que o usuário salve os resultados da pesquisa em diversos formatos:

 Copiar: Copia todo o conteúdo existente na tabela para a área de transferência.
 Excel, CSV ou PDF: Gera um arquivo com o resultado da tabela para um destes formatos.