Projetando Modelos com Rational Quality Manager como uma Origem de Dados

Os designers de relatório podem usar o Document Studio para importar esquemas de origem de dados e construir modelos de relatórios.

Antes de Iniciar

Dica: O Rational Publishing Engine inclui um conjunto de relatórios de amostra. Antes de começar a publicar documentos, você pode explorar este cenário de geração de documento de exemplo. Consulte Criando o modelo de amostra REST.
Familiarize-se com o serviço REST do Rational Quality Manager e as várias URLs necessárias para extrair dados do Rational Quality Manager usando o Rational Publishing Engine. Consulte a documentação da API REST de Rational Quality Manager.

Sobre Esta Tarefa

Os dados são extraídos usando a API REST. Esta interface é instalada e implementada com o aplicativo de origem de dados e funciona de forma independente do Rational Publishing Engine. Para obter informações adicionais sobre a API REST para uma origem de dados, consulte a documentação para essa origem de dados.

Procedimento

  1. Revise Projetando Modelos de Documentos para obter uma visão geral do processo de desenvolvimento do modelo. Inicie o planejamento da estrutura de seu documento e dos dados que podem ser incluídos. Por exemplo, decida se o documento final será gerado a partir de um modelo ou de arquivos de múltiplos modelos, cada um contendo partes reutilizáveis de conteúdo.
  2. No aplicativo Document Studio, crie um modelo de documento.
  3. Identifique um esquema de origem de dados da sua origem de dados.
    • Para incluir partes de dados específicos de uma coleção, como detalhes de caso de teste ou scripts de teste, do seu projeto do Rational Quality Manager ou para acessar um único recurso com uma URL conhecida, construa uma URL que use o argumento feed. Você sempre usa este esquema e o configura dinamicamente para partes específicas de dados em seu modelo de seu projeto do Rational Quality Manager.
      • Exemplo: https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/feed.xsd
    • Para incluir partes de dados específicas de um recurso individual, como detalhes de caso de teste ou scripts de teste, do seu projeto do Rational Quality Manager ou para acessar um único recurso com uma URL conhecida, construa uma URL que use o argumento qm:
      • Exemplo: https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/qm.xsd
    • Se você estiver usando APIs REST v2 para gerar o documento, deverá fornecer uma URL de esquema da origem de dados para o provedor de serviços em vez da entrada raiz. Por exemplo:
      • Incorreto: https://server:port/qm/oslc_qm/catalog
      • Correto: https://server:port/qm/oslc_qm/catalog/repository/db/schema_repository/
  4. Inclua um esquema de origem de dados em seu modelo de documento. Para Rational Quality Manager, você pode concluir as seguintes etapas:
    1. No Document Studio, clique em Dados > Incluir esquema da origem de dados.
    2. No campo Predefinido, selecione um dos esquemas do RQM.
    3. Em Tipo, selecione o tipo de esquema na lista. Para Rational Quality Manager, selecione XML genérico.
    4. Edite o campo Esquema, se necessário, ou clique em Procurar para selecionar o caminho para o arquivo de esquema. (perfil POX apenas) Para CLM 6.0.2 e mais recente, copie o link para o artefato de seu navegador e, em seguida, cole a URL no campo Esquema.
    5. Anexe o texto a seguir no final da URL:
      • ?abbreviate=false
      • (Apenas perfil POX - CLM 6.0.2 e mais recente) &metadata=schema
      • Exemplo: https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/JKE Banking (Quality Management)/testcase?abbreviate=false
    6. Se o recurso estiver em um servidor protegido, especifique o nome de Usuário.
    7. Se o recurso estiver em um servidor protegido, especifique a Senha.
    8. Selecione o Tipo de autenticação na lista. Para Rational Quality Manager, é possível usar tipos de autenticações Form, Basic ou OAuth.
    9. (Perfil POX apenas - para CLM 6.0.2 e mais recente) No campo Cabeçalhos extras, selecione o cabeçalho do perfil POX. Para obter mais informações sobre o perfil POX, consulte Criando documentos de rastreabilidade de aplicativos CLM usando o perfil POX.
    10. Clique em Avançar e, em seguida, em Concluir.
  5. Inclua elementos no modelo. O Rational Publishing Engine tem um conjunto abrangente de elementos de modelo que podem ser usados para estruturar seu documento. É possível arrastar elementos para o editor de conteúdo do modelo. Por exemplo, é possível incluir um elemento do contêiner para manter vários parágrafos. Cada parágrafo pode ser controlado por uma condição de teste que o associa apenas com dados específicos. Para obter informações adicionais, consulte Elementos do Modelo na Visualização Paleta e Incluir elementos em um modelo.
  6. Use consultas, atributos e variáveis para incluir dados em um modelo. Esses itens especificam quais partes das informações são geradas no relatório.
  7. Inclua formatação e estilo para os elementos para controlar como eles são exibidos na saída.
  8. Crie filtros para restringir os dados que são extraídos no relatório. É possível usar filtros, que são versões detalhadas do URI da origem de dados geral, para apontar para subconjuntos específicos de dados de forma que o Rational Publishing Engine não tente recuperar mais informações do que as necessárias da origem de dados durante a geração de relatórios. Esses filtros devem ser amplos o suficiente para recuperar todos os dados necessários referidos pelo modelo ou o relatório gerado não poderá incluir os dados completos. Consulte Rational Quality Manager API REST relatável para obter mais informações.
  9. Crie tipos para organizar os dados em seu relatório.