GE - Como Fazer - CIGAM Report

CIGAM Report

  Uma ferramenta originária do Fast Report, que adquirido o código fonte, foi adaptado as necessidade do ERP CIGAM em criação de relatórios customizados. Extraíndo do CIGAM as informações necessárias através da utilização de comandos SQL’S. A ferramenta pode ser utilizada por clientes que usam o banco de dados Oracle ou MS-SQL, e a versão do CIGAM e10.

  O documento irá descrever/apresentar como parametrizar as plataformas Windows 32 e 64 bits, para o correto funcionamento do CIGAM Report. Descreve como integrar os relátorios criados ao sistema CIGAM. E de forma básica descreve a criação dos relatórios, mas verifique o Arquivo:Como Fazer - CIGAM Report Avançado.pdf para informações mais detalhadas.

O que parametrizar no ambiente Windows, quanto ao CIGAM Report?

  Para se certificar quais instalações serão precisas a primeira coisa a fazer é se certificar que o executável do CIGAM Report está abrindo corretamente sem apresentar erros.

  Para executa-lo acesse o %CIGAM_INSTAL%CGReport.exe. Em caso de erros avaliar a instalação do .Net framework e suas permissões, dúvidas sobre a instalação verificar o documento ‘COMO FAZER - Instalação do .Net nos clientes’.

Quais os fundamentos do CIGAM Report?

  O CIGAM REPORT, e um gerador de relatórios direto a banco sem a necessidade de programação e ou desenvolvimento de novos programas no CIGAM via Magic. Suas principais funcionalidades são:

• Possibilitar a criação de relatórios sem que seja necessário passar pelo desenvolvimento do CIGAM;
  
• Todo o desenvolvimento bem como a implantação será feita no cliente de maneira rápida e simples, e;
  
• Pode se definir o modelo do relatório diretamente sem que seja necessário disponibilizar variáveis para uma futura implementação ou adição de informações.
  

  Informações detalhadas sobre as funcionalidades do Cigam Report, relevantes para a criação de relatorios verificar o Arquivo:Como Fazer - CIGAM Report Avançado.pdf

Como criar o relatório de consulta direta a banco via CIGAM Report?

  Ao abrir o CIGAM Report pela primeira vez, caso o idioma esteja em inglês ou outro qualquer que não o português, você pode alterá-lo fazendo o seguinte procedimento:
  Clicar em File – Select Language conforme a imagem abaixo:

  Na janela que irá abrir, clique em portuguese-brasil e em seguida em OK.

  Ao abrir o Cigam Report devemos selecionar a opção: Arquivo – Novo, irá aparecer a seguinte tela abaixo.

  A opção relatório em branco deve ser selecionada e clique em adicionar. Com isso será aberto um formulário de relatório padrão conforme imagem abaixo.

  Agora é necessário informar qual será a fonte de dados do relatório. Isto pode ser feito de duas maneiras:

• Escolher uma das fontes de dados que foram registradas no relatório através de um método de programação. Isto pode ser feito no menu Dados > Escolher Dados do Relatório, e marcando as fontes de dados necessárias.
  
• Uma nova fonte de dados pode ser criada no menu Dados > Adicionar Fonte de Dados.
  

  Após a inclusão da fonte de dados, esta irá aparecer na janela Dados. Agora a mesma pode ser utilizada no relatório. Não é obrigatório que o relatório se conecte somente a uma fonte de dados, permitindo que mais destas sejam adicionadas em um mesmo relatório.
  No exemplo para demonstração será a opção Dados – Adicionar Fonte de Dados, conforme apresenta a imagem a seguir.

  A primeira vez que for conectar com o Banco de Dados será necessário criar uma Nova Ligação.

  O tipo de ligação deve ficar como Ligação OLE DB. Depois de alterar clicar em Gerar.

  Ao clicar em gerar, aparecerá a tela abaixo, onde temos algumas informações importantes a serem observadas.

  Nessa tela teve se escolha o provedor de acordo com o banco de dados. Para o banco de dados Oracle pode se utilizar o MICROSOFT OLE DB PROVIDER FOR ORACLE ou o recomendado ORACLE PROVIDER FOR OLE DB.
  Para o banco de dados SQL Server se utiliza o MICROSOFT OLE PROVIDER FOR SQL SERVER. Após escolher o provedor de dados correto clique em gerar.

  Os campos com o nome do servidor, nome de usuário e senha devem ser informados e a opção de permitir salvamento de senha marcada, para não precisar informar a mesma senha todas as vezes que for executar o relatório. Após informar os campos clique em Testar a Conexão.

  Se o teste de conexão for concluído com êxito, clique em OK para continuar a configuração. Caso não tenha tido sucesso no teste de conexão, confira os dados de servidor, usuário e senha e tente novamente.
  Problemas de não encontrar o provider do Oracle padrão, revise o capítulo 1 do presente manual para que possas seguir com o padrão solicitado.
 Na tela de assistente de dados conforme imagem abaixo clique no botão seguinte.

Como acessar uma Tabela no CIGAM Report?

  Na próxima tela, há duas opções, onde se pode escolher uma tabela do banco de dados para buscar depois os campos desejados, ou podemos escolher inserir uma consulta em SQL diretamente através do botão Adicionar consulta SQL.

  Nesse exemplo, será escolhida a opção de selecionar uma tabela inteira, no caso, a tabela de cadastro de empresas. Após selecionada a tabela, é só clicar no botão terminar. Ao fazer isso, o programa voltará para a tela inicial, mas no canto superior direito aparecerá a nova fonte de dados. Nesse caso aparece a tabela de cadastro de empresas, GEEMPRES, e abaixo dela todos os seus campos, conforme figura abaixo.

  Clicando nos campos da tabela GEEMPRES que aparecem a direita e arrastando podemos colocá-los no layout do relatório. Os campos devem ser colocados na parte de dados do relatório, conforme exemplo abaixo.

  Ao soltar os campos nos dados, o Cigam Report insere automaticamente o nome do campo no cabeçalho de página. Esse nome é o próprio nome do campo na tabela. Ele pode ser alterado de acordo com a necessidade do relatório. Existem duas formas de se fazer isso:
  Dando um duplo clique em cima do mesmo. Assim abrirá uma janela de editar texto onde basta alterar o texto.
  Pode-se também alterar o TEXT de dados que aparece ao lado direito da tela, conforme a figura abaixo.

  Após de alterado pode se ver um preview de como ficará o relatório. Para isso basta clicar no botão de visualizar que aparece no canto superior esquerdo da tela conforme a figura abaixo.

  Ao clicar na opção, a consulta será gerada na base de dados e retornará a tela conforme a figura a seguir, mostrando como os dados estão formatados para apresentação.

  Para fechar a visualização do preview basta clicar em fechar. Com isso volta a tela inicial de configuração do layout do relatório.

Como acessar Múltiplas Tabelas do CIGAM Report?

  Para fazer uma consulta no Cigam Report utilizando um relacionamento entre 2 ou mais tabelas deve ser feito seguindo os seguintes passos:
  Selecionar um novo relatório em branco, e clicar em adicionar fonte de dados.

  Na tela que aparece é onde deve ser configurada a conexão com o banco de dados, conforme demonstrado na seção anterior do presente documento, tendo o banco já configurado, basta clicar no botão seguinte, como apresenta a imagem abaixo.

  Nesse exemplo, será selecionado duas tabelas relacionadas. A ESMATERI que tem o Cadastro de Materiais e a PEENGENH que é a da Engenharia. Na tela que abre, selecione as duas tabelas e clique em terminar.

  Nas fontes de dados a direita da tela será apresentada as duas tabelas selecionadas.

  Agora é necessário criar o relacionamento entre as duas tabelas. Para isso deve-se clicar em: Ações / Nova Relação

  Na tela que se abre deverá ser informado a tabela mãe e a tabela filha, e por qual campo elas se relacionam, conforme a imagem abaixo exemplifica.

  Após de realizar o relacionamento clicar em OK. Agora a direita na fonte de dados já aparecem as duas tabelas e com o relacionamento entre elas. No exemplo abaixo está se buscando o código do material da tabela da Engenharia e a descrição do cadastro de materiais.

  Ao gerar o relatório é possível ver a informação de código de material e descrição.

Como acessar múltiplas tabelas via comandos SQL?

  Além de fazer a consulta relacionando tabelas da forma como descrito na seção anterior, também é possível acessar múltiplas tabelas através de uma instrução SQL (script).Com a instrução SQL é possível adicionar somente os campos que temos interesse e já fazer a relação entre tabelas diretamente nele.
  Para criar uma fonte de dados baseado em uma instrução SQL é preciso clicar em Dados / Adicionar Fonte de Dados, como a configuração com o banco de dados já deve estar pronta, basta clicar no botão seguinte na tela que a figura abaixo ilustra.

  O Cigam Report vai carregar as tabelas, mas em vez de selecioná-las na lista, cliquei no botão Adicionar Consulta Sql.

  Será aberta a janela onde podemos dar um nome para essa instrução, ou simplesmente deixar o nome sugerido e clique em Seguinte.

  Na tela seguinte conforme imagem abaixo se coloca a instrução SQL desenvolvida e basta clicar no botão seguinte.

  Por hora, vamos passar direto pela próxima tela, que é a de parâmetros e apenas clique no botão seguinte.

  Na tela seguinte clique no botão terminar, depois se retornará a essa tela para inclusão dos parâmetros.

  No final da tela de tabelas irá aparecer o nome da consulta criada via SQL conforme imagem abaixo e bastar clicar no botão terminar.

  A partir de então, a instrução SQL que foi utilizada já aparece como uma conexão a base de dados. Os campos poderão ser inseridos no relatório como os da tabela.

  Os campos podem ser inseridos na tela do relatório conforme imagem abaixo.

  Outras informações comuns em relatórios como pagina, data, podem ser inseridas. Essas são demonstradas na figura abaixo.

  Na banda de título de relatório (1) se pode inserir algumas variáveis de sistema (2) que estão disponíveis ao lado direito da tela, logo abaixo da fonte de dados. Nesse exemplo será inserida a data e o número de página. O processo para inserir as variáveis é o mesmo que com os campos da tabela. Basta clicar em cima da variável e arrastá-la para o local desejado e soltá-la.

  Ao clicar no opção de preview do layout, já será visto o relatório com as variáveis adicionadas nele.

  Também é possível inserir uma figura com o logo da empresa para ser o cabeçalho do relatório como mostrado a figura abaixo.

  Para incluir deve se clicar no botão figura e arraste a imagem para o local digitado. Após isso, clique com o botão direito sobre a imagem e escolha a opção editar.

  Ao selecionar a opção irá abrir a tela abaixo. Se escolher a opção Imagem / Abrir.

  Após seleciona uma imagem de uma pasta qualquer dentro do computador.

  Após selecionar a imagem, basta clicar em abrir que será apresentada para o layout do relatório. Quando a imagem já estiver no layout, basta ajustá-la com o tamanho desejado.

  Com isso, ao gerar novamente o preview do relatório, a imagem será apresentada em tela.

  Essas são as formas de criar o relatório pelo CIGAM Report, para realizar a integração do mesmo ao Cigam, será preciso criar os parâmetros/filtros e ajustá-los a consulta, no qual o capítulo seguinte irá apresentar.

Integração do relatório CIGAM Report ao Cigam

  Com o modelo criado pelo CIGAM Report, para ser utilizado como opção de Menu no Cigam deverá seguir algumas configurações que seguem abaixo.

Como utilizar e criar parâmetros, através do CIGAM Report?

  Para demonstrar a inserção dos parâmetros será utilizado o exemplo do relatório que lista o nome das empresas. No Cigam Report ele está montado da seguinte maneira.

  O relatório gerado se apresenta conforme a imagem abaixo

  Para a integração será criada uma tela de filtros para esse relatório dentro do Cigam, o filtro será pelo código da empresa. Para isso será necessário criar um parâmetro que receberá o valor digitado na tela e repassará o valor do mesmo para o Cigam Report. Para fazer isso, deve-se clicar em Parâmetros de Filtros no menu Cigam

  Ao acessar no menu do Cigam a opção Parâmetros de Filtros, com o ambiente corretamente configurado irá apresentar alguns parâmetros para serem utilizados, porem não impede que seja criado novos de acordo com a necessidade. Para cadastrar um novo filtro devemos pressionar CTRL + I.

  No campo do código se insere o código requerido, ou se permanece com a sugestão do sistema. No campo Nome do Parâmetro se coloca um nome que se deseja para o mesmo. Em Tabela, pressione F5 para abrir a lista de tabelas.

  No exemplo criado será utilizado tabela EMPRESA. No campo coluna será selecionado o campo da tabela EMPRESA, onde fica o código do cliente que servirá como filtro.

  Em tamanho do controle se informa o tamanho do campo na tela para receber os dados que serão digitados nesse parâmetro. Como o campo de empresa tem 8 dígitos, vamos informar o mesmo valor. Em Nome do Parâmetro para Integração vamos informar o nome do parâmetro que será usado dentro de nossa consulta SQL. É bom sempre usar um nome intuitivo para facilitar o entendimento. Nesse caso se usará o parâmetro como P_Empresa.

  Os detalhes do parâmetro que aparecem na parte de baixo da tela são preenchidos automaticamente pelo Cigam, e com todos os campos informados, basta salvar o novo parâmetro.
  Como apresentado no inicio da apostila a opção de cadastro de tabelas oriundas de customizações, módulos terceiros ou parceiros desenvolvedores, após devidamente cadastrada a mesma já está visível para realizar o cadastro de parâmetros. Segue o mesmo processo como descrito anteriormente, como a ilustração a seguir apresenta:

  IMPORTANTE: O parâmetro cadastrado aqui pode ser usado inúmeras vezes, para diversos relatórios posteriormente. Não é necessário mais cadastrar o mesmo parâmetro para outro relatório. Apenas fazer a sua associação ao novo relatório, como será apresentado a seguir.

Como apontar o modelo criado, trazendo todos os relatórios do CIGAM Report?

  O próximo passo é fazer um cadastro desse relatório dentro do Cigam. Para isso é preciso entrar na tela de Cadastro de Relatórios conforme a imagem abaixo.

  A tela de cadastro abrirá mostrando todos os relatórios do Cigam Report que já foram cadastrados, pressione CTRL + I para inserir um novo relatório.
  O Código deve ser preenchido com o número desejado. No exemplo utilizado já existia o número 1, por isso o relatório terá o código 2. No nome do relatório devemos colocar o nome que irá aparecer quando o relatório for aberto. A dica é sempre usar um nome intuitivo, que seja de rápida assimilação do conteúdo do mesmo.

  Após preencher o nome do relatório, devemos definir os tamanhos da tela onde os filtros serão solicitados, e a área onde será exibida a descrição dos filtros. Isso é feito nos campos Tamanho do Controle e Tamanho do Label conforme imagem abaixo.

  Arquivo Modelo: É onde está salvo o arquivo FRX que montamos no Cigam Report.
  Será esse arquivo modelo que o Cigam irá procurar para gerar o relatório. Ele deve estar salvo em um local da rede que todos usuários que vão usar o relatório tenham acesso.
  Arquivo Gerar: É o arquivo que será gerado pelo Cigam Report, com os dados da consulta. Costuma-se usar o mesmo que o do relatório, acrescentando apenas ao fim do mesmo a palavra “Gerado” conforme imagem abaixo.

  IMPORTANTE: Para que o relatório a gerar possa ser aberto sem problemas, é preciso avaliar se os usuários possuem permissões de modificar o arquivo no caminho onde ele é gerado. Para alguns casos é preciso dar permissões de modificações na rede, caso contrário, o CIGAM Report poderá apresentar erro em tela

Como indicar filtros para o modelo indicado?

  Após informar o nome do relatório será informado os filtros dele. Clique no botão Filtros conforme mostra a figura abaixo.

  Ao entrar na tela de filtros, pressione CTRL + I para inserir um novo filtro. Com o cursor parado em cima do campo Parâmetro Filtro, pressione F5 para abrir as opções de filtros já cadastrados anteriormente, no cadastro de parâmetros.

  Posicione o cursor sobre o parâmetro Empresa já cadastrado e pressione <ENTER>.

  De volta a tela de cadastro de filtros tem as seguintes opções:
  Ordem Exibição – Mostra a posição do parâmetro na tela. No caso de existirem 2 ou mais filtros, a partir da ordem de exibição se escolhe a ordem que eles aparecerão na tela.
  Faixa - Indica que o filtro será com início e fim (intervalo). Nesse caso o nome do parâmetro de integração será duplo sendo composto da seguinte forma como exemplo: p_empresa_inicial e p_empresa_final.
  Obrigatório – Serve para tornar obrigatório ou não o preenchimento desse campo na tela de parâmetros. Caso esteja marcado, não permitirá gerar o relatório sem informar algum valor no campo.
  Intervalo - Indica se deve disponibilizar o intervalo final no filtro. Caso estiver selecionado “Faixa” e não estiver selecionado o Intervalo, será submetido o dado inicial e final porém somente o inicial é solicitado. Essa opção é útil quando se deseja filtrar um valor específico único (sem faixa) podendo-se também deixar em branco para abranger todos os registros (atual comportamento dos programas de filtros de relatórios).
  Aleatório – utilizado para informar de forma aleatória os dados a serem filtrados. * Vale ressaltar que este tipo de parâmetro será utilizado na query do Report com o uso do comando “in”. Ex.: Select * from geempres e where e.cd_empresa in (@p_aleatorio).
  Agora é importante notar que de acordo com o que se seleciona como Faixa e Intervalo, muda o nome do parâmetro de integração que fica visível no final da tela conforme imagem abaixo.

  O parâmetro criado é o p_empresa. Como escolhido um intervalo, o Cigam já cria o parâmetro inicial e o final. O nome nesse caso ficará como p_empresa_inicial e p_empresa_final. É muito importante observar isso. Porque esses parâmetros serão informados dentro do Cigam Report, e informados na consulta SQL que foi montada.
  IMPORTANTE: Ter atenção de como os filtros são criados é extremamente importante, pois o CIGAM Report é Case Sensitive. O parâmetro informado na consulta não estando da mesma maneira que o apresentado na tela de filtros, fará com que o relatório não seja aberto, irá apresentar uma tela que está acessando os dados, porém não abrirá nada em tela.

Como indicar os parâmetros do CIGAM Report na consulta SQL?

  Para que os parâmetros sejam apontados na consulta, é preciso que o modelo seja aberto no Cigam Report, clique na fonte de dados com o botão direito e escolha a opção editar.

  Na tela que abrir clique no botão seguinte.

  Na tela seguinte irá aparecer com a consulta SQL, e nessa será incluída os parâmetros.

  Agora será necessário alterar essa consulta SQL, inserindo nela os filtros que serão utilizados na tela do Cigam, para gerar o relatório.

  Os filtros são cláusulas de restrição. Então é necessário inserir um WHERE na nossa consulta SQL. Como se escolheu informar um Intervalo de dados, no SQL se precisa colocar o comando BETWEEN e o parâmetro inicial e final, sendo :p_empresa_inicial e :p_empresa_final respectivamente.

  Uma observação importante:

• uso dos dois pontos (:) desse exemplo deve-se ao fato de estar usando um banco ORACLE. No caso de bancos MSSQL usa-se @. Dessa forma fica assim:

ORACLE :p_empresa_inicial

MSSQL @p_empresa_final

  Após a inclusão do comando SQL, clique no botão seguinte. A tela seguinte será preciso cadastrar dentro do Cigam Report os parâmetros. É necessário informar os dados de cada um dos parâmetros. No caso desse exemplo são dois, o inicial e final.

  É necessário informar sempre:

• Name: É o nome do parâmetro.
  
• DataType: é o tipo de data do parâmetro. Nesse exemplo é um VarChar.
  
• DefaultValue: Valor padrão, nesse caso foi informado zero.
  
• Size: é o tamanho do campo.
  

  Em caso de dúvidas, essas informações aparecem na tela do Cigam quando foi cadastrado o parâmetro.