Diseño de plantillas con IBM Rational Team Concert como origen de datos

Los diseñadores de informes pueden utilizar Document Studio para importar esquemas de origen de datos y plantillas del informe de compilación.

Antes de empezar

Consejo: La instalación de Rational Publishing Engine incluye un conjunto de informes de ejemplo. Antes de empezar a publicar documentos, puede explorar este escenario de generación de documentos de ejemplo. Consulte Creación de la plantilla de ejemplo REST.
Familiarícese con el servicio REST de Rational Team Concert y los distintos URL necesarios para extraer datos de Rational Team Concert cuando se utiliza Rational Publishing Engine. Consulte Wiki de API REST notificable: Recursos proporcionados por Rational Team Concert.
La API REST notificable de Rational Team Concert es diferente de muchas API de dominio tradicionales. En lugar de proporcionar URL de recurso que apuntan a elementos específicos como, por ejemplo, un elemento de trabajo único o un único resultado de creación, la API REST notificable proporciona acceso a recursos monolíticos. Cada recurso monolítico es un recurso de contenedor, que representa el resultado de una consulta para una o varios elementos.
  • foundation: Artefactos comunes como, por ejemplo, áreas de proyecto, áreas de equipo, colaboradores, iteraciones y enlaces.
  • workitem: Artefactos de elemento de trabajo como, por ejemplo, resúmenes, categorías, gravedades y prioridades.
  • apt: Artefactos de planificación Agile como la capacidad del equipo, planificaciones de recursos y ausencias.
  • generic: Artefactos genéricos.
  • build: Artefactos de creación como por ejemplo, resultados de creación, colaboraciones de resultado de creación, definiciones de creación y motores de creación.
  • scm: Artefactos de control de origen como corrientes y componentes, así como deltas de dimensionamiento de corriente.
Estos recursos proporcionan flexibilidad para filtrar y consultar al recopilar datos para un informe. Por ejemplo, un recurso de elemento de trabajo podría contener uno o varios elementos relacionados con los elementos de trabajo, en función de la consulta o el filtro pasado a la API REST.

Acerca de esta tarea

Los datos se extraen utilizando la API REST. Esta interfaz se instala e implementa con la aplicación de origen de datos y funciona independientemente de Rational Publishing Engine. Si desea más información sobre la API REST para un origen de datos, consulte la documentación para el origen de datos.

Procedimiento

  1. Revise Diseño de plantillas de documentos para ver una visión general del proceso de desarrollo de plantilla. Inicie la planificación de la estructura del documento y los datos podrían estar incluidos. Por ejemplo, decida si el documento final se generará a partir de una plantilla o de varios archivos de plantilla que pueden contener cada uno partes reutilizables de contenido.
  2. En la aplicación Document Studio, cree una plantilla de documento.
  3. Añada un esquema de origen de datos a la plantilla de documento. Para Rational Team Concert, puede descubrir el esquema de origen de datos especificando el URL base para la aplicación.
    1. En Document Studio, pulse Datos > Añadir esquema de origen de datos.
    2. Si está utilizando el esquema de elementos de trabajo RTC, puede seleccionarlo en el campo Predefinido y saltar al paso e.
    3. En Tipo, seleccione el tipo de esquema en la lista. Para Rational Team Concert, seleccione REST.
    4. Edite el campo Esquema si es necesario o pulse Examinar para seleccionar la vía de acceso del archivo de esquema.
      • https://servidor:puerto/ccm/rpt/repository/foundation
      • https://servidor:puerto/ccm/rpt/repository/workitem
      • https://servidor:puerto/ccm/rpt/repository/apt
      • https://servidor:puerto/ccm/rpt/repository/generic
      • https://servidor:puerto/ccm/rpt/repository/scm
      • https://servidor:puerto/ccm/rpt/repository/build

      Para CLM 6.0.2 y posteriores, obtenga el enlace permanente para el artefacto, por ejemplo, pulse un icono de elemento de trabajo y utilice la función Copiar enlace en el navegador. Pegue el URL en el campo Esquema.

    5. Añada ?metadata=schema al final del URL si todavía no existe.
      • Ejemplo: https://servidor:puerto/ccm/rpt/repository/workitem?metadata=schema
    6. Si el recurso está en un servidor protegido, especifique el nombre de Usuario.
    7. Si el recurso está en un servidor protegido, especifique la Contraseña.
    8. Seleccione el Tipo de autenticación en la lista. Para Rational Team Concert, puede utilizar tipos de autenticación de Formulario, Básico o OAuth.
    9. (Solo perfil POX - para CLM 6.0.2 y posteriores) En el campo Cabeceras adicionales, seleccione la cabecera del perfil POX. Si desea más información sobre el perfil POX, consulte Creación de documentos de rastreabilidad de aplicaciones CLM utilizando el perfil POX.
    10. Pulse Finalizar. El esquema de origen de datos que ha seleccionado se muestra en la vista de origen de datos.
  4. Añada elementos a la plantilla. Rational Publishing Engine tiene un conjunto integral de elementos de plantilla que puede utilizar para estructurar el documento. Puede arrastrar elementos hasta el editor de contenidos de plantilla. Por ejemplo, puede añadir un elemento de contenedor para contener varios párrafos. Cada párrafo podría estar controlado por una condición de prueba que solo se asocia con datos específicos. Si desea más información, consulte Elementos de plantillas en la vista Paleta u Añadir elementos a una plantilla.
  5. Utilice consultas, atributos, y variables para añadir datos a una plantilla. Estos elementos especifican qué partes de información se generan en el informe.
  6. Añada formato y estilo a los elementos para controlar cómo se muestran en la salida.
  7. Cree filtros para limitar los datos que se extraen del informe. Puede utilizar filtros, que son versiones detalladas del URI de origen de datos general, para señalar a subconjuntos específicos de datos, de forma que Rational Publishing Engine no intenta recuperar más información de la necesaria del origen de datos durante la generación de informes. Estos filtros deben ser lo bastante amplios para recuperar todos los datos necesarios referenciados por la plantilla o el informe generado no podrá incluir datos completos. Rational Team Concert da soporte a orígenes de datos Reportable Rest v1 para su uso en filtros nativos. Consulte API REST de informes en Jazz.net para obtener más información. Ejemplo:
    [projectArea/name="JKESample"]/*
    Solicitud resuelta:
    https://servidor:puerto/ccm/rpt/repository/workitem?fields=workitem/workItem[projectArea/name="JKESample"]/(@href|summary)
    Nota: No todos los campos se pueden utilizar para el filtro nativo.
  8. Cree clasificaciones para organizar los datos en el informe.