BusinessObjects

O blog do Consultor BO

Customizar o template do BI Launch Pad

Bom, pessoal, faz muito tempo que não posto nada, infelizmente não tinha nenhum tópico que me animasse a criar um post, mas há alguns dias encontrei o tópico Customizar o template do BI Launch Pad. A ideia é simples: alterar o logo e as cores do BI Launch Pad para este ficar adequado à identidade visual da empresa que o possui.

Sempre soube que isso era possível, porém nunca tinha feito. Imaginava que era algo relativamente simples, por conta de minhas experiências de web designer com WordPress. Mas o caminho é bem mais sinuoso, e a seguir vou mostrar-lhes como atravessar o caminho das pedras.

Este tutorial é baseado no tutorial Branding and Theming of BI launch pad, publicado no SCN  por Christina Obry, com base na documentação oficial SAP BusinessObjects BI Customization Guide.

Primeiramente, temos uma premissa de boa prática: não é válido alterar o template standard do BI Launch Pad, porque além de ser mais difícil encontrar os arquivos CSS e as imagens, quando ocorrer uma atualização (Support Package ou Patch) você perderá tudo, pois o instalador irá aplicar a versão atualizada dessas interfaces. Pensando nisso, os desenvolvedores já incluíram um template customizável para ser instalado no Tomcat, e é a partir desse template que vamos criar a identidade visual.

Recuperando os arquivos de customização de template

Os arquivos encontram-se dentro dos arquivos do instalador do BO server, pasta Collaterals\CustomizationTemplate:
Template BI Launch Pad 01

Warfiles Dir
<< Diretório de Instalação >>\SAP BusinessObjects Enterprise XI 4.0\warfiles\
Essa pasta contém os arquivos utilizados para Deploy das aplicações web no Tomcat.

Preparando os arquivos

São três pacotes que podemos customizar:

  • com.businessobjects.webpath.CrystalReports_oem.jar
  • com.businessobjects.webpath.InfoViewBranding.jar
  • com.businessobjects.webpath.OpenDocumentBranding.jar

Para este exemplo, vamos customizar somente o pacote do InfoViewBranding.jar, que se refere ao BI Launch Pad (até hoje não me conformo com a mudança do nome InfoView para BI Launch Pad, feita pela SAP; não vejo ganho nem sentido…).

Arquivo .jar é basicamente arquivos compactados. É possível descompactá-los com winrar, por exemplo, mas é possível utilizar o próprio descompactador do Windows: é só alterar a extensão de .jar para .zip:

  • de: com.businessobjects.webpath.InfoViewBranding.jar
  • para: com.businessobjects.webpath.InfoViewBranding.zip

Descompacte o pacote e você encontrará a seguinte estrutura:
Template BI Launch Pad 02

Depois de descompactado, exclua o arquivo “com.businessobjects.webpath.InfoViewBranding.zip”.

Mova o conteúdo da pasta Sample para o nível superior, pasta web, e exclua a pasta Sample:
Template BI Launch Pad 04

Fica assim:
Template BI Launch Pad 05

Agora vamos empacotar tudo novamente. Dentro da pasta “com.businessobjects.webpath.InfoViewBranding” compacte as pastas “META-INF” e “web”, gerando um novo arquivo zipado. Renomeie-o para “com.businessobjects.webpath.InfoViewBranding.jar”
Template BI Launch Pad 06

Esse arquivo .jar que criamos é o nosso pacote pronto para instalar.

Instalando o template customizável

Neste ponto, você me indaga: mas não customizamos nada ainda!

O que vamos fazer é instalar esse template customizável no Tomcat e, depois, efetuar as alterações. Com tudo pronto, customizado e aprovado, empacotamos novamente (regar o arquivo .jar) e colocamos na pasta warfiles da instalação do BO; assim, quando ocorrer um deploy no Tomcat novamente, como ocorre quando instalamos um SP, o nosso novo template não será perdido.

Prosseguindo, mova o arquivo com.businessobjects.webpath.InfoViewBranding.jar para o diretório abaixo:
<< Diretório de Instalação >>\SAP BusinessObjects Enterprise XI 4.0\warfiles\webapps\BOE\WEB-INF\eclipse\plugins\

Dentro desta pasta há vários arquivos .jar, que são os pacotes standard do BO. Ficará assim:
Template BI Launch Pad 07

WDeploy:

É uma ferramenta do BO que faz a instalação das aplicações web. Basicamente, ela pega o que está na pasta warfiles do diretório de instalação do BO e instala na pasta webapps do Tomcat.

Observe que dentro do Tomcat existe praticamente a mesma estrutura que a da pasta warfiles, a diferença é que os arquivos .jar ficam descompactados no Tomcat:
Template BI Launch Pad 08

Template BI Launch Pad 09

Antes de executar o WDeploy, você precisa parar o serviço do Tomcat.

O WDeploy pode ser executado por linha de comando, mas tem uma interface para ajudar. Para abrir, você pode ir no Menu Iniciar > SAP Business Intelligence > SAP BusinessObjects BI platform 4 > wdeploy:
Template BI Launch Pad 10

Outra opção é chamá-lo diretamente pelo caminho << Diretório de Instalação >>\SAP BusinessObjects Enterprise XI 4.0\wdeploy\WDeployGui.jar
Template BI Launch Pad 11

Para a minha instalação, foi necessário desmarcar a opção “Tomcat instalado como um serviço do Windows”.

Ao clicar em “Executar”, a ferramenta vai reinstalar todos os pacotes de aplicações web novamente, e nesses pacotes vai o com.businessobjects.webpath.InfoViewBranding.jar. Demora um pouco até finalizar o processo.

Ao final, a pasta “webpath.InfoViewBranding” foi criada dentro do Tomcat:
Template BI Launch Pad 12

Antes de iniciar o Tomcat, exclua a seguinte pasta:
<< Diretório de Instalação >>\tomcat\work\Catalina\localhost\BOE

Essa pasta Work é a pasta para a qual o Tomcat sobe os arquivos para publicação. Quando o serviço é iniciado, ele verifica as aplicações que já estão publicadas no diretório work e as disponíveis no diretório webapps; se a aplicação não existir no diretório work, ele cria. A aplicação BOE é bem grande (1,6 GB) e demora um pouco para subir por completo, mesmo com o serviço Tomcat constando como iniciado.

Antes de abrir o BI Launch Pad, limpe o cache do navegador. Com o cache limpo, abra o BI Launch Pad. O template instalado apresenta tons variados de laranja, sendo bem distinto do standard:
Template BI Launch Pad 13
Obs.: No meu ambiente, estou trabalhando com a autenticação integrada com SAP BW.

Template BI Launch Pad 14

Customizando

Com o template instalado já é possível iniciar as customizações no CSS do BI Launch Pad. No meu caso, utilizei muito o recurso de “Inspecionar elemento” do navegador Google Chrome para verificar as propriedades CSS e ir testando as alterações em tempo de execução:
Template BI Launch Pad 15

As alterações serão feitas no seguinte arquivo de CSS:
<< Diretório de Instalação >>\tomcat\webapps\BOE\WEB-INF\eclipse\plugins\ webpath.InfoViewBranding\web\css\customize.css

O arquivo foi muito bem elaborado, todo comentado. A partir deste momento, recomendo utilizar a documentação oficial para auxiliar, a partir da página 66, no capítulo Web Application Customization.

Abaixo, um pouco do que consta no documento:

Template BI Launch Pad 17

Template BI Launch Pad 18

Template BI Launch Pad 19

Boa parte do design das cores encontra-se nas imagens, o que vai exigir também um trabalho de tratamento das imagens. Os arquivos constam em:
<< Diretório de Instalação >>\tomcat\webapps\BOE\WEB-INF\eclipse\plugins\ webpath.InfoViewBranding\web\images\theme\
Template BI Launch Pad 20

Depois de realizar as alterações no arquivo customize.css e nas imagens, para ativar as alterações é necessário:

  1. Parar o serviço do Tomcat;
  2. Eliminar a pasta << Diretório de Instalação >>\tomcat\work\Catalina\localhost\BOE;
  3. Iniciar o Tomcat.

Certamente, você realizará essa operação várias vezes até deixar o template na identidade visual desejada.

Guardar template finalizado

O que realizamos até agora foi subir um template customizável no Tomcat para efetuarmos as alterações e aplicar a identidade visual. Porém, precisamos guardar esse template para que quando ocorrer uma atualização no BO não seja perdido todo esse trabalho.

É necessário gerar um novo pacote .jar:

  1. Vá até o diretório: << Diretório de Instalação >>\tomcat\webapps\BOE\WEB-INF\eclipse\plugins\webpath.InfoViewBranding
  2. Compacte as pastas META-INF e web, gerando um novo arquivo zipado. Renomeie para “com.businessobjects.webpath.InfoViewBranding.jar”
  3. Mova o arquivo com.businessobjects.webpath.InfoViewBranding.jar para o diretório: << Diretório de Instalação >>\SAP BusinessObjects Enterprise XI 4.0\warfiles\webapps\BOE\WEB-INF\eclipse\plugins\

Você irá substituir o arquivo existente, que é o original que colocamos lá no início do processo, antes do Wdeploy.

Se você desejar testar esse pacote gerado, execute as etapas de Wdeploy novamente.

Voltar ao template original

Simples: Exclua o arquivo “com.businessobjects.webpath.InfoViewBranding.jar” da pasta warfiles e execute novamente a etapa do Wdeploy.

, , , , , , , ,

2 thoughts on “Customizar o template do BI Launch Pad

Deixe uma resposta

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *