Projetando Modelos com Rational ClearQuest 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 ClearQuest e as várias URLs necessárias para extrair dados do Rational ClearQuest usando o Rational Publishing Engine. Consulte Sobre o Centro de Informações do Rational ClearQuest.

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. Inclua um esquema de origem de dados em seu modelo de documento. Para o Rational ClearQuest, é possível descobrir o esquema da origem de dados inserindo a URL base no aplicativo.
    1. Abra o assistente de descoberta do esquema que se aplica à sua versão do Rational ClearQuest
      • Para versões anteriores do Rational ClearQuest que usam REST v1, clique em Dados > Descoberta do esquema > Descoberta de esquema REST.
      • Para versões posteriores do Rational ClearQuest que usam REST v2, clique em Dados > Descoberta de esquema > Descoberta de esquema REST v2.
    2. Especifique a URL base para o recurso.
      • Para versões REST v1 do Rational ClearQuest, Rational Publishing Engine usa Rational Data Services para descobrir esquema e consultar dados. A URL base para Data Services é: https://server:port/DataServices/ClearQuest
      • Para versões REST v2 do Rational ClearQuest, a partir de uma URL ServiceProvider. Usuários podem obter a URL ServiceProvider visitando a URL ServiceCatalog do Rational ClearQuest REST v2, como https://server:port/context/oslc. Configure os cabeçalhos de HTTP OSLC-Core-Version para 2.0 e aceite para application/rdf+xml. No resultado retornado, é possível localizar a URL rdf:about de ServiceProvider.
        Se você estiver usando APIs REST v2 para gerar o documento, deverá fornecer uma URL de esquema de origem de dados para o provedor de serviços em vez da entrada raiz. Por exemplo:
        • Incorreto: https://server:port/cqweb/oslc
        • Correto: https://server:port/cqweb/oslc/repo/repository/db/schema_repository/
    3. Selecione um Tipo de autenticação na lista. Se não selecionar um tipo, cada tipo será testado até que o tipo correto seja localizado, o que pode aumentar o tempo de geração do documento.
    4. Se o recurso estiver em um servidor protegido, especifique o nome de Usuário.
    5. Se o recurso estiver em um servidor protegido, especifique a Senha.
    6. Clique em Avançar. A URL base que inseriu é anexa automaticamente com ?metadata=schema. Exemplo: https://server:port/service/cq/records/defects?metadata=schema
    7. Clique em Concluir. O esquema da origem de dados que você selecionou é exibido na Visualização de origem de dados.
  4. 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.
  5. 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.
  6. Inclua formatação e estilo para os elementos para controlar como eles são exibidos na saída.
  7. 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.

    O adaptador Rational ClearQuest suporta filtragem nativa de origens de dados Rest v1 relatáveis. Nos filtros nativos Rest v1 relatáveis, só é necessário digitar o texto entre os colchetes []. O resto do filtro é gerado pelo Rational Publishing Engine. Consulte Reportable Rest v1 para obter informações adicionais.

    O Rational ClearQuest versão 8 sem o adaptador suporta filtragem nativa de origens de dados Rest v2 relatáveis. Para obter mais informações, consulte API REST de Rational ClearQuest OSLC CM.

    Filtro de variável de amostra:
    cq:Product{cq:Product="${productName}") 
    Filtro resolvido de amostra no qual productName é Rational Publishing Engine:
    cq:Product{cq:Product="Rational Publishing Engine")
    Nota:
    • Solicitações são feitas para uma origem de dados apenas quando necessário. Por exemplo, é possível usar condições para ter a exibição de um elemento na saída somente quando ele contém dados. A condição em um elemento de contêiner pode ser variable == "true". Se esta condição não for atendida e nenhum dado atender à condição da variável, nenhuma solicitação será feita na origem de dados.
    • É possível calcular filtros nativos antes de fazer a solicitação. O filtro nativo é calculado no ponto em que a consulta é encontrada e usa os valores de variável nesse ponto. Então você pode executar cálculos no modelo, o que afetará os filtros nativos.
  8. Crie tipos para organizar os dados em seu relatório.