Diseño de plantillas con Rational ClearQuest 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 ClearQuest y los distintos URL necesarios para extraer datos de Rational ClearQuest utilizando Rational Publishing Engine. Consulte Acerca del Rational ClearQuest Information Center.

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 ClearQuest, puede descubrir el esquema de origen de datos especificando el URL base para la aplicación.
    1. Abra el asistente de descubrimiento de esquema que se aplica a su versión de Rational ClearQuest
      • Para versiones anteriores de Rational ClearQuest que utilizan REST v1, pulse Datos > Descubrimiento de esquema > Descubrimiento de esquema REST.
      • Para versiones posteriores de Rational ClearQuest que utilizan REST v2, pulse Datos > Descubrimiento de esquema > Descubrimiento de esquema REST v2.
    2. Especifique el URL base para el recurso.
      • Para versiones de REST v1 de Rational ClearQuest, Rational Publishing Engine utiliza los servicios Rational Data Services para descubrir el esquema y consultar datos. El URL base para Data Services es: https://servidor:puerto/DataServices/ClearQuest
      • Para versiones de REST v2 de Rational ClearQuest, se ha iniciado desde un URL ServiceProvider. Los usuarios pueden obtener el URL ServiceProvider visitando el URL de Rational ClearQuest REST v2 ServiceCatalog, como https://servidor:puerto/context/oslc. Establezca cabeceras HTTP OSLC-Core-Version en 2.0 y acepte application/rdf+xml. Desde el resultado devuelto, puede encontrar el URL ServiceProvider rdf:about.
        Si está utilizando las API REST v2 para generar el documento, debe proporciona un URL de esquema de origen de datos al proveedor de servicios, en lugar de la entrada raíz. Ejemplo:
        • Incorrecto: https://servidor:puerto/cqweb/oslc
        • Correcto: https://servidor:puerto/cqweb/oslc/repo/repository/db/schema_repository/
    3. Seleccione un Tipo de autenticación de la lista. Si no selecciona un tipo, se prueba cada tipo, hasta que se encuentra el tipo correcto, que podría aumentar el tiempo de generación de documentos.
    4. Si el recurso está en un servidor protegido, especifique el nombre de Usuario.
    5. Si el recurso está en un servidor protegido, especifique la Contraseña.
    6. Pulse Siguiente. El URL base que ha especificado se añade automáticamente con ?metadata=schema. Ejemplo: https://servidor:puerto/service/cq/records/defects?metadata=schema
    7. 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.

    El adaptador de Rational ClearQuest da soporte al filtrado nativo de orígenes de datos Reportable Rest v1. En los filtros de Reportable Rest v1, sólo es necesario especificar el texto entre corchetes []. Rational Publishing Engine genera el resto del filtro. Consulte Reportable Rest v1 para obtener más información.

    Rational ClearQuest versión 8 sin el adaptador admite el filtrado nativo de orígenes de datos de Reportable Rest v2. Para obtener más información, consulte API REST OSLC CM de Rational ClearQuest.

    Ejemplo de filtro de variable:
    cq:Product{cq:Product="${productName}") 
    Ejemplo de filtro resuelto, donde productName es Rational Publishing Engine:
    cq:Product{cq:Product="Rational Publishing Engine")
    Nota:
    • Las solicitudes se realizan a un origen de datos sólo cuando es necesario. Por ejemplo, puede utilizar condiciones para que un elemento se visualice en la salida sólo cuando contenga datos. La condición en un elemento de contenedor podría ser variable == "true". Si esta condición no se cumple y no hay datos que cumplan la condición de la variable, no se efectúan solicitudes al origen de datos.
    • Puede calcular los filtros nativos antes de realizar la petición. El filtro nativo se calcula en el punto donde se encuentra la consulta y utiliza los valores de variable de ese punto. Por tanto, puede realizar cálculos en la plantilla, que afectarán a los filtros nativos.
  8. Cree clasificaciones para organizar los datos en el informe.