MANUAL DO ADMINISTRADOR DO MÓDULO

Transcrição

1 MANUAL DO ADMINISTRADOR DO MÓDULO

2 ÍNDICE Relatórios Dinâmicos... 3 Requisitos de Sistema... 4 Estrutura de Dados... 5 Operadores... 6 Tabelas... 7 Tabelas x Campos... 9 Temas Hierarquia Relacionamento Sistemas Módulos Exportação Temas Importação Temas Exportação Relatórios Importação Relatórios Acessos Relatórios Grupo Acesso Grupo Acesso x Temas Grupo Acesso x Usuários Restrição de Campos Módulo x Tema Filtros Temas Segurança Grupo Acesso - RD Unidade Acesso - RD Grupo Acesso x Unidade Acesso RD Grupo Acesso RD x Usuários Consulta Auditoria Relatórios Dinâmicos Novo Relatório Funcionalidades Relatórios Disponíveis Página 2 de 47

3 Relatórios Dinâmicos A ferramenta Relatórios Dinâmicos foi desenvolvido para disponibilizar aos administradores de sistemas e usuários uma ferramenta que permita maior independência na geração de relatórios. O objetivo principal da ferramenta é dar ao usuário maior flexibilidade na seleção das informações que se deseja consultar, bem como adicionar filtros de pesquisa, ordenação de dados e funções de agregação. Lembrando que estas funções de agregação são limitadas, pois o foco do módulo é a geração de informações em forma de listagem. Para grandes processamentos de dados e cálculos, as ferramentas de BI (Business Intelligence) são indispensáveis. A ferramenta ainda possibilita a gravação destes relatórios personalizados e compartilhamento aos demais usuários do grupo. Para geração dos relatórios os usuários terão acesso às informações previamente cadastradas no banco de dados pelo analista responsável. As informações são carregadas de uma base de dados onde pode ter atualizações on-line ou não, ficará a critério de cada projeto definir a origem destas informações. Quando a origem de algumas informações não é on-line elas são carregadas periodicamente. O analista responsável deverá montar temas que acessam diretamente a base com atualizações on-line ou criar uma carga periódica destas informações em tabelas secundárias ou para isolar o processamento de dados na mesma base ou por existir mescla de informações de origens distintas. Página 3 de 47

4 Requisitos de Sistema Abaixo estão os requisitos de sistema necessários para a instalação e utilização: Hardware: PC x86 com processador 1Ghz 1GB (2GB Recomendados) 500 MB de espaço disponível em disco rígido Software: Microsoft Windows 2000, Microsoft Windows XP, ou Microsoft Windows Vista.*, Windows 7 Microsoft Internet Explorer 8.0 (ou superior) ou Mozila FireFox 3.6 (ou superior) Plugins Necessários: JAVA Runtime Edition 6 (disponível em Adobe Reader 9 (disponível em Adobe Flash Player 10 (disponível em Equipamentos Opcionais: Para utilização de autenticação via Token OTP: Token OTP fornecido pela BRToken. Página 4 de 47

5 Estrutura de Dados Função Agregada A tela tem a finalidade de cadastrar a função agregada que será utilizada nos campos numéricos (Decimal). A tela permite inserir, editar e excluir uma função. No menu Estrutura de Dados, ao clicar na opção Função Agregada a seguinte tela será aberta: Página 5 de 47

6 Operadores A tela Operadores tem como finalidade cadastrar o operador de filtros que o usuário utilizará para filtrar os dados na geração dos relatórios, o cadastro desses operadores é de responsabilidade do analista do sistema. A tela permite inserir, editar e excluir um operador de filtro. No menu Estrutura de Dados, ao clicar na opção Operadores a seguinte tela será aberta: Página 6 de 47

7 Tabelas Esta tela tem a finalidade de cadastrar as tabelas que o usuário irá visualizar na geração dos relatórios. São tabelas cadastradas pelo analista de acordo com as tabelas existentes no banco de dados. A tela permite inserir, editar e se essa tabela não tiver sido vinculada a nenhum campo é possível sua exclusão. No menu Estrutura de Dados, ao clicar na opção Tabelas a seguinte tela será aberta: Observação: Caso o analista necessite de uma regra mais complexa na criação de tabelas, poderá ser feito por criação de VIEW. Aba de inserção: Página 7 de 47

8 Existe a possibilidade de efetuar a execução de um Stored Procedure para popular os dados de uma tabela antes da emissão do relatório. Para utilizar uma Stored Procedure, basta informar o nome da mesma no campo referente ao nome da SP, e logo abaixo, informar na ordem os parâmetros que essa SP possuir. Dica 1: O campo nome do parâmetro da SP, informar um nome amigável ao usuário e não o nome contido da SP. O tipo do parâmetro é muito importante para a execução da SP, pois em alguns casos, quando o tipo é informado de forma incorreta, pode ocasionar erros na execução da SP. Dica 2: O analista tem a possibilidade de enviar um comando para ser executado antes da execução da SP. Isto normalmente se aplica para setar algum parâmetro na sessão da conexão para que seja executada corretamente a SP. O sistema também possibilita informar valores domínio para um determinado filtro da SP. Este pode ser informado de duas formas: por meio de um De/Para ou por meio de um SQL para a pesquisa dos valores. O JAVA é Case Sensitive, portanto ele faz a diferenciação de letras maiúsculas e minúsculas, sendo assim as tabelas deverão ser cadastradas idênticas ao que está no banco de dados. Página 8 de 47

9 Tabelas x Campos Nesta tela o analista irá vincular as Tabelas cadastradas anteriormente a um Campo. Os campos que estão disponíveis para ser adicionados a uma tabela são carregados automaticamente do banco de dados, estes só será possível adicioná-los uma única vez para não ter duplicidade. No menu Estrutura de Dados, ao clicar na opção Tabelas x Campos a seguinte tela será aberta: Ao selecionar a tabela e clicar no botão será aberta a aba: Página 9 de 47

10 O sistema carrega as informações Nome Físico Tabela e Nome Amigável Tabela, e os campos que estão disponíveis, clicar sob o campo desejado e na adicioná-lo. para Ao adicionar um campo clicar em, na coluna dados dos campos o Nome Físico trás automático, Nome Amigável é flexível, se o analista não informar o sistema utiliza o mesmo nome físico. O analista ainda irá definir os campos: Tipo de Dado e Máscara, Visível, Totalizador, Campo Domínio, escolher o Tipo de Filtro Domínio. Ao escolher a opção Visível o analista deixará o campo visível para o usuário na geração do relatório, ao selecionar a opção Mostra Opções de Filtro, será para fazer a busca de filtro automática no banco para o usuário escolher um filtro quando gerar um relatório. O Totalizador permitirá que o usuário totalize na geração do relatório. Quando selecionar Campo Domínio a opção Valores será habilitada: Página 10 de 47

11 Essa opção faz um De/Para no campo. Tipo Filtro Domínio há duas opções: Checkbox - o layout da tela de filtro será a seguinte: Combobox - o layout da tela de filtro será a seguinte: Página 11 de 47

12 Clicar em e. Observação: Ao selecionar uma tabela de endereço na opção Tipo de Dado se gravar como Endereço Numero, esta informação poderá aparecer quando o usuário visualizar o Geo Mapa! Tendo que ser a união de endereço + endereço numero para funcionar o Geo. Página 12 de 47

13 Temas Tema é um conjunto de informações que estarão disponíveis para a geração de um relatório. Este conjunto de informações será formado por tabelas e campos organizados hierarquicamente, dentro desta hierarquia obrigatoriamente deverá existir uma tabela principal a partir de onde as demais informações ficarão interligadas. Nessa tela será feito o cadastro de um tema, a descrição do mesmo será informado pelo analista e todo tema está atrelado a uma tabela principal. A tela também permite editar e excluir. No menu Estrutura de Dados, ao clicar na opção Temas a seguinte tela será aberta: Observação: Caso um determinado Tema estiver sendo utilizado em relatórios pelo usuário do sistema não será possível sua exclusão, porém se não tiver sendo utilizado poderá ser excluído o Tema e toda sua vinculação. Página 13 de 47

14 Hierarquia Relacionamento No menu Estrutura de Dados,, ao clicar na opção Hierarquia Relacionamento a seguinte tela será aberta: Nessa tela será feita a busca pelo tema, selecioná-lo e clicar no botão será aberta a tela para cadastrar as hierarquias de relacionamento, tendo como finalidade cadastrar o relacionamento (JOIN) das tabelas com outras, relacionando campos que faz JOIN das tabelas. EX: TAB PAI.CampoA = TAB FILHA.CampoA, é possível vários relacionamentos dos campos. Página 14 de 47

15 Sistemas Esta tela tem a finalidade de cadastrar os sistemas que estarão vinculados no módulo RD. Deverá cadastrar uma descrição e o código externo é o identificador de cada projeto. No menu Estrutura de Dados, ao clicar na opção Sistemas a seguinte tela será aberta: É necessário preencher todos os campos da tela para a inserção. Página 15 de 47

16 Módulos A tela tem a finalidade de cadastrar os sistemas que utilizaram a ferramenta RD. À tela permite a inserção, alteração e exclusão. No menu Estrutura de Dados, ao clicar na opção Módulos a seguinte tela será aberta: Página 16 de 47

17 Exportação Temas A tela tem a finalidade de exportar um determinado tema de um ambiente para outro. No menu Estrutura de Dados, ao clicar na opção Exportação de Temas a seguinte tela será aberta: Página 17 de 47

18 Importação Temas Essa tela tem a finalidade de importar o arquivo gerado na exportação de temas (xml) para um outro ambiente. No menu Estrutura de Dados, ao clicar na opção Importação de Temas a seguinte tela será aberta: Página 18 de 47

19 Exportação Relatórios A tela tem a finalidade de exportar um determinado relatório de um ambiente para o outro, exemplo: quando o analista executa um relatório no ambiente de desenvolvimento e este está ok, utiliza a exportação para o ambiente de produção. No menu Estrutura de Dados, ao clicar na opção Exportação de Relatórios a seguinte tela será aberta: Página 19 de 47

20 Importação Relatórios Essa tela tem a finalidade de importar o arquivo gerado na exportação de relatórios (xml) para um outro ambiente. No menu Estrutura de Dados, ao clicar na opção Importação de Relatórios a seguinte tela será aberta: Página 20 de 47

21 Acessos Relatórios Grupo Acesso Nessa tela o analista responsável pelo módulo deverá definir os grupos de usuários que terão acesso ao Relatórios Dinâmicos. No menu Acessos - Relatórios, ao clicar na opção Grupo Acesso a seguinte tela será aberta: Página 21 de 47

22 Grupo Acesso x Temas Após cadastrar os grupos que terão acesso ao RD, o analista deverá vincular quais os temas esse grupo terá acesso. No menu Acessos - Relatórios, ao clicar na opção Grupo Acesso x Temas a seguinte tela será aberta: O analista deverá verificar os temas disponíveis e adicioná-los ao grupo: Página 22 de 47

23 Grupo Acesso x Usuários A tela tem a finalidade de vincular os usuários que terão acesso ao grupo que já tenha sido castrado anteriormente. Para fazer a busca dos usuários, a informação vem através da Webservice e o analista tem que realizar a alteração para cada módulo. No menu Acessos - Relatórios, ao clicar na opção Grupo Acesso x Usuários a seguinte tela será aberta: A aba de cadastro não busca automaticamente os usuários, é necessário pesquisar: Página 23 de 47

24 Página 24 de 47

25 Restrição de Campos Ao realizar a busca na tela, deverá aparecer uma lista dos grupos cadastrados, ao editar o analista deverá vincular o tema e a tabela ao grupo de acesso, todos os campos estão disponíveis, o analista responsável deverá bloquear os campos que NÃO serão vinculados. Como default todos os campos serão carregados! No menu Acessos - Relatórios, ao clicar na opção Restrição de Campos a seguinte tela será aberta: Página 25 de 47

26 Módulo x Tema Os módulos que já foram cadastrados para ter acesso ao Relatórios Dinâmicos, deverão ser vinculados ao temas. No menu Acessos - Relatórios, ao clicar na opção Módulo x Tema a seguinte tela será aberta: Conforme exemplo vincular os temas necessários: Página 26 de 47

27 Filtros Temas Ao gerar alguns relatórios o processo pode ficar lento devido o volume de informações, para esses casos específicos o analista pré-determina um filtro no campo, assim serão obrigatoriamente pedidos para o usuário antes de gerar o relatório, como se fosse um filtro prompt. No menu Acessos - Relatórios, ao clicar na opção Filtros Temas a seguinte tela será aberta: Página 27 de 47

28 Segurança Grupo Acesso - RD A tela tem a finalidade de cadastrar grupos de usuários que terão acesso ao Relatórios Dinâmicos. No menu Segurança, ao clicar na opção Grupo Acesso - RD a seguinte tela será aberta: Página 28 de 47

29 Unidade Acesso - RD A unidade acesso é o cadastro do menu do módulo RD. No menu Segurança, ao clicar na opção Unidade Acesso - RD a seguinte tela será aberta: Página 29 de 47

30 Grupo Acesso x Unidade Acesso RD Após cadastrar os grupos que terão acesso ao RD, o analista deverá vincular o menu que esse determinado grupo terá acesso. No menu Segurança, ao clicar na opção Grupo Acesso x Unidade Acesso - RD a seguinte tela será aberta: Página 30 de 47

31 Grupo Acesso RD x Usuários Essa tela tem a finalidade de vincular o grupo de acesso do sistema a usuários que terão acesso ao RD. No menu Segurança, ao clicar na opção Grupo Acesso RD x Usuários a seguinte tela será aberta: Página 31 de 47

32 Consulta Auditoria Nessa tela fica registrado em forma de consulta todas as alterações,sql, logins. A tela está divida em 3 abas independentes: No menu Segurança, ao clicar na opção Consulta Auditoria a seguinte tela será aberta: Auditoria Login: Auditoria Relatórios: Página 32 de 47

33 Página 33 de 47

34 Relatórios Dinâmicos Novo Relatório No menu Relatórios Dinâmicos, clicar na opção Novo Relatório a seguinte tela será aberta: Para cadastrar um novo relatório clicar no botão e selecione um tema neste campo deverá aparecer os temas de relatórios que cada usuário tem acesso, o usurário irá perceber que logo abaixo do campo Tema será listado as informações, conforme exemplo abaixo: Página 34 de 47

35 Para a montagem do relatório é necessário que o usuário selecione os campos que deseja com duplo clique. No canto direito da tela irá aparecer na linha Campos Selecionados, as opções que o usuário selecionou, conforme exemplo: Para visualizar em forma de relatório as opções selecionadas, clique no botão, o sistema irá expandir na tela, conforme exemplo: O usuário tem a possibilidade de escolher como será gerado o relatório entre as opções: Para salvar um novo relatório clique no botão, a seguinte tela será aberta: Página 35 de 47

36 O usuário deverá informar os campos: Título Relatório, Nome Relatório e Detalhes, se a opção Público for selecionada, este relatório poderá ser visualizado por outros usuários com acesso ao módulo. Caso a opção não seja assinalada, o relatório poderá ser visualizado apenas pelo usuário que o criou. Clicar no botão para confirmar. A tela possibilita ao usuário selecionar informações opcionais caso seja necessário: Título Auxiliar: nesse campo o usuário poderá informar qualquer nome para o título, por exemplo: o nome da Empresa; Subtítulo Auxiliar: nesse campo o usuário poderá informar qualquer nome para o subtítulo, por exemplo: o nome do Órgão; Sigla:o usuário poderá informar a sigla da Empresa ou Órgão; Orientação: definir se a formatação será em paisagem ou retrato; Mostra Total Reg do Cabeçalho: ao selecionar essa opção, será exibido no cabeçalho do relatório o total de registro; Mostra Total Reg Grupo: essa opção exibirá o total de registro por grupo; Página 36 de 47

37 Mostra Operador Filtros SP: quando um campo selecionado tem um filtro com operador pré-definido, por exemplo "Quantidade de Imóvel" maior 10 menor que 100, selecionando essa opção não irá exibir o operador desse filtro; Tamanho Fonte: o sistema possibilita escolher o tamanho da fonte entre 5 e 14; Mostra Linha de Registro: o relatório é exibido em linhas, ao clicar nessa opção não irá aparecer as linhas; Trunca Valor Registro: quando o relatório tem muitas colunas, ao clicar nessa opção o sistema irá "cortar" a palavra no tamanho máximo que a coluna; Mostra Operador Filtros Report: quando um campo possui um filtro com o operador selecionado pelo usuário e este não quer que seja exibido; Forçar Distinct: esta opcao ira mostar somente 1 vez os valores de cada linha, ocultando os valores repetidos (todos os campos devem ser iguais); No Campo Gráfico: Ao selecionar a opção Gerar Gráfico será habilitado os campos para seleção: Tipo Gráfico, Campo Valor, Campo Legenda; Somente será gerado Gráfico quando selecionado um campo valor (numérico) e um campo texto. O sistema permite a busca de relatórios já existentes, desde que esse seja público, clicar no botão, a tela será aberta conforme exemplo: Página 37 de 47

38 Selecione um tema, o sistema carregará automaticamente os relatórios salvos. Clique sob o relatório desejado para expandir na tela. O usuário poderá alterar, incluir ou excluir as informações apenas para gerar na tela. Porém quando o usuário logado for diferente do usuário que o criou e quiser salvar o relatório com as informações terá que clicar em aparecer a seguinte tela: salvar como e irá Página 38 de 47

39 O usuário deverá informar os campos da tela e clicar em relatório já existente o usuário poderá criar o seu próprio relatório., a partir de um Para excluir um relatório clique no botão, a seguinte tela será aberta: Selecione um tema, o relatório será carregado de acordo com o tema selecionado dentre os que serão listados escolha o relatório que será excluído, no entanto você só poderá excluir os relatórios criados por você, respeitando esse fator clique no botão para exclusão. Página 39 de 47

40 Funcionalidades O sistema Relatórios Dinâmicos, possui funcionalidades que auxiliam a geração dos dados. Filtro Selecionado Na coluna Tema ao selecionar um campo e clicar com o botão direito do mouse, aparecerá um botão:. Essa função possibilita o usuário selecionar um filtro para o relatório, escolher a opção Adicionar Filtro e aparecerá a tela conforme exemplo: Selecione um operador e informe um valor, clique no botão, assim o filtro terá sido selecionado. O relatório será gerado com esse filtro, mas para que seja exibido a descrição do filtro em tela, será necessário clicar na opção Filtro Impressão. Caso selecione a opção Prompt, sempre que gerar o relatório será necessário informar o filtro, alguns campos poderão vir com o Prompt selecionado, pois terão campos com filtro já definido. Alguns campos poderão vir com Valores pré definidos como mostra a figura abaixo: Página 40 de 47

41 Após inserir um filtro no campo perceba que no centro da tela no campo Filtros Selecionados será exibido sua seleção, conforme exemplo: É possível inserir filtro em mais de um campo, em caso de relatórios já salvos, por exemplo, é possível consultar o filtro adicionado, clique no botão para obter a informação. Caso queira excluir o filtro clique no botão. Função Selecionada Será possível inserir em alguns campos Funções para o relatório, selecione o campos que serão gerados, clique no botão a tela será exibida: Selecione uma função e clique no botão, a função será adicionada. Perceba que no centro da tela no campo Funções Selecionadas será exibida sua seleção, conforme exemplo: Página 41 de 47

42 É possível inserir funções em mais de um campo, em caso de relatórios já salvos, por exemplo, é possível consultar a função adicionada ao campo, clique no botão para obter a informação. Caso queira excluir a função clique no botão. Ordem Selecionada O usuário tem a possibilidade de ordenar os campos conforme deseja, após selecionar os campos para a geração do relatório, escolha o campo que será ordenado e clique no botão, a ordem que o relatório irá obedecer com a seta voltada para cima será a crescente, com seta voltada para baixo o sistema obedece a ordem decrescente. Após ordenar um campo perceba que no centro da tela será exibida sua seleção, conforme exemplo: É possível inserir mais de uma ordem ao relatório. Perceba que ao selecionar uma ordem o sistema automaticamente exibe o botão grupos, conforme exemplo:, este possibilita a seleção de Perceba que ao selecionar um Grupo será exibido a opção de quebra de página é só clicar nesse botão para inserir ou remover a quebra de página do relatório. Totalizadores Selecionados Os campos que possuem totalizadores terá o botão, esses campos já estão definidos pelo analista responsável do módulo, o usuário poderá excluir a opção, para gerar o relatório sem totalizador. Selecionado um campo com totalizador, conforme exemplo abaixo: Página 42 de 47

43 O sistema exibe automaticamente a opção no campo totalizador: Caso não necessite do totalizador para esse campo na geração do relatório clique no botão para retirar a opção. Configurar Campo O usuário tem a possibilidade de alinhar as colunas do relatório: a Direita, Esquerda e Centro, ao clicar no botão. A tela será exibida conforme figura abaixo, selecione no combo a opção desejada e clique em. Os campos relacionados aos temas são definidos pelo analista responsável do módulo, porém o sistema possibilita que o usuário edite em seus relatórios os nomes dos campos. Conforme exemplo: => Para alterar o nome do campo dê duplo clique sob o nome, delete o nome e o campo ficará em branco edite conforme desejado e dê enter, o nome será alterado. Ao visualizar o relatório irá aparecer no layout o nome editado pelo usuário, caso o usuário não salve essa alteração volta ao nome anterior. Observe que na coluna do Tema o nome não será alterado. A ordem das colunas poderá ser alterada pelo usuário, conforme exemplo: Página 43 de 47

44 No exemplo acima o campo Locado está sendo movido para a última coluna, clique na coluna e arraste. Pode-se alterar quais colunas desejar. Caso queira excluir um campo clique no botão, para removê-lo. Página 44 de 47

45 Relatórios Disponíveis No menu Relatórios Dinâmicos o usuário poderá consultar relatórios públicos que foram criados por demais usuários com acesso ao sistema, clicar na opção Relatórios Disponíveis a seguinte tela será aberta: Para realizar a busca dos relatórios clique no botão localizado no canto direito da tela, se optar por uma busca mais rápida pode-se utilizar filtro. O sistema retornará na tela os relatórios disponíveis, com as opções: Clicar em uma das opções para gerar o relatório. A tela será aberta conforme exemplo: Página 45 de 47

46 Caso clique no botão, o sistema abrirá a tela conforme exemplo: Ao escolher um relatório disponível, mas que NÃO foi criado por você, o sistema permite alterações em tela, porém caso tente salvar será exibida a mensagem: Página 46 de 47

47 Não é permitida exclusão por outro usuário e a edição só será salva, se utilizar a opção salvar como. Página 47 de 47