스키마 발견 마법사를 사용하여 REST 데이터 소스 스키마 추가

REST 데이터 소스에 대한 데이터 소스 스키마를 작성할 수 있습니다. 스키마를 작성하면 동일한 구조 및 동일하거나 비슷한 속성 목록을 가진 모듈에 대한 문서 템플리트 작성이 단순화됩니다.

이 태스크 정보

스키마 발견 마법사를 사용하여 데이터 소스 스키마를 작성하는 경우에는 애플리케이션이 지원하는 두 가지 Reportable REST 옵션(REST API 1.0 또는 REST API 2.0) 중에서 선택할 수 있습니다. 애플리케이션이 지원하는 REST API 버전을 모르는 경우에는 시스템 관리자에게 확인하십시오.

스키마 발견(REST API 1.0)

프로시저

  1. Document Studio에서 데이터 > 스키마 발견 > REST 스키마 발견을 클릭하십시오.
  2. 연결 세부사항을 지정하십시오.
    1. 데이터 소스에 대한 이름을 입력하십시오.
    2. 데이터 소스에 대한 설명을 입력하십시오.
    3. 자원의 기본 URL을 지정하십시오.
    4. 목록에서 인증 유형을 선택하십시오. 유형을 선택하지 않으면 올바른 유형이 발견될 때까지 각 유형이 테스트됩니다. 유형을 지정하면 이 프로세스가 제거될 수 있습니다.
    5. 자원이 보안 설정된 서버에 있는 경우 사용자 이름을 지정하십시오.
    6. 자원이 보안 설정된 서버에 있는 경우 비밀번호를 지정하십시오.
  3. 다음을 클릭하십시오.
  4. 데이터 소스가 데이터 서비스를 사용하는지 여부에 따라 다음 창 중 하나가 표시됩니다.

    데이터 소스가 데이터 서비스를 사용하지 않는 경우 자원 작성 창이 표시됩니다.

    1. 새 자원에 대한 이름을 입력하십시오.
    2. 새 자원에 대한 설명을 입력하십시오.
    3. 새 자원에 대한 상대 경로를 입력하십시오.
    보고 데이터 서비스 어댑터를 통해 REST 데이터 소스에 액세스할 수 있는 경우 데이터 서비스를 사용하여 찾기 창이 표시됩니다.
    1. XML 스키마 트리에서 요소를 선택하십시오.
    2. 속성 목록에서 href 값을 선택하십시오.
    3. 다음을 클릭하십시오. 선택한 자원의 자원 URL이 표시됩니다.
  5. URL을 선택한 후 완료를 클릭하거나 URL을 사용하여 하위 자원을 찾으십시오. 하위 자원을 찾으려면 다음을 수행하십시오.
    1. 자원 URL을 선택한 후 다음을 클릭하십시오.
    2. XML 스키마 분할창에서 요소를 선택하십시오.
    3. 속성 목록에서 href를 선택하십시오.
  6. 하위 자원을 찾은 경우 완료를 클릭하십시오. 마법사가 완료되고 URL이 구성 창에 표시됩니다. 자원이 보안 설정된 서버에 있는 경우 구성 창에서 사용자 이름 및 비밀번호를 입력하십시오.

스키마 발견(REST API 2.0)

이 태스크 정보

참고: Rational® Publishing Engine은 간략화된 RDF만 지원합니다. 제공자는 application/xml 요청을 승인하고 존중해야 합니다. Open Services for Lifecycle Collaboration Core Specification 버전 2.0을 참조하십시오.
Rational Publishing EngineReportable REST v2 스펙을 따르는 OSLC v2 제공자만 지원합니다.
  • OSLC 서비스에는 보고를 위한 모든 자원에 대한 서비스 자원에 조회 기능이 정의되어 있어야 합니다.
  • 보고를 위한 각각의 조회 기능:
    • 보고를 위한 자원 목록이 포함된 자원을 가리키는 oslc:queryBase를 가지고 있어야 합니다. 목록에 있는 자원은 목록 자원의 자원 모양 자원에서 oslc:isMemberProperty로 식별되어야 합니다.
    • 목록 자원에 대해 설명하는 데 필요한 oslc:resourceShape를 가지고 있어야 합니다.

프로시저

  1. 데이터 > 스키마 발견 > REST v2 스키마 발견을 클릭하십시오.
  2. 연결 세부사항을 지정하십시오.
    1. 자원의 기본 URL을 지정하십시오.
      승인할 서비스 제공자의 URL을 알고 있어야 합니다. 이 URL은 Reportable REST 데이터 소스에 대한 보고 데이터 서비스 애플리케이션 URL에 대응합니다. Rational Publishing Engine은 데이터 소스의 데이터를 조회 목록으로 페치합니다. 이 자원은 데이터를 조회하고 해석할 수 있는 서비스에 의해 저장됩니다. 이 서비스는 설정된 조건에 따라 데이터를 필터링하거나 데이터의 서브세트를 세분화하는 데 도움이 되는 조회 서비스도 제공합니다. 이 조회는 한 유형의 자원을 위한 것이며 이를 통해 특정 유형의 자원에 액세스할 수 있습니다. 보고 가능한 ID2 서비스는 제품 또는 사용자 변경 요청과 같은 다수의 자원 유형을 노출할 수 있습니다. 조회 서비스는 사용자가 데이터 또는 데이터의 서브세트를 효율적으로 검색하는 데 도움이 되지만 필수는 아닙니다. 모든 자원에 대해 조회 서비스가 존재합니다. 모든 제품은 자원과 이 자원에 액세스하는 조회를 정의할 수 있습니다.
    2. 목록에서 인증 유형을 선택하십시오.
    3. 자원이 보안 설정된 서버에 있는 경우 사용자 이름을 지정하십시오.
    4. 자원이 보안 설정된 서버에 있는 경우 비밀번호를 지정하십시오.
  3. 다음을 클릭하십시오.
  4. REST v2 서비스 및 해당 조회를 선택한 후 다음을 클릭하십시오. 선택한 서비스의 특성이 표시됩니다.
  5. 목록에서 필요한 특성을 선택한 후 oslc.select 테스트를 클릭하십시오. 결과 확인 창에 선택한 서비스가 표시됩니다. 서비스가 올바른지 확인하십시오. 정정을 클릭하면 oslc.select 테스트 필드 상태가 true로 변경됩니다. 다음을 클릭하십시오.

    oslc.properties 테스트 필드는 자주 사용되지 않습니다.

  6. 조회에 oslc.where 절 포함조회에 oslc.orderBy 절 포함에는 조회의 필터 또는 정렬 절(예: cq:Product{cq:Product="Rational Publishing Engine"})만 입력해야 합니다.
  7. oslc.where 테스트oslc.orderBy 테스트를 클릭하여 연결을 확인하십시오. Rational Publishing Engine은 정의된 옵션을 사용하여 전체 요청을 작성합니다.
  8. 다음을 클릭하십시오. 조회의 요약이 표시됩니다. 완료를 클릭하십시오. 마법사가 완료되고 URL이 구성 창에 표시됩니다. 자원이 보안 설정된 서버에 있는 경우에는 구성 창에서 사용자 이름 및 비밀번호를 제공할 수 있습니다.

피드백