Avançar para a área de conteúdo

Ao clicar em Enviar, você concorda com os termos e condições do developerWorks.

Na primeira vez que você efetua sign in no developerWorks, um perfil é criado para você. Informações selecionadas do seu perfil developerWorks são exibidas ao público, mas você pode editá-las a qualquer momento. Seu primeiro nome, sobrenome (a menos que escolha ocultá-los), e seu nome de exibição acompanharão o conteúdo que postar.

Todas as informações enviadas são seguras.

  • Fechar [x]

Ao se conectar ao developerWorks pela primeira vez, é criado um perfil para você e é necessário selecionar um nome de exibição. O nome de exibição acompanhará o conteúdo que você postar no developerWorks.

Escolha um nome de exibição de 3 - 31 caracteres. Seu nome de exibição deve ser exclusivo na comunidade do developerWorks e não deve ser o seu endereço de email por motivo de privacidade.

Ao clicar em Enviar, você concorda com os termos e condições do developerWorks.

Todas as informações enviadas são seguras.

  • Fechar [x]

Gerando documentação de conformidade com o IBM Rational Publishing Engine: Parte 4. Teste, revisão e implementação

Dr. Einar W. Karlsen, Solution Architect, North-East Europe, IBM
Author photo
Dr. Einar Karlsen tem mais de 25 anos de experiência na área de ferramentas e métodos de desenvolvimento de software. Ele está na divisão IBM Rational há 13 anos, auxiliando clientes no uso do software Rational, cobrindo aspectos relacionados à demonstração de conformidade pelo uso de ferramentas de geração de relatório, entre outros. Ele trabalha na Alemanha.

Resumo:  Este é o artigo final de uma série de quatro partes sobre o uso do IBM® Rational® Publishing Engine para gerar relatório relevantes à conformidade. Usando dois relatórios do IBM® Rational® Quality Manager como exemplos, ele mostra como testar, verificar e implementar os documentos e modelos que você desenvolveu.

Visualizar mais conteúdo nesta série

Data:  16/Jan/2012
Nível:  Introdutório Também disponível em :   Inglês
Atividade:  346 visualizações
Comentários:  


Teste

Neste artigo, você conhecerá alguns aspectos do teste, revisão e implementação. Os dois relatórios do IBM ® Rational® Quality Manager conforme mostrados na Figura 1 servem de exemplos. O primeiro relatório relaciona planos de teste, casos de teste, as entradas de teste associadas (requisitos) e os resultados de teste. O segundo relatório mostra planos de teste para os quais a documentação está incompleta, incluindo links para o plano de teste no Rational Quality Manager.


Figura 1. Relatórios IBM Rational Quality Manager

Como mencionado na Parte 1 (consulte o link "Mais conteúdo nesta série"), os modelos devem ser testados com frequência e os testes devem ser intercalados com a criação dos modelos. Portanto, é importante ter tempos de resposta rápidos; por isso, o IBM ® Rational® Publishing Engine oferece vários recursos para acelerar os testes.

Testar uma especificação de documento completa para um relatório baseado em conformidade pode impor sobrecargas significativas se ele consistir em vários modelos que extraiam informações de várias origens de dados (como o relatório de ciclo de vida de desenvolvimento de software usado como exemplo nesta série de artigos). Portanto, é melhor testar os modelos individualmente, um por um, definindo uma especificação de documento dedicada para o modelo. Essa especificação é então carregada no Document Studio com o modelo (consulte a Figura 1) para que a criação e o teste do modelo possam ser intercalados em intervalos frequentes.

Se o teste for executado chamando o comando generate document , o Rational Publishing Engine irá extrair informações das origens de dados referenciadas e gerar um relatório para todos os dados dentro do escopo do modelo. Nele encontra-se uma grande quantidade de dados, como para um plano de teste que contém várias centenas de casos de teste; isso pode levar um tempo considerável e pode gerar um relatório grande. É possível acelerar o processo de geração de relatório e limitar a quantidade de saída gerada a menos páginas usando o comando preview current document , que limita o número de elementos relatados em uma determinada coleta a um número máximo. É possível especificar o número máximo em Preferences (o padrão é 10). Para o modelo na Figura 1, isso significa que o relatório incluirá informações associadas a, no máximo, dez planos de teste ou casos de teste, não importa o número na origem de dados real. Porém, o Rational Publishing Engine ainda irá solicitar todos os dados da origem de dados, porque o corte de registros ocorre depois que os dados são recebidos pela origem de dados.


Figura 2. Especificação de documento para o relatório do Rational Quality Manager

Além do recurso de visualização, há outras maneiras de acelerar o teste:

  • Desative a extração de informações de uma origem de dados específica no modelo configurando a propriedade ignored da origem de dados para true (consulte a seção Properties na Figura 2). Isso fará com que o Rational Publishing Engine ignore os dados dessa origem de dados específica.
  • Limite os dados de entrada que vêm da origem de dados.
    • No Rational DOORS, é possível fazer isso definindo visualizações específicas com um número limitado de requisitos de entrada.
    • Para o Rational Quality Manager, isso significaria criar um projeto de teste específico para ser usado durante o teste e, a seguir, configurar a especificação do documento para usar esse projeto.
    • Como alternativa, o modelo pode ser definido para trabalhar com uma variável que limita o escopo atual a um plano de teste específico, e então você pode definir essa variável para fazer referência a um plano de teste com alguns casos de teste durante o desenvolvimento de modelo.

Durante o teste, você pode perceber que um relatório não entrega nenhum dado. Nessa situação, a melhor prática é usar domínios baseados em REST (Representational State Transfer) para verificar se as URLs estão corretas, o que requer que as URLs sejam inseridas em um navegador da web. Também é frequentemente possível usar a consulta ?metadata=schema para encontrar o esquema para o banco de dados, como mostrado na Figura 3.


Figura 3. Teste de um serviço REST

Visualização maior da Figura 3.


Verificando a exatidão, completude e consistência

Documentos relevantes para demonstrar a conformidade com diretrizes internas ou regulamentos externos não são gerados apenas uma vez, e sim muitas. Uma necessidade frequente de gerar um documento novamente consiste nos momentos em que uma revisão mostra que há informações ausentes, incompletas ou que precisam de revisão. Por exemplo, uma organização pode ter diretrizes que destacam a necessidade de fornecer documentações para todos os requisitos, elementos de modelo, planos de teste (apenas para mencionar alguns) e incluir essa informação nos relatórios gerados.

Apesar de geralmente ser possível customizar ferramentas de desenvolvimento para executar verificações de consistência, também é possível usar o Rational Publishing Engine para detectar se as informações estão ausentes e imprimir um aviso no documento gerado se essa situação ocorrer. A vantagem de se usar a ferramenta para esse propósito é que isso pode ser feito sem qualquer programação e sem envolver pessoas de outras funções na organização, como especialistas em Rational Quality Manager, DOORS ou Rhapsody.

Usando regiões

A seguinte subseção demonstra como você pode usar o Rational Publishing Engine para notificá-lo sobre problemas relacionados com descrições de caso de teste e planos de teste ausentes no fim de um documento gerado (em vez de intercaladados com as informações extraídas), sem ter que atravessar a fonte das informações uma segunda vez. Exemplos dos resultados são mostrados na Figura 1 e Figura 6. Não seria ideal se as mensagens de erro ocorressem intercaladas com a saída gerada, porque isso requereria que o revisor lesse o relatório inteiro para encontrar problemas. Porém, usando o conceito de regiões, você pode especificar que os avisos gerados sejam colocados em uma região de texto que pode ser localizada em algum outro lugar do modelo, em vez de no contexto atual. Observe que o elemento de região está disponível na paleta do Document Studio e pode ser inserida na posição relevante do modelo (por exemplo, no fim do modelo). A Figura 4 mostra a definição de uma região como essa.


Figura 4. Região para problemas de renderização

Usando contêineres

A região chamada Issues aparece no fim do modelo e contém, além do próprio elemento de região, uma quebra de página anterior e um cabeçalho de subseção chamado Document Issues. Observe que uma variável PRINT_ISSUES foi usada para ativar ou desativar a renderização dos avisos, para que a seção inteira de avisos possa ser desativada quando o documento final for gerado para aprovação.

Os elementos que definem os avisos são encontrados em outros locais, nas partes do modelo em que os detalhes de plano de teste são renderizados. A Figura 5 mostra um modelo básico para extrair informações para um plano de teste, junto com seu título e descrição associados. Nesse modelo, um contêiner chamado Output Issues foi definido com uma condição que verifica se uma descrição de plano de teste está vazia ou definida como TBD. Nesse caso, o modelo emitirá um aviso, assim como dois links. Para direcionar a saída dos avisos para a região chamada Issues (em vez de aparecerem no contexto atual), a propriedade de região alvo do contêiner foi definida como Issues. Isso acionará o Rational Publishing Engine para colocar na região Issues no fim do modelo toda a saída gerada no contêiner Output Issues..


Figura 5. Modelo com verificações de completude

Visualização maior da figura 5.

Usando links

A Figura 6 mostra a aparência do fragmento de saída correspondente produzido pelo modelo.


Figura 6. Renderização de problemas com links.

Observe que o modelo define dois links:

  • O primeiro link, que exibe o nome do plano de teste (HybridSUV), é um link interno que navega do local do aviso para o local em que o plano de teste está é definido no relatório gerado. O local foi definido pelo elemento Bookmark no modelo (no parágrafo anterior ao contêiner Output Issues). Tanto o Bookmark quanto o link interno usam a propriedade testplan/identifier para fornecer a conexão entre o link e o alvo do link.
  • O segundo link é um link externo que, quando você clica no URI do Rational Quality Manager, ele leva você diretamente ao plano de teste nesse software (consulte a Figura 7). É possível usar o Rational Publishing Engine para navegar diretamente de uma informação em um relatório para a definição apropriada na origem de dados, contanto que a origem de dados suporte links que permitam uma navegação como essa. Essa solução minimiza o trabalho necessário para iniciar outra ferramenta, localizar a origem da violação, e consertá-la. Simplesmente clique no link, efetue login no Rational Quality Manager (se ainda não estiver conectado), e corrija o problema fornecendo uma descrição adequada ou delegue o trabalho criando um item de trabalho para outro membro da equipe.

Figura 7. Navegação ao plano de teste a partir do relatório gerado.

Visualização maior da figura 7.

Definição de Propriedades

As propriedades dos links externos e internos que permitem a navegação na fonte do Rational Quality Manager, assim como a navegação dentro do documento, foram definidas na Figura 8. Basicamente, os links internos foram definidos para exibir o título do plano de teste e navegar para o marcador identificado pela propriedade testplan/identifier. O link externo é definido para exibir a URL do Rational Quality Manager (consulta testplan/identifier) e usar o mesmo valor que o alvo do link (propriedade Content).


Figura 8. Propriedades de link para links externos e internos.


Identificação de componentes reutilizáveis

Depois de desenvolver um modelo, é uma melhor prática identificar componentes reutilizáveis no modelo e registrá-los como fragmentos ou modelos inteiros antes de implementar o modelo. Suponha também que você gostaria de usar as técnicas apresentadas nos avisos sobre problemas da seção anterior em modelos futuros. Nesse caso, faria sentido registrar o contêiner chamado Issues e o contêiner chamado Output Issues como fragmentos reutilizáveis (elementos de paleta).

O primeiro fragmento de modelo com a região "issues" pode ser reutilizado sem muito trabalho adicional, porque ele simplesmente define alguns elementos. Antes de fazer isso, porém, limpe o modelo excluindo estilos, páginas master e variáveis não necessárias no fragmento. Depois de fazer isso, você pode salvar o modelo e publicá-lo como fragmento usando o assistente Publish Snippet, conforme mostrado na Figura 9. Depois de ser publicado, o nome do fragmento ficará na visualização de paleta.


Figura 9. Publicando fragmentos

Visualização maior da figura 9.

Seria necessário mais trabalho para transformar o contêiner chamado Output Issues em um componente reutilizável, porque há consultas, referências de marcador, texto corrigido e assim por diante nesta parte do modelo. Portanto, faria sentido simplificar e limpar sua definição antes dela ser publicada. As variáveis devem ser introduzidas para definir avisos a serem renderizados, texto a ser exibido para os links, e o alvo do link interno ou externo. Porém, faria sentido definir um novo estilo para o link, configurando a cor para azul (4080) e a propriedade line.underline para único.

Observação:

Esse retrabalho não é específico ao Rational Publishing Engine. É uma verdade fundamental que passar de uma solução específica para uma solução mais geral pode requerer mudanças.


Implementação

Há várias maneiras de implementar modelos e especificações de documento para uso final em uma organização. A implementação geralmente se resume a armazenar modelos e especificações de documento em alguma pasta ou subpasta de um servidor de arquivos central, além de definir maneiras de gerar os relatórios. Essa seção concentra-se exclusivamente no último aspecto da implementação.

Usando o ativador

Usar o ativador do Rational Publishing Engine é, naturalmente, uma possibilidade para a geração de relatório. Isso aumenta a sobrecarga, porque envolve várias etapas (iniciar o ativador, carregar o documento, chamar a geração de relatório). Como alternativa, é possível gerar documentos de forma interativa simplesmente usando o Microsoft Windows Explorer, sem ter que iniciar o ativador explicitamente, como mostrado na figura 10.


Figura 10. Geração usando o Windows Explorer

Usando a interface de linha de comandos

Frequentemente, as organizações desejam automatizar a geração de documentos para que eles possam ser gerados diariamente, semanalmente ou mensalmente. Para esses fins, é possível chamar a geração de documentos usando o rpe-launcher.exe em uma interface de linha de comandos, conforme mostrado na Figura 11. Observe que o comutador -noresult é usado para inibir a exibição de uma caixa de resultados no fim, permitindo assim que o usuário final abra a saída gerada (a geração é mais silenciosa).


Figura 11. Geração usando a shell de comando

Usando um planejador ou processo de construção

A invocação da geração de documentos pode ser ativada por um planejador ou, por exemplo, incorporando a geração de documentos como parte de uma construção no IBM ® Rational® Build Forge® ou outros sistemas de gerenciamento de construção.

Usando bibliotecas de modelo

Uma quarta possibilidade, mostrada na figura 12, é registrar o local dos modelos com o IBM Rational Publishing Engine nas preferências da ferramenta. Um usuário de DOORS pode então chamar o comando Publish > Generate Document de dentro do DOORS e obter acesso aos modelos em qualquer uma das bibliotecas registradas.


Figura 12. Registro e uso de bibliotecas de modelos

Há várias outras maneiras das quais os modelos e documentos podem ser implementados para uso final:

  • A opção de serviço da web para o Rational Publishing Engine (consulte Recursos) pode ser implementada em um servidor remoto, permitindo assim que a geração de relatórios aconteça no servidor em vez do desktop local. Isso pode acelerar a geração de documentos para relatórios complexos ao executá-la em um servidor remoto localizado próximo às origens de dados, para minimizar a necessidade de transferir uma grande quantidade de dados pela rede.
  • O Rational Publishing Engine oferece uma API abrangente para que as organizações possam escrever suas próprias rotinas de automação para gerar relatórios.
  • A Reporting Arena, uma parceira IBM, fornece uma extensão chamada Reporting Arena Web Publisher para gerar relatórios usando um navegador da web (thin client). Consulte a seção Recursos para obter o link do seu website.

Resumo

Esta parte da série abordou dicas para o desenvolvimento, teste, revisão e implementação da especificação de documentos e de modelos do IBM Rational Publishing Engine. Esta parte demonstrou três conceitos em particular:

  • Maneiras de acelerar os testes usando especificações de documento dedicadas, além da desativação de visualizações de documentos e recursos
  • Uso de regiões para incluir problemas do documento, como descrições ausentes, no fim do relatório
  • Uso de links externos para navegar de um relatório gerado até a origem externa (IBM Rational Quality Manager, por exemplo) para acelerar o processo de revisão
  • Uso de links internos para navegar de uma ocorrência aplicada para uma ocorrência definidora de um determinado elemento
  • Geração interativa de um relatório usando o Microsoft Windows Explorer
  • Geração automatizada de um relatório usando a interface da shell de comando

Não se esqueça de revisar a seção Recursos para saber onde encontrar informações úteis adicionais.


Recursos

Aprender

Obter produtos e tecnologias

Discutir

Sobre o autor

Author photo

Dr. Einar Karlsen tem mais de 25 anos de experiência na área de ferramentas e métodos de desenvolvimento de software. Ele está na divisão IBM Rational há 13 anos, auxiliando clientes no uso do software Rational, cobrindo aspectos relacionados à demonstração de conformidade pelo uso de ferramentas de geração de relatório, entre outros. Ele trabalha na Alemanha.

Ajuda para Relatar Abuso

Relatar abuso

Obrigado. Esta entrada foi sinalizada para atenção do moderador.


Ajuda para Relatar Abuso

Relatar abuso

Falha no envio do Relatório de abuso. Tente novamente mais tarde.


developerWorks: Registre-se


Precisa de um ID IBM?
Esqueceu seu ID IBM?


Esqueceu sua senha?
Alterar sua senha

Ao clicar em Enviar, você concorda com os termos de uso do developerWorks.

 


Na primeira vez que você efetua sign in no developerWorks, um perfil é criado para você. Informações selecionadas do seu perfil developerWorks são exibidas ao público, mas você pode editá-las a qualquer momento. Seu primeiro nome, sobrenome (a menos que escolha ocultá-los), e seu nome de exibição acompanharão o conteúdo que postar.

Selecione seu nome de exibição

Ao se conectar ao developerWorks pela primeira vez, é criado um perfil para você e é necessário selecionar um nome de exibição. O nome de exibição acompanhará o conteúdo que você postar no developerWorks.

Escolha um nome de exibição de 3 - 31 caracteres. Seu nome de exibição deve ser exclusivo na comunidade do developerWorks e não deve ser o seu endereço de email por motivo de privacidade.

(Deve possuir de 3 a 31 caracteres.)


Ao clicar em Enviar, você concorda com os termos de uso do developerWorks.

 


Classificar este artigo

Comentários

static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=80
Zone=Rational
ArticleID=784898
ArticleTitle=Gerando documentação de conformidade com o IBM Rational Publishing Engine: Parte 4. Teste, revisão e implementação
publish-date=01162012

Conheça a IBM da sua cidade

Virtual Branch Office Brasil

A IBM está mais perto do que você imagina!


Tags

Help
Use o campo de pesquisa para encontrar todos os tipos de conteúdo no My developerWorks com essa tag.

Use a barra de rolagem para ver mais ou menos tags.

Tags populares mostra as principais tags para esta zona de conteúdo em particular (por exemplo, Java technology, Linux, WebSphere).

Minhas tags mostra suas tags para esta zona de conteúdo em particular (por exemplo, Java technology, Linux, WebSphere).

Use o campo de pesquisa para localizar todos os tipos de conteúdo no Meu developerWorks com essa tag. Tags populares mostra as tags principais para essa zona de conteúdo particular (por exemplo, tecnologia Java, Linux, WebSphere). My tags shows your tags for this particular content zone (for example, Java technology, Linux, WebSphere). Minhas tags mostra as suas tags para essa zona de conteúdo em particular (por exemplo, tecnologia Java, Linux, WebSphere).