Knowledge Base: Mastersiga Consultoria

Mastersiga Consultoria ❱ TOTVS Linha ProtheusCustomizações (ADVPL)

Protheus Report

Protheus Report

O Protheus Report é um aplicativo do Sistema que permite a criação de relatórios personalizáveis de forma prática.

Desta forma, a criação do relatório é realizada por meio de seções que serão impressas de uma determinada tabela. Para isso, é necessário definir em cada seção os campos que constarão no relatório, e ainda relacioná-lo com tabelas secundárias para trazer informações adicionais.

Além de permitir definir cores, estilos, tamanho, fontes, quebras, máscara das células para cada seção, criação de totalizadores por seção e/ou grupos de campos, fórmulas e funções (Soma, Média, etc.), salvar as configurações, criar gráficos.

Com essas funcionalidades, é possível modificar os relatórios criados, desenvolvendo seus próprios leiautes.

Além disso, com base em um dado comum é possível agrupar as informações no relatório, facilitando a sua organização e visualização.

O relatório criado pode ser enviado à impressora, ao disco, e-mail, html, Microsoft Excel® ou ainda pode ser executado a partir do menu de um dos ambientes do sistemas. Veja o tópico Menus no Configurador.

Dica:

Os relatórios personalizados são gravados com extensão .XRP, diferenciando-se dos relatórios padrões que recebe a extensão .##R e dos personalizáveis que tem extensão .PRT.

Para acessar o Protheus Report:

  1. No menu Miscelânea, selecione Protheus Report.
    A primeira seção é a principal e define as características gerais de todo o relatório.
  2. Para a seção principal é possível definir:
    • Propriedades
    •  Visualização de layout

 

Propriedades

Configurando as Propriedades:

1. Na área Propriedades, clique na caixa Título e informe um título para identificação do relatório.


    • Título
      Define o título que será apresentado no cabeçalho do relatório.
    • Altura da linha
      A altura padrão para todas as linhas do relatório. É recomendável que essa configuração seja definida considerando o tamanho da fonte utilizada.
      Para cada seção também pode-se definir altura das linhas. O Sistema aplica de forma diferenciada as alturas das linhas.
    • Espaçamento entre colunas
      Define o espaçamento em pontos (caracter) entre as colunas
    • Margem esquerda
      A margem esquerda em pontos (caracter) para todo o relatório. Também será possível definir a margem esquerda de cada seção, criando indentações na disposição dos dados.
    • Número inicial da página
      O número da página do relatório em que deve-se iniciar a impressão. Esse recurso é útil quando deseja-se reiniciar a impressão a partir de uma página do relatório.
    • Fonte
      A fonte e o tamanho de letra que será utilizada em todo relatório. São listadas todas as fontes disponíveis no ambiente operacional, porém, o tamanho da fonte está limitado a 16 pontos.
    • Negrito
      A fonte utilizada no relatório pode ser impressa mais grossa que o comum.
    • Sublinhado
      A fonte utilizada no relatório pode ser impressa sublinhada, marcada.
    • Imprimir
      Define a apresentação ou inibição dos dados de: cabeçalho do relatório, rodapé e páginas inicial de configuração dos parâmetros. Além disso, é possível definir o formato de impressão, tais como: retrato ou paisagem.
    • Parâmetros
      Permite incluir, editar, excluir, visualizar e preview das perguntas que serão apresentadas na janela de Parâmetros, para serem utilizadas no filtro de dados do relatório configurados no relacionamento da tabela principal da seção. Para isso, deve-se configurar a expressão de filtro da tabela.
      Exemplo:
      B1_COD>=MV_PAR01 and B1_COD<=MV_PAR02.

2. Selecione Incluir e, em seguida, Configuração.
    É apresentada a janela Novo Grupo de Perguntas.

3. Clique no campo Pergunta e digite a pergunta.
4. Preencha os demais campos conforme a descrição a seguir:


    • Pergunta Espanhol; Inglês
      Informe a pergunta em espanhol e inglês.
    • Tipo
      Selecione o tipo da resposta pergunta, se: 1=Caracter, 2=Numérico ou 3=Data
    • Tamanho
      Informe o tamanho do campo para resposta à pergunta.
    • Decimal
      Informe o número de casas decimais para a resposta numérica, se necessário.
    • Formato
      Informe a máscara para preenchimento deste parâmetro.
    • Help
      Digite um texto explicativo sobre a função da pergunta.
    • Objeto
      Selecione como a pergunta deve ser apresentada na janela, se:
      • 1 = Edit (Formato que permite editar o conteúdo).
      • 2 = Text (Permite apresentar, como conteúdo, um texto padrão; apenas para visualização, não poderá ser alterado).
      • 3 = Combo (Formato que apresenta uma lista de opções para seleção dos dados).
      • 4 = Range (Permite definir intervalos de dados seqüenciais).
      • 5 = File (Permite selecionar um arquivo do servidor ou da estação local).
      • 6 = Expression (Permite definir uma expressão de filtro).
      • 7 = Check (Permite selecionar até cinco itens).
    • Consulta Padrão (Edit)
      Para habilitar uma consulta [F3] ao campo, selecione a tabela para pesquisa.
    • Conteúdo (Text)
      Permite informar o conteúdo padrão para o campo, se o objeto for "1=Edit" ou "2=Text".
    • Pré-seleção (Combo)
      Se o objeto for 3 = Combo (lista de opções), pode-se definir qual a opção será posicionada automaticamente para seleção. Informe de 1 a 5 para identificar as opções, respectivamente.
    • Item 1 a 5 (Combo)
      Informe, nestes campos, as opções que serão apresentadas para seleção, quando o objeto for 3 = Combo.
    • Pode-se definir até 5 opções para seleção, que devem ser definidas em seqüência (não pode existir lacuna entre as opções).

5. Para finalizar, clique em Ok.
    O Sistema retornará à pasta Propriedade.

6. Clique em Adicionar seção para incluir uma seção para o relatório.
    É apresentada a janela Propriedades da seção específica.

Visualização de Layout

Permite visualizar como será impresso o relatório para o layout configurado.

Nota:

Para visualização do layout de relatório criado, é necessário salvar por meio da opção Salvar Relatório.

Visualizando um Relatório em Fase de Criação:

  1. Na área Visualização de Layout é apresentada a janela Informe o nome do arquivo.
  2. Configure os seguintes dados:
    • Nome do arquivo
    Informe o nome do relatório.
    • Diretórios
    Selecione a pasta onde o relatório será salvo.
    • Lista apenas os arquivos do tipo
       Selecione o tipo de relatório que deseja salvar, tais como: Protheus Report (*.xrp)
  3. Clique em Salvar, para gravar o layout.
    O Sistema apresenta o layout do relatório.

Visualizando um relatório armazenado:

  1. Na área Visualização de Layout é apresentada a janela Informe o nome do arquivo.
  2. Configure os seguintes dados:
    • Diretórios
    Selecione a pasta onde o relatório foi salvo. Observe que do lado direito da janela, o Sistema apresentada os arquivos salvos.
    • Lista apenas os Arquivos do Tipo
      Selecione o tipo de relatório que deseja visualizar, como: Protheus Report (*.xrp)
  3. Selecione o arquivo desejado e clique em Abrir.
    É apresentado o layout do relatório.
  4. Para ampliar ou diminuir a visualização do layout, clique em Zoom e selecione a porcentagem desejada.


Seções Específicas

Ao abrir a árvore das seções, são apresentadas as seções específicas do relatório, que podem receber atributos individualmente. Basta posicionar sobre o título da seção e configurá-la.

Por exemplo: para a seção Produtos, utiliza-se destaque com bordas e para a seção Dados dos títulos, destaque em cor.

Note que existem três áreas para configuração das seções: Propriedades (apresentada automaticamente); Células e Filtro (apresentadas na parte inferior da janela).

Incluindo uma seção específica:

1. Na seção principal, clique em Adicionar seção.

São apresentadas as seguintes opções:

  • Propriedades
  • Relacionamento
  • Células


Propriedades

1. Na área Propriedades, clique na caixa Título e informe um título para identificação da seção.
2. Configure as seguintes especificações:


    • Imprimir
      Permite definir se os dados dos itens da seção devem ser impressos. Caso a seção seja inibida, somente seus totais de valores são apresentados, como em um relatório sintético.
    • Título da seção
      Define se será ou não impresso o título da seção.
    • Células em linha
      Define se as células (campos) serão apresentadas em formato colunas ou em linhas. Se selecionada a opção linhas, em Colunas (células em linha), é possível definir quantas células por linha devem ser impressas.
    • Cabeçalho das células
      Define se os cabeçalhos das células (nome dos campos) devem ser exibidos.
    • No topo da página
      Configura a apresentação do cabeçalho acima de cada célula (topo da página).
    • Após as quebras
      Repete o cabeçalho sempre que houver quebra de página.
    • Altura e espaçamento entre linhas
      A altura da linha e o espaçamento entre linhas podem ser ajustados. É recomendável que essa configuração seja definida considerando o tamanho de fonte utilizado.
    • Margem esquerda
      O espaço em pontos para margem esquerda da seção. Para a impressão será considerada a margem do relatório mais a margem da seção.
    • Quebra linha na impressão de colunas
      Quando o relatório possui muitas colunas, dependendo do tamanho da fonte utilizada, pode ocasionar o truncamento de informações. Assim, com essa opção marcada, se não couberem todas as colunas na mesma linha, o sistema continua a impressão dos dados na linha seguinte.
    • Ajustar células
      Se for utilizado um tamanho grande de fonte, pode ser necessário ajustar o tamanho da colunas para que seja possível balancear o espaço utilizado e prevenir que os dados não sejam truncados.
      O Sistema proporcionaliza automaticamente todos os tamanhos das colunas, aproximando as informações conforme a quantidade de posições dos campos. Mesmo assim, pode ocorrer o truncamento dos títulos e dos dados da coluna caso não haja espaço suficiente.
      Também é possível realizar o ajuste individual de células, veja no tópico "Células".
    • Quebrar página antes
      Marque essa opção para imprimir cada seção em uma nova página.
    • Cor
      Pode-se definir cores em RBG para o fundo e para a fonte da seção. No primeiro botão, define-se a cor de fundo e no segundo botão, a cor da fonte.
      Para seleção, selecione a cor desejada do lado esquerdo da janela ou gira o triângulo na direção da cor desejada e arraste o ponto interno até o tom desejado. Ou digita-se as quantidades de Vermelho, Verde e Azul para compor a cor.
    • Borda
      É possível imprimir linhas para separar as informações das seções, utilizando o recurso de bordas. No primeiro botão, define-se a borda para a célula e no segundo botão, define-se a borda para o cabeçalho da célula.
      Para separação das seções, pode-se aplicar borda superior, inferior e laterais, basta clicar em cada lado.

3. Na parte inferior da janela, clique na pasta Relacionamento.


Relacionamento

Esta opção permite definir em quais tabelas o Sistema deve buscar as informações que constarão no relatório.

Exemplo:

SA1 - Cadastro de Clientes, SA2 - Cadastro de Fornecedores, SC2 - Ordens de Produção, etc.

Nesta pasta, é possível selecionar a tabela principal que será utilizada como base para apresentar as informações da seção, como também filtrar esses dados.

Criando um relacionamento

1. No campo Tabela informe o nome/alias da tabela principal.
   O sistema apresenta na janela as possibilidades de configuração do filtro de dados para impressão do relatório.

2. No campo Relacionamento com seção Anterior, clique em Adicionar Relacionamento para incluir ou alterar um relacionamento com a seção anterior. Quando se desejar que o relacionamento seja diferente do padrão do ambiente.

3. A partir das caixas de listagens de cortina Campos, Operadores e Expressão, pode-se compor o filtro para restringir as informações a serem consultadas.

Exemplo:

Para apresentar todos os produtos em que o código é diferente de 0001, deve-se definir a seguinte operação:

Campo

Operador

Expressão

Código

Diferente de

"0001"

4. Após a seleção dos elementos da operação, clique em Adicionar.
   Os elementos escolhidos são apresentados na área de Filtro.

5. Para informar mais de uma operação utilize os recursos de formação de operações lógicas:

Recursos

Descrição

( )

Utilizado para agrupar as operações, estabelecendo a ordem em que devem ser executadas.

e

O Sistema permite a informação de mais uma expressão para composição do filtro. Quando se utiliza o operador E, somente são exibidos os registros que atendam a duas ou mais condições especificadas.

ou

O Sistema permite a informação de mais uma expressão para composição do filtro. Quando se utiliza o operador OU, são exibidos os registros que atendem a qualquer uma das condições especificadas.

Exemplos:

Produtos que possuem Unidade igual a UN (Unidade) (igual a UN)

Assim o Sistema monta a expressão na área Expressão. Se ocorrerem erros nessa montagem, inicie novamente com o Limpa Filtro.

6. Clique em Expressão caso queira definir uma condição para consulta utilizando uma expressão em linguagem AdvPL.

Exemplo:

SUBSTR(B1_COD,3,3)="001"

O Sistema apresenta a tela para digitação da expressão.

7. Quando finalizada, clique em Adiciona para que a expressão seja transportada para a área de Filtro, ou Cancela para retornar à tela de geração de filtros.

8. Clique em Ok para encerrar o relacionamento.

9. Caso deseje incluir dados de outras tabelas na mesma seção, clique em Adicionar Relacionamento para definir o relacionamento entre as tabelas.

Após selecionar a tabela principal, o Sistema permite criar novos relacionamentos; ou seja, é possível combinar dados de vários arquivos no mesmo relatório, como por exemplo, uma relação de produtos e seus tipos de entradas e saídas (TES).

Para estabelecer uma relação, é necessário que os arquivos possuam pelo menos um campo em comum. No exemplo anterior, o arquivo de Produtos (SB1), possui o campo B1_TE, onde é gravado o código do tipo de entrada do produto; já o arquivo Tipos de Entradas e Saídas (SF4), possui o campo F4_CODIGO, onde é gravado o código do Tipo de Entrada e Saída para sua identificação.

10. Se desejar excluir um relacionamento, clique em Excluir Relacionamento.

11. Clique na pasta Células.


Adicionar Relacionamento

  1. A janela Adicionar Relacionamento é apresentada. Torna-se necessário selecionar o relacionamento criado.
  2. No campo Pesquisar Tabela, digite o nome da tabela relacionada.
    Observe que a informação de Expressão Tabela Relacionada foi alterada com o nome do campo escolhido da tabela secundária e comum à tabela principal.
  3. Clique, então, em Criar para confirmar o relacionamento.
    É apresentada a janela para escolher a tabela e montar as expressões do relacionamento.
  4. Clique em Consultar Campos, apresentado ao lado do campo Expressão Tabela Principal, para selecionar um ou mais campos da tabela principal que serão utilizados para o relacionamento.
    É apresentada a janela Consultar Campo com a relação dos campos da tabela principal.
  5. Clique sobre o campo chave para o relacionamento e, em seguida, clique em Ok.
    Observe que o campo selecionado foi apresentado no campo Expressão Tabela Principal.
    Em alguns casos, é necessário criar relacionamentos com mais de um campo para que a informação esteja realmente individualizada ou separada.
    Exemplo:
    Tratando-se de um relatório com a tabela principal baseada no Cadastro de Clientes, pode ser interessante criar o relacionamento com os campos Código do Cliente e Loja (A1_COD+A1_LOJA), isto garante que o relatório apresente os dados separados para cada loja do cliente.
  6. Para adicionar um campo à chave de relacionamento da tabela principal, clique novamente no botão apresentado ao lado do campo Expressão Tabela Principal.
    É reapresentada a janela Consultar Campo com a relação dos campos da tabela principal.
  7. Clique sobre o outro campo chave para compor o relacionamento e, em seguida, clique em OK.
    Observe no campo Expressão Tabela Principal foi incluído o sinal de + e o campo selecionado.
  8. Caso seja necessário adicionar mais campos para separar as informações, repita estes procedimentos até incluir todos os campos necessários para composição da chave de relacionamento.
  9. Após definir todos os campos chaves da tabela principal, deve-se selecionar a tabela secundária. Para tanto, no campo Pesquisa Tabela, digite o nome da tabela que será relacionada.
  10. Em seguida, clique no botão apresentado ao lado do campo Expressão Tabela Relacionada.
    É apresentada a janela Consultar Campo com a relação dos campos da tabela relacionada.
  11. Clique sobre o campo e, em seguida, em Ok.
  12. Da mesma forma que na tabela principal, repita esta operação para adicionar todos os campos que devem compor a chave de relacionamento.
  13. Para finalizar o relacionamento entre estas tabelas, clique em Finalizar.
    A janela Adicionar Relacionamento é reapresentado.
  14. Clique em Confirmar.
    O Sistema retornará à janela de Relacionamento.

Células

Cada seção apresenta um conjunto de células.

As células são as colunas dos campos apresentados pelas seções do relatório. Para adicionar ou inibir colunas, e definir seus atributos, basta clicar sobre a barra Célula apresentada na parte inferior da janela.

No lado esquerdo, são relacionados os campos das tabelas de dados utilizadas no relatório.

No lado direito Células são relacionados os campos selecionados para apresentação na seção em definição.

Configurando as células:

1. Na área à esquerda, clique no botão apresentado ao lado do nome da tabela que terá seus campos escolhidos.
    São listados os campos da tabela.

2. Clique sobre o nome do campo que deve ser apresentado no relatório e, em seguida, em Adicionar.
    O nome do campo é adicionado na área à direita.

3. Para adicionar todos os campos em uma única operação, clique em Adicionar Todos.
    O Sistema adiciona todos os campos da tabela na área à direita.

4. Se necessário remover algum campo da lista, utilize os recursos Remover e Remover Todos para remover um ou todos os campos, respectivamente.
5. Observe no lado direito da janela a definição da propriedade da célula.


    • Título:
      É sugerido o título do campo, mas, pode ser alterado.
    • Tamanho:
      Quantidade de posição reservadas para exibição dos dados da célula. É sugerido o tamanho do campo.
    • Máscara:
      Formato para apresentação dos dados em sintaxe AdvPL. É sugerida a máscara padrão do campo.
    • Alinhamento e Alinhamento de Título
      Alinhamento dos dados das células e do título. Com o alinhamento automático, o Sistema analisa o tipo de campo e alinha à esquerda se caractere, memo, data ou lógico e à direita se numérico, desde que esteja configurado no Dicionário de Dados.
    • Totalizar seção
      Define o tipo do acumulador criado (não totaliza, contador, último valor, totalizar, valor médio, valor mínimo e valor máximo) para a célula que será impressa na quebra de uma seção ou do agrupamento.
    • Auto ajustar
      Da mesma forma que o ajuste da seção, é possível definir individualmente o ajuste automático da largura da célula.
    • Quebra linha (para texto longo)
      Se o campo for do tipo caracter ou memo, será efetuada a quebra automática de linha para exibição de todo o texto.
    • Considerar o tamanho do cabeçalho
      Caso o tamanho do dado a ser impresso for menor que o cabeçalho, será considerado o tamanho do cabeçalho. Se essa caixa não for habilitada, até mesmo o título da célula poderá ser cortado para que seja possível ajustar a visualização dos dados.
    • Considerar no agrupamento
      Esta célula compõe o grupo de quebra. Esta configuração permite apresentar de forma agrupada os registros com informações comuns, facilitando a análise, organização do relatório.
      Por exemplo:
      um relatório de solicitações de compras agrupadas por fornecedores. Nesse caso, também é importante que a ordem do relatório esteja definida por fornecedores.
    • Cor e Borda
      Da mesma forma que a configuração da seção, pode-se especificar bordas, cor de fundo e fonte especificamente para uma célula.
    • Condicional
      Permite criar, editar e excluir condições para impressão dos dados com cores diferenciadas.
      Exemplo:
      Saldo atual do produto > 0 (Cor de fundo branco e cor da fonte preta)
      Saldo atual do produto <= 0 (Cor de fundo branco e cor da fonte vermelha)

Definindo Fórmula/Expressão:

A criação de fórmulas permite realizar cálculos com as células selecionadas para o relatório. É possível criar estruturas complexas de fórmulas, utilizando comandos AdvPL.

A elaboração de fórmulas devem ser realizada de forma criteriosa, pois, pode comprometer a performance do processamento do relatório, Para cada linha impressa da célula, o Sistema precisa calcular a fórmula novamente.

  1. Clique em Fórmula e, em seguida, em Adicionar.
    É apresentada a janela a seguir, onde no lado direito da janela, são relacionadas as células do relatório.
  2. Clique em Ok para confirmar.
    O Sistema retorna à janela Células.
  3. Para editar, selecione uma fórmula e clique em Editar.

Definindo os Acumuladores:

Os acumuladores permitem criar células com total, média, mínimo e máximo baseado em outras células numéricas e também criar células de contagem de ocorrências baseado em qualquer dado.

1. Clique em Acumulador e, sem seguida, em Adicionar.

A partir de um acumulador também são criados gráficos para apresentação ao final do relatório.

É apresentada a janela Acumulador dividida em 3 áreas:

Acumulador


    • Título
      Define o tipo de acumulador que será criado: se totalizador, valor mínimo, máximo, média ou contador de ocorrências.
    • Agrupar por
      Os acumuladores são criados baseados em uma célula agrupadora, por exemplo: para criar um acumulador que totalize as comissões faturadas pela venda de cada cliente, é necessário que os valores estejam agrupados por cliente.
      Nessa caso, basta dar um duplo clique sobre o nome da célula Cliente, na relação de células à direita, para incluí-la no campo Agrupar por. É possível agrupar o acumulador por mais de uma célula.
    • Fórmula
      É dado que será acumulado. Por exemplo: Comissão.
      Nesse caso, basta dar um duplo clique sobre o nome da célula Comissão, na relação de células à direita, para incluí-la no campo Fórmula.
      Pode-se utilizar expressões em AdvPL para composição do acumulador.
    • Imprimir no final do relatório
      Os acumuladores podem ser impressos separadamente ao final do relatório como uma estatística dos dados apresentados.

Gráfico

A partir do acumulador pode-se criar diferentes tipos de gráficos (barra, linha, pizza etc). Os gráficos são gravados em arquivo .BMP, com o mesmo nome do arquivo do relatório.

Se existirem vários acumuladores com gráficos, os arquivos .BMP serão gravados em seqüência (matr1501.bmp, matr1502.bmp, etc) no diretório de spool. Se excluído o arquivo .BMP, o gráfico deixará de ser exibido.


    • Nome
      Define um nome para o gráfico.
    • Nome da série
      Define o nome para a série do gráfico.
    • Imprimir no final do relatório
      O gráfico será apresentado ao final do relatório.

Célula


    • Título
      Define um título para a célula.
    • Tamanho
      Define o tamanho da célula para a séria do gráfico.
    • Máscara
      Define o formato do dado que será impresso.
    • Imprimir

Updated on 30/04/2021

Was this article helpful?
We appreciate your review.