Produto : Datasul – CRM versão 11.5.8 Chamado : Projeto D_CRM001 – IRM001809
Data da
criação : 05/08/2013 Data da revisão : 16/10/13
País(es) : Brasil Banco(s) de
Dados : Progress, Oracle e SQL Server
O sistema é atualizado logo após a aplicação do pacote de atualizações ao se atualizar a versão para 11.5.8.
Após atualizar a versão, verificar se o seguinte arquivo está disponível no servidor JBOSS do EMS Datasul: a) Verificar se o “EAR” datasul-byyou-11.5.8-SNAPSHOT.ear (ou superior) detêm o seguinte arquivo:
webviewer-4.3.1.war, esse viewer do BIRT é referente a versão 4.3.1 dessa ferramenta.
b) Verificar se o arquivo “application.xml”, dentro da pasta META-INF do “EAR” datasul-byyou-11.5.8-SNAPSHOT.ear (ou superior), contêm a seguinte entrada, que deve refletir o nome do arquivo mencionado no item a: <module> <web> <web-uri>webviewer-4.3.1.war</web-uri> <context-root>birt</context-root> </web> </module>
Procedimento para Implementação
A partir da versão 11.5.8, o CRM Datasul passará a contar com a funcionalidade de chamar relatórios construídos na ferramenta BIRT.
c) Verificar se as seguintes libs se encontram na pasta WEB-INF\lib, do “WAR” webviewer-4.3.1.war: commons-logging-1.1.1.jar commons-logging-1.1.1-javadoc.jar commons-logging-1.1.1-sources.jar commons-logging-adapters-1.1.1.jar commons-logging-api-1.1.1.jar commons-logging-tests.jar ifxjdbc.jar mysql.jar ojdbc14.jar openedge.jar sqljdbc.jar
ig
CONFIGURAÇÃO DE PARÂMETROS1. No menu de parâmetros do CRM, menu CRM -> Administração do CRM -> Tarefas -> Alterar
Parâmetros CRM, os seguintes parâmetros devem estar configurados:
Parâmetro Descrição
BIRT_URL
Este parâmetro aponta para o local de execução do BIRT viewer. Exemplo: http://servidor:8080/birt
Lembrando que o endereço acima quando informado, varia conforme a localização da URL no servidor de aplicação.
BIRT_CRM
Este parâmetro aponta para o local de execução dos relatórios BIRT viewer. Exemplo: report/crm.
Lembrando que o complemento report/crm, deve apontar para a pasta física dentro do servidor onde estão os relatórios a serem executados. Deve-se manter o padrão report/crm, tanto da pasta a ser criada para armazenar os relatórios, como na configuração desse parâmetro.
BIRT_DATABASE
Banco com os quais os relatórios estão homologados: 1 – Progress, 2 – Oracle e 3 – SQL Server.
Assim se a base é Oracle o valor informado nesse parâmetro é 2. Esse parâmetro é levando em conta na construção de relatórios na ferramenta BIRT.
BIRT_DATABASE_DATE
Formato de data do banco de dados, que o relatório do CRM utilizará para fazer a conversão da data passada por parâmetro. O formato a seguir é apenas ilustrativo.
Ex.: Progress - yyyy-MM-dd Oracle - MM/dd/yyyy SqlServer - dd/MM/yyyy
Os formatos podem variar de acordo com a configuração do banco de dados. Os valores referentes aos meses devem ter as letras M em formato maiúsculo. Esse parâmetro é levando em conta na construção de relatórios na ferramenta BIRT.
BIRT_WINDOW_HEIGHT Altura da janela de abertura do BIRT, para visualização do
relatório. Padrão é o valor de 800.
BIRT_WINDOW_WIDTH Largura da janela de abertura do BIRT, para visualização do
relatório. Padrão é o valor de 600.
CONFIGURAÇÃO DE MENUS
Não há.
CONFIGURAÇÃO DO BIRT
1. O BIRT precisa de algumas informações complementares para executar os relatórios. Uma vez dentro da pasta “webviewer-4.3.1.war”, procurar a pasta WEB-INF, ali, procurar o arquivo web.xml, e alterar os seguintes parâmetros, conforme o exemplo a seguir:
a) BIRT_VIEWER_LOCALE: colocar a opção pt-BR na marcação <param-value>, referente a localização. <context-param>
<param-name>BIRT_VIEWER_LOCALE</param-name> <param-value>pt-BR</param-value>
</context-param>
b) BIRT_VIEWER_TIMEZONE: colocar a opção GMT-3 na marcação <param-value>, referente ao fuso horário.
<context-param>
<param-name>BIRT_VIEWER_TIMEZONE</param-name> <param-value>GMT-3</param-value>
2. Os relatórios criados devem ser colocados na pasta report, que se encontra dentro do
“webviewer-4.3.1.war”. A estrutura para relatórios para o módulo crm podem ficar como essa sugestão abaixo,
estrutura que se necessária deve ser criada: a) report/
crm/
imagens/
Onde a pasta crm guarda os relatórios e a pasta imagens dentro de crm as imagens usadas nesses relatórios.
CONFIGURAÇÃO DE ACESSO A BASE DE DADOS PARA USO DOS RELATÓRIOS
1. Devido à dinâmica que há entre o ambiente de criação dos relatórios e sua posterior utilização em um ambiente de produção, onde não há o mesmo contexto quanto ao acesso a base de dados. É necessário então criar um arquivo de configuração de acesso ao banco de dados de forma externa. Esse arquivo será lido quando da execução do relatório, para se conectar a base de dados e trazer o resultado da consulta para o relatório. Essas informações de conexão precisam ser configuradas junto do WAR do BIRT.
2. Uma vez dentro do contexto “webviewer-4.3.1.war”, procurar a pasta WEB-INF, ali dentro criar ou
alterar o arquivo config.properties. Esse arquivo necessita de quatro parâmetros que precisam ser
configurados, são eles: driver da conexão (por padrão não é alterado), url de conexão precisa ser alterada para refletir o local onde o banco se encontra, e pode variar conforme o banco, usuário e senha de acesso ao banco também precisam ser configurados. Observação, o símbolo de # antes de um texto, é utilizado para comentar algo dentro desse arquivo. A seguir exemplos de configuração por banco: a) Progress #Progress driver=com.ddtek.jdbc.openedge.OpenEdgeDriver url=jdbc:datadirect:openedge://servidor:5086;databaseName=teste usuario=root senha=root b) Oracle #Oracle driver=oracle.jdbc.driver.OracleDriver url=jdbc:oracle:thin:@servidor:1521:prd112 usuario=root senha=root c) SQL Server #SqlServer driver=com.microsoft.sqlserver.jdbc.SQLServerDriver
url=jdbc:sqlserver://servidor\\sql2008/database=teste usuario=root
senha=root
3. Se o relatório envolver duas conexões com bancos distintos, basta adicionar a conexão extra no
config.properties. Como sugestão o nome dos parâmetros deve ter um o número 2 (dois), adicionado
ao nome. Exemplo: driver2, url2, usuario2 e senha2. Apontando para a respectiva configuração dessa segunda base.
Após essas configurações, os seguintes passos para utilização da funcionalidade deverão ser seguidos:
Exemplo:
1. Após efetuar login no CRM, acessar o link do servidor (que pode variar conforme a configuração do cliente) colocando atrás do endereço a opção /birt. A imagem que aparecerá no navegador indica que o BIRT está no ar juntamente com o restante do ERP EMS.
2. Cadastrar o relatório de exemplo do CRM, que se encontra no servidor dentro do .ear na pasta (/datasul-framework-ui.war/assets/reports/). Para tanto, ir ao menu CRM -> Administração -> Cadastros -> Manutenção Relatório. Na tela que se abre, incluir a informações a seguir:
a) Descrição: Listagem de clientes; Nome arquivo físico do relatório: clienteresponsavel.rptdesign; Módulo do relatório: Gestão de Contas.
b) Nas ações relacionadas do relatório, acessar o cadastro de Manutenção Parâmetros de Relatório e incluir as seguintes informações. Apelido Campo: Código cliente; Nome do parâmetro no relatório: num_id (Esse parâmetro é o mesmo existente no relatório); Tipo Campo: Edit-Numéric.
c) Nas ações relacionadas do relatório, acessar o cadastro de Manutenção Usuário por Relatório, e adicionar os usuários que terão permissão de acesso ao relatório.
d) Nas ações relacionadas do relatório, selecionar a opção Executar Relatório, e executar o relatório. O resultado é visto no navegador.
3. É importante verificar se os parâmetros de sistema do CRM estão corretamente configurados, bem como a conexão externa do banco de dados dentro do servidor que é usada pelos relatórios. Se necessário o relatório deve ser alterado na ferramenta externa BIRT, para refletir o ambiente onde será executado.
Procedimentos para Utilização
Também deve ser verificado se os arquivos físicos dos relatórios estão na mesma pasta no servidor, que foi configurada nos parâmetros do CRM.
Tabelas Utilizadas
Sigla e Nome da tabela
crm_relat_web – Relatórios do CRM em BIRT.
crm_param_relat_web – Parâmetros relatório do CRM. crm_usuar_relat_web – Usuários relatório CRM.
Rotinas Envolvidas
Nome dos fontes das rotinas envolvidas e influenciadas pelas atualizações.
CFFRelatorio – Manutenção Relatório.
CFFParRelatorio – Manutenção Parâmetros de Relatório. FFExecRelatorio – Executar Relatório.
CFFUsuarioRelatorio – Manutenção Usuários por Relatório.
Sistemas Operacionais Windows/Linux
Número do Plano Não há.