Rational ClearQuest를 데이터 소스로 사용하여 템플리트 디자인

보고서 디자이너는 Document Studio를 사용하여 데이터 소스 스키마를 가져오고 보고서 템플리트를 빌드할 수 있습니다.

시작하기 전에

팁: Rational® Publishing Engine 설치에는 샘플 보고서 세트가 포함됩니다. 문서 공개를 시작하기 전에 예제 문서 생성 시나리오를 탐색할 수 있습니다. REST 샘플 템플리트 작성을 참조하십시오.
Rational ClearQuest® REST 서비스 및 Rational Publishing Engine을 사용하여 Rational ClearQuest로부터 데이터를 추출하는 데 필요한 다양한 URL에 대해 익숙해져야 합니다. Rational ClearQuest Information Center 정보를 참조하십시오.

이 태스크 정보

REST API를 사용하여 데이터가 추출됩니다. 이 인터페이스는 데이터 소스 애플리케이션에 의해 설치되고 구현되며 Rational Publishing Engine과 별도로 작동합니다. 데이터 소스의 REST API에 대한 자세한 정보는 해당 데이터 소스의 문서를 참조하십시오.

프로시저

  1. 템플리트 개발 프로세스의 개요는 문서 템플리트 디자인의 내용을 검토하십시오. 문서의 구조 및 포함될 수 있는 데이터에 대한 계획을 시작하십시오. 예를 들어, 최종 문서가 하나의 템플리트에서 생성될지 또는 각각에 재사용 가능한 컨텐츠 조각이 포함된 여러 템플리트 파일에서 생성될지 결정하십시오.
  2. Document Studio 애플리케이션에서 문서 템플리트를 작성하십시오.
  3. 문서 템플리트에 데이터 소스 스키마를 추가하십시오. Rational ClearQuest의 경우 애플리케이션에 대한 기본 URL을 입력하여 데이터 소스 스키마를 발견할 수 있습니다.
    1. 사용자 버전의 Rational ClearQuest에 적용되는 스키마 발견 마법사를 여십시오.
      • REST v1을 사용하는 이전 버전의 Rational ClearQuest의 경우 데이터 > 스키마 발견 > REST 스키마 발견을 클릭하십시오.
      • REST v2를 사용하는 이후 버전의 Rational ClearQuest의 경우 데이터 > 스키마 발견 > REST v2 스키마 발견을 클릭하십시오.
    2. 자원의 기본 URL을 지정하십시오.
      • REST v1 버전의 Rational ClearQuest의 경우 Rational Publishing Engine은 Rational 데이터 서비스를 사용하여 스키마 및 조회 데이터를 발견합니다. 데이터 서비스에 대한 기본 URL은 다음과 같습니다. https://server:port/DataServices/ClearQuest
      • REST v2 버전의 Rational ClearQuest의 경우 ServiceProvider URL부터 시작합니다. Rational ClearQuest REST v2 ServiceCatalog URL을 방문하면 ServiceProvider URL을 얻을 수 있습니다. 예를 들어, https://server:port/context/oslc 등입니다. HTTP 헤더 OSLC-Core-Version을 2.0으로 설정하고 application/rdf+xml을 허용하십시오. 리턴되는 결과로부터 ServiceProvider URL rdf:about을 찾을 수 있습니다.
        REST v2 API를 사용하여 문서를 생성하는 경우 루트 항목이 아닌 서비스 제공자에게 데이터 소스 스키마 URL을 제공해야 합니다. 예:
        • 올바르지 않음: https://server:port/cqweb/oslc
        • 올바름: https://server:port/cqweb/oslc/repo/repository/db/schema_repository/
    3. 목록에서 인증 유형을 선택하십시오. 유형을 선택하지 않으면 올바른 유형이 발견될 때까지 각 유형이 테스트되어 문서 생성 시간이 증가할 수 있습니다.
    4. 자원이 보안 설정된 서버에 있는 경우 사용자 이름을 지정하십시오.
    5. 자원이 보안 설정된 서버에 있는 경우 비밀번호를 지정하십시오.
    6. 다음을 클릭하십시오. 입력한 기본 URL이 자동으로 ?metadata=schema와 함께 추가됩니다. 예: https://server:port/service/cq/records/defects?metadata=schema
    7. 완료를 클릭하십시오. 선택한 데이터 소스 스키마가 데이터 소스 스키마 보기에 표시됩니다.
  4. 템플리트에 요소를 추가하십시오. Rational Publishing Engine에는 문서를 구성하는 데 사용할 수 있는 종합적인 템플리트 요소 세트가 있습니다. 요소를 템플리트 컨텐츠 편집기로 끌어올 수 있습니다. 예를 들어, 여러 단락을 보유할 컨테이너 요소를 추가할 수 있습니다. 각 단락은 특정 데이터와만 연관시키는 테스트 조건으로 제어될 수 있습니다. 자세한 정보는 팔레트 보기의 템플리트 요소템플리트에 요소 추가를 참조하십시오.
  5. 데이터를 템플리트에 추가하려면 조회, 속성변수를 사용하십시오. 이러한 항목은 보고서에서 생성되는 정보의 조각을 지정합니다.
  6. 요소가 출력에 표시되는 방법을 제어하려면 형식 및 스타일을 요소에 추가하십시오.
  7. 보고서로 가져오는 데이터를 좁히려면 필터를 작성하십시오. Rational Publishing Engine이 보고서를 생성하는 동안 데이터 소스로부터 필요한 것보다 더 많은 정보를 검색하려고 시도하는 것을 방지하기 위해 일반 데이터 소스 URI의 보다 특정한 버전인 필터를 사용하여 데이터의 특정 서브세트를 지정할 수 있습니다. 이러한 필터는 템플리트에 의해 참조되는 필수 데이터를 모두 검색할 수 있을 정도의 범위여야 합니다. 그렇지 않으면 생성된 보고서가 전체 데이터를 포함할 수 없습니다.

    Rational ClearQuest 어댑터는 Reportable Rest v1 데이터 소스의 기본 필터링을 지원합니다. Reportable Rest v1 기본 필터에서는 대괄호 [] 사이에 텍스트를 입력하기만 하면 됩니다. 나머지 필터는 Rational Publishing Engine에서 생성됩니다. 자세한 정보는 Reportable REST v1의 내용을 참조하십시오.

    어댑터가 없는 Rational ClearQuest 버전 8은 Reportable Rest v2 데이터 소스의 기본 필터링을 지원합니다. 자세한 정보는 Rational ClearQuest OSLC CM REST API 를 참조하십시오.

    샘플 변수 필터:
    cq:Product{cq:Product="${productName}") 
    Sample resolved filter where the productName is Rational Publishing Engine:
    cq:Product{cq:Product="Rational Publishing Engine")
    참고:
    • 데이터 소스에 대한 요청은 필요한 경우에만 작성됩니다. 예를 들어, 요소가 데이터를 포함하는 경우에만 출력에 표시되도록 조건을 사용할 수 있습니다. 컨테이너 요소에 대한 조건은 variable == "true"일 수 있습니다. 이 조건이 충족되지 않고 데이터가 변수 조건을 충족하지 않는 경우, 데이터 소스에 대한 요청이 작성되지 않습니다.
    • 요청을 작성하기 전에 기본 필터를 계산할 수 있습니다. 기본 필터는 조회가 발견된 시점에 계산되며 해당 시점의 변수값을 사용합니다. 따라서 템플리트에서 계산을 수행할 수 있으며 이는 기본 필터에 영향을 미칩니다.
  8. 보고서에서 데이터를 구성하려면 정렬을 작성하십시오.

피드백