Projetando Modelos com IBM Rational Team Concert 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 Team Concert e as várias URLs necessárias para extrair dados do Rational Team Concert usando o Rational Publishing Engine. Consulte Wiki da API REST relatável: recursos fornecidos pelo Rational Team Concert.
A API REST relatável do Rational Team Concert é diferente de muitas APIs de domínio tradicionais. Em vez de fornecer URLs de recurso que apontem para itens específicos, como um único item de trabalho ou um único resultado de construção, a API REST relatável fornece acesso a recursos monolíticos. Cada recurso monolítico é um recurso de contêiner, que representa o resultado de uma consulta para um ou mais elementos.
  • foundation: Artefatos comuns, como áreas de projeto, áreas de equipe, contribuidores, iterações e links.
  • workitem: Artefatos de tem de trabalho, como resumos, categorias, gravidades e prioridades.
  • apt: Artefatos de planejamento rápido, como capacidade da equipe, planejamentos de recursos e ausências.
  • generic: Artefatos genéricos.
  • build: Artefatos de compilação, como resultados de compilação, contribuições de resultado de compilação, definições de compilação e mecanismos de compilação.
  • scm: Artefatos de controle de origem, como fluxos e componentes, bem como deltas de dimensionamento de fluxo.
Esses recursos fornecem flexibilidade na filtragem e consulta ao reunir dados para um relatório. Por exemplo, um recurso do item de trabalho pode conter um ou mais elementos relacionados aos itens de trabalho, dependendo da consulta ou filtro passado para a API REST.

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 Team Concert, é possível descobrir o esquema da origem de dados inserindo a URL base no aplicativo.
    1. No Document Studio, clique em Dados > Incluir esquema da origem de dados.
    2. Se você estiver utilizando o esquema Itens de trabalho de RTC, poderá selecioná-lo no campo Predefinido e ir para a etapa e.
    3. Em Tipo, selecione o tipo de esquema na lista. Para Rational Team Concert, selecione REST.
    4. Edite o campo Esquema, se necessário, ou clique em Procurar para selecionar o caminho para o arquivo de esquema.
      • https://server:port/ccm/rpt/repository/foundation
      • https://server:port/ccm/rpt/repository/workitem
      • https://server:port/ccm/rpt/repository/apt
      • https://server:port/ccm/rpt/repository/generic
      • https://server:port/ccm/rpt/repository/scm
      • https://server:port/ccm/rpt/repository/build

      Para CLM 6.0.2 e mais recente, obtenha o link permanente para o artefato, por exemplo, clique em um ícone do item de trabalho e use a função de link Cópia em seu navegador. Cole a URL no campo Esquema.

    5. Anexe ?metadata=schema ao final da URL se ele não estiver ali.
      • Exemplo: https://server:port/ccm/rpt/repository/workitem?metadata=schema
    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 Team Concert, é possível usar tipos de autenticações de 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 Concluir. O esquema da origem de dados que você selecionou é exibido na visualização 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. Rational Team Concert suporta origens de dados Rest v1 relatáveis para uso em filtros nativos. Consulte Reportable REST API on Jazz.net para obter informações adicionais. Por exemplo:
    [projectArea/name="JKESample"]/*
    Resolved request:
    https://server:port/ccm/rpt/repository/workitem?fields=workitem/workItem[projectArea/name="JKESample"]/(@href|summary)
    Nota: Nem todos os campos podem ser usados para filtragem nativa.
  8. Crie tipos para organizar os dados em seu relatório.