HEFLO oferece a capacidade de gerar relatórios e exibi-los em uma página do espaço de trabalho através de widgets, ou de enviá-los durante a execução de um processo.
Neste artigo, mostraremos como acessar o “Editor de Relatórios” e criar um relatório contendo informações dos itens de trabalho de um processo específico, assim como adicionar este relatório em anexo a um modelo de e-mail.
Usaremos o seguinte processo para demonstrar tais recursos.
E usaremos esses campos para preencher o cadastro do produto.
O objetivo é adicionar um produto ao cadastro de produtos deste ambiente, e uma vez registrado, enviar um e-mail com um documento em anexo contendo as informações do produto.
Apresenta-se a seguir os diferentes passos para criar o documento e enviá-lo como anexo.
Habilitar a replicação de banco de dados em seu ambiente
Para recuperar informações sobre um item de trabalho de um processo, precisamos criar uma consulta no “Editor de Processos” utilizando as informações do banco de dados associado a esse ambiente.
Caso já tenha ativado esse recurso nesse ambiente, você pode ignorar essa etapa.
Para ativar a replicação de banco de dados em seu ambiente, siga as etapas abaixo:
- Vá para o “Editor de Processos”.
- Clique no ícone de “Modo de Visualização”.
- Selecione a opção “Exportação de dados”.
- Clique em “Ativar este recurso”.
- Aguarde a conclusão da replicação do banco de dados.
Assim que a replicação do banco de dados for concluída, você poderá acessar a estrutura do banco de dados, além de visualizar seus dados e exportá-los. Para saber mais: Tutorial: Exportação de dados.
Criar um relatório
Para acessar o “Editor de Relatórios” e criar um novo relatório, deve-se seguir as seguintes etapas:
- Vá para o “Editor de Processos”.
- Clique no ícone “Modo de Visualização”.
- Selecione a opção “Relatórios”.
- Clique no botão “+”.
- Dê um nome ao seu relatório e clique no botão “Abrir editor de relatório”.
Você será redirecionado para o “Editor de Relatórios”.
No editor podemos usar os diferentes elementos localizados à esquerda para adicionar e/ou formatar dados fixos do relatório. Para isso, deve-se arrastar e soltar esses elementos na área de edição do relatório, localizada na parte central.
Atenção: A área de edição é subdividida em três partes: a margem superior, a parte central do relatório e a margem inferior. Podemos aumentar ou diminuir o tamanho dessas diferentes partes, além de adicionar novas seções caso necessário.
Em nosso exemplo, adicionaremos a este relatório apenas um título e uma tabela contendo as informações do item de trabalho.
Vincular as informações do processo ao relatório
Para recuperar dados de um processo específico, devemos vincular o relatório a uma visualização do processo, schema, do banco de dados de seu ambiente.
Para saber mais sobre as diferentes visualizações do banco de dados e como acessá-las: Tutorial: Exportação de dados.
Obter o nome da visualização do processo
Antes de tudo, precisamos identificar a visualização do processo em questão. Para isso,
- Abra o processo no “Editor de Processos”.
- Na aba “Ações”, localize a guia “Exportação de dados” e clique no botão “Visualizar Schema”.
- Pesquise o processo desejado.
Observação: Você também pode acessar esta tela através da função “Exportação de dados”, conforme visto anteriormente. Para saber mais sobre exportação de dados: Tutorial: Exportação de dados. - Na aba “Schema”, temos acesso a dois tipos de visualizações. Para informações relacionadas aos itens de trabalho, copie o nome da visualização terminada em “wi”. Já para informações das sub-tokens do processo, por exemplo, sub-tokens criadas por uma conexão paralela, copie o nome da visualização terminada em “tk”.Note que ao clicar no ícone “+”, temos acesso às diversas propriedades de cada visualização.Observação: Podemos também criar consultas personalizadas para recuperar campos e/ou propriedades específicas do processo, além de poder usar esse tipo de consulta para acessar vários processos simultaneamente.
- Retorne ao “Editor de Processos” e clique em “Compilar View” para atualizar o banco de dados.
Podemos agora retornar ao “Editor de Relatórios” e abrir o relatório criado anteriormente.
Criar uma consulta para obter os dados da visualização do processo
Uma vez identificada a visualização do processo, podemos criar uma consulta para vincular o relatório às informações do item de trabalho, para isso devemos realizar a seguinte configuração:
- Clique no ícone do banco de dados, localizado à direita do editor.
- Clique no ícone , e selecione a opção “Replica Database”. Isso permite que o “Editor de Relatórios” possa acessar as informações de replicação do banco de dados de seu ambiente.
- Selecione a entrada “Replica_database1” e, em seguida, clique no ícone para gerar uma nova consulta ao banco de dados.
- Dê um nome à consulta.
- Insira a query na seção “Cadeia de Caracteres SQL” para acessar as informações da visualização do processo. A query deve ser do tipo “SELECT”, conforme mostrado a seguir:
SELECT * FROM “Nome_Visualização_Processo”Note que devemos substituir “Nome_Visualização_Processo” pelo nome da visualização anteriormente copiada.Observação: Caso o nome de seu processo contenha caracteres especiais, deve-se colocar o nome da visualização do processo entre “, por exemplo, `nome da visualização do processo`. - Clique em “Concluir”. Veja que um ícone de seta aparece à esquerda de “Replica_database1”.
- Clique no ícone para expandir as informações e, em seguida, selecione o ícone de seta à esquerda da sua consulta. Uma lista contendo os atributos e colunas da visualização do processo será exibida.
Para uma melhor experiência do usuário, sugerimos que você use o modo escuro.
Inserir as propriedades da visualização ao relatório
Podemos agora inserir as informações correspondentes a campos e/ou propriedades do processo em nosso relatório. Para isso:
- Selecione a propriedade desejada.
- Arraste-a para a posição onde se deseja exibir a informação no relatório. Note que para se exibir todas as informações referentes aos itens de trabalho do processo, será necessário colocar esta propriedade na parte central do relatório. Propriedades colocadas na margem superior ou inferior exibirão somente informações relacionadas a um único item de trabalho.Observação: Podemos selecionar diversas propriedades ao mesmo tempo mantendo pressionada a tecla “ctrl” e, em seguida, arrastando-as para a área de edição do relatório.
- Formate o tamanho e a posição dessas informações.
- Se necessário, altere o formato de exibição associado à propriedade.
- Selecione a propriedade desejada.
- Clique no ícone de engrenagem.
- Clique no ícone localizado no campo “Text Format String”.
- Atualize o formato associado a esta propriedade.
- Desselecione o item do relatório e clique no ícone de engrenagem.
- No campo “Propriedades” selecione “XtraReport(Relatório)”.
- Escolha a consulta que você criou no campo “Membro de Dados”.
Vincular as propriedades a um item de trabalho
Após configurarmos nosso relatório para exibir informações de campos e propriedades do processo, precisamos restringir seu escopo a um item de trabalho, visto que buscamos exibir somente as informações relacionadas ao item de trabalho executado. Para isso deve-se seguir as seguintes etapas de configuração:
- Clique no ícone do banco de dados.
- Clique em “Parâmetros” e selecione o botão “+”.
- Dê um nome e forneça uma breve descrição a este parâmetro, nesse exemplo usamos “pnumber” para identificar o número do processo..
- Defina o tipo do parâmetro como “Número (inteiro de 16 bits)”.
- Clique em “OK” para validar a criação deste parâmetro.
- Clique no ícone à esquerda da “Replica_database1” para expandir as informações.
- Selecione sua consulta e, em seguida, clique no ícone.
- Atualize a query na seção “Cadeia de Caracteres SQL” com base na configuração abaixo:
SELECT * FROM “Nome_Visualização_Processo” WHERE number =? “Nome_Parametro”
Observe que devemos substituir a entrada “Nome_Parametro” com o nome definido no passo 3. - Clique em “Avançar”.
- No “Assistente de fonte de dados”, selecione “Adicionar” e depois clique na seta à esquerda do nome do parâmetro.
- No campo “Nome”, devemos inserir o nome do parâmetro definido na consulta SQL, isto é, “pnumber”. O objetivo é manter o mesmo nome do parâmetro utilizado.
- No campo “Tipo”, escolha “Expressão”.
- No campo “Valor”, clique neste ícone.
- Na nova aba, clique na seta à esquerda de “Parâmetros” e, a seguir, selecione o parâmetro utilizado, nesse caso, “pnumber”.
- Na parte de edição da expressão coloque “?“Nome_Parametro””. No nosso caso, colocamos: “?pnumber”.
- Clique em “OK” e depois em “Concluir”.
- Selecione “Prever”.
Podemos validar o processo, inserindo o número de um item de trabalho do processo no campo correspondente ao parâmetro criado. Certifique-se de escolher um item de trabalho que corresponda ao processo definido em sua consulta.O editor de relatórios exibirá o relatório configurado para os dados do item de trabalho correspondente. - Clique no botão “Design” para retornar à tela de edição.
- Salve seu relatório e saia do “Editor de Relatórios”, retornando ao “Editor de Processos”.
Anexar um relatório a um modelo de email
Agora só precisamos anexar este relatório a um modelo de email. Para tal:
- Vá para o “Editor de Processos”.
- Clique no ícone “Modo de Visualização”.
- Selecione “Modelos Mensagens”.
- Escolha o modelo de email desejado ou crie um novo através do ícone “+”.
- Clique no botão “Anexos” localizado na parte inferior da caixa de diálogo.
- Na seção “Modelos”, clique no botão “+” para inserir um novo anexo.
- Selecione a opção “Relatórios”.
- Defina o nome do anexo.
- Selecione o relatório desejado.
- Relacione o parâmetro criado em seu relatório com o número do item de trabalho. Para isso :
- Clique no ícone de duas setas.
- Adicione “:” e selecione a propriedade “Número”.
- Clique em “Confirmar” para validar a adição do relatório como anexo.
Observação: Caso queira atualizar um relatório que já tenha sido anexado mas cujo parâmetro não tenha sido configurado no modelo de mensagem, deve-se clicar em “Buscar Parâmetros”.
- Finalmente, clique em “Confirmar” para validar o modelo de e-mail. Para saber mais sobre como configurar um modelo de e-mail: Como criar modelos de e-mail e anexos.
Ao executar um novo item de trabalho, os valores preenchidos no mesmo serão automaticamente enviados ao relatório e serão exibidos no documento PDF enviado em anexo pelo e-mail.
Observação: Itens de trabalho de testes não geram dados e portanto enviam relatórios vazios.
Atenção: Podemos utilizar somente relatórios que foram editados através do “Editor de relatórios”. Relatórios criados sem edição, ficam disponíveis na lista de relatórios, porém não podem ser selecionados.
Você também pode verificar este artigo: Criar um relatório com informações de uma gravação e envie por email.