핵심 데이터 정의

핵심 데이터 정의(CDD)는 전체 스터디 설계의 하위 집합입니다.구체적으로, Vault EDC에서 생성되어 스터디 데이터 분석에 사용되는 중요한 데이터 내보내기에 영향을 미치는 필드를 설명하는 것이 목적입니다.

CDD를 사용하든 사용하지 않든, 조직은 상류 시스템(예: MDR)에서 스터디 설계의 시작을 자동화할 수 있습니다.이 모델에서는 다음과 같은 EDC API가 사용됩니다.

  • 스터디 마스터 생성
  • 이벤트 그룹 생성
  • 이벤트 생성
  • 라이브러리 또는 다른 스터디에서 (여러) 양식 복사
  • 해당 이벤트 그룹 / 이벤트 / 양식의 일정 정렬

이 자동화를 보완하기 위해 소스 설계 시스템은 새로 생성된 해당 스터디 / 사례집 버전 1에 CDD를 업로드할 수도 있습니다.그런 다음 CDD가 적용되어 일반적인 스터디 설계 수명 주기를 진행함에 따라 스터디 의도(CDD) 대 실제 스터디 설계의 비교를 수행합니다.CDD와 스터디 설계의 비교는 Studio 검증 작업(Studio Validations job)이 실행될 때마다 수행됩니다.

이 정의는 JSON 형식이며 스터디 설계의 사례집 버전에 파일로 첨부됩니다.CDD는 역시 JSON 형식인 사례집 설계 내보내기(CDE)의 하위 집합입니다.이 하위 집합은 정렬된 스터디 일정의 컨텍스트 내에서만 다양한 EDC 설계 구조(이벤트 그룹, 이벤트, 양식, 항목 그룹, 항목, 코드리스트, 단위)의 중요한 속성입니다.전체 구조에 대한 자세한 내용은 EDC API 참조를 확인하십시오.

CDD 버전 관리: 핵심 데이터 정의 파일은 필요에 따라/필요할 때 각 사례집 버전에 첨부됩니다.새 사례집 버전을 생성하더라도 해당 파일이 이월되지 않습니다.이후 버전에서 비교를 계속하려면 적절한 변경 사항이 포함된 업데이트된 CDD를 새 사례집 버전에 업로드해야 합니다.

전제 조건

필요한 권한

CDMS 스터디 설계자(CDMS Study Designer) 및 CDMS 라이브러리 관리자(CDMS Librarian) 표준 스터디 역할을 가진 사용자는 기본적으로 아래 설명된 작업을 수행할 수 있습니다.조직에서 커스텀 스터디 역할을 사용하는 경우, 역할에서 다음 권한을 부여해야 합니다.

유형(Type) 권한 레이블 제어
표준 탭 Studio 탭

Studio 탭에 접근할 수 있는 기능
표준 탭 라이브러리 탭

라이브러리(Library) 탭에 접근할 수 있는 기능
기능적 권한 스터디 디자인 보기

스터디 디자인에 대한 보기 전용 접근권한
기능적 권한 스터디 디자인

Studio에서 스터디 디자인 정의 및 스터디 일정을 생성할 수 있는 기능
기능적 권한 라이브러리 보기

Studio > 라이브러리에서 라이브러리 수집 및 설계를 볼 수 있는 기능
기능적 권한 라이브러리 설계

Studio > 라이브러리에서 수집 스터디 디자인 정의와 스터디 일정을 생성할 수 있는 기능
기능적 권한 API 액세스

Vault EDC API에 접근하고 이를 사용할 수 있는기능(CDB를 사용하기 위해서도 이 권한 필요)

스터디 역할에 대해 자세히 알아보십시오.

핵심 데이터 정의 관리(Studio)

EDC API를 사용하여 조직에서 CDD 관리를 자동화할 가능성이 높지만, Studio 사용자 인터페이스, 스터디 또는 라이브러리 컬렉션 내에서 파일을 관리하는 기능도 있습니다.

핵심 데이터 정의 액세스

사례집 버전의 핵심 데이터 정의에 액세스하려면:

  1. Studio에서 스터디로 이동합니다.
  2. 필요한 경우 해당 설계의 적절한 사례집 버전으로 이동하십시오(최신 버전이 아닌 경우).
  3. 작업 메뉴()에서 핵심 데이터 정의 (JSON) 관리(Manage Core Data Definition (JSON))를 선택하십시오.
  4. 두 가지 가능한 모달 대화 상자가 나타납니다.

    • 사례집 버전에 연결된 CDD가 없는 경우:

    • 사례집 버전에 연결된 CDD가 있는 경우:

  5. 기존 사례집 버전에 연결된 CDD 파일이 있는 경우 파일 이름을 클릭하여 다운로드하십시오.

핵심 데이터 정의 파일 업로드(Studio)

사례집 버전에 대한 CDD 파일을 추가하려면:

  1. Studio에서 스터디로 이동합니다.CDD 추가 또는 삭제는 최신 사례집 버전에서만 허용됩니다.
  2. 작업 메뉴()에서 핵심 데이터 정의 (JSON) 관리(Manage Core Data Definition (JSON))를 선택하십시오.
  3. 사례집 버전에 연결된 기존 파일이 이미 있는 경우 먼저 제거해야 합니다.다음 섹션인 핵심 데이터 정의 파일 삭제(Deleting Core Data Definition File)를 참조하고 이 단계로 돌아오십시오.
  4. 대화 상자에 연결된 CDD 파일이 없는 것으로 표시됩니다.
  5. 파일 선택(Select File)을 클릭하고 파일을 찾아 선택하십시오.선택한 파일이 나타납니다.선택한 파일이 의도한 파일이 아닌 경우 파일 이름 옆에 있는 X를 클릭하고 다른 파일을 선택하십시오.파일이 JSON 형식이 아닌 경우 대화 상자에 오류가 표시되고 저장이 방지됩니다.
  6. 저장을 클릭하여 해당 파일을 사례집 버전에 연결하십시오.

핵심 데이터 정의 파일 삭제(Studio)

  1. Studio에서 스터디로 이동합니다.CDD 추가 또는 삭제는 최신 사례집 버전에서만 허용됩니다.
  2. 작업 메뉴()에서 핵심 데이터 정의 (JSON) 관리(Manage Core Data Definition (JSON))를 선택하십시오.
  3. 기존 CDD가 파일 이름으로 표시됩니다.파일 이름 옆에 있는 휴지통 옵션을 클릭하십시오.
  4. 해당 작업은 파일이 삭제될 것임을 나타내지만, 저장을 클릭해야만 실제로 삭제됩니다.저장을 클릭합니다.
  5. 이 시점에서 핵심 데이터 정의 관리 옵션에 다시 액세스하여 업데이트된 버전을 업로드하십시오.

핵심 데이터 정의 파일은 필요에 따라 각 사례집 버전에 첨부됩니다.Veeva EDC는 이 파일의 이전 버전을 저장하지 않으며 마지막으로 업로드된 버전만 연결됩니다.

핵심 데이터 정의 검증 실행

시스템의 스터디 설계와 CDD의 비교는 Studio 검증 작업의 일부로 수행됩니다.

Studio에서 검증 작업을 실행하려면:

  1. Studio에서 스터디로 이동합니다.
  2. 작업 메뉴()에서 검증(Validate)을 선택하십시오.최근에 스터디가 검증 작업을 거쳤고 변경되지 않은 경우 해당 옵션이 표시되지 않습니다.
  3. 사례집 버전에 CDD가 연결되어 있으면 작업을 실행하기 위한 옵션이 나타납니다.연결된 CDD가 없는 경우 이러한 옵션은 표시되지 않습니다.
  4. 스터디 설계와 핵심 데이터 정의 추가 비교에 대해 CDD를 스터디와 비교하는 것이 기본값입니다.아니요를 선택하면 두 번째 옵션이 적용되지 않습니다.
  5. 핵심 데이터 정의 오류가 발견된 경우 검증됨 상태 방지(Prevent Validated Status when Core Data Definition Errors are Found) 옵션을 사용하여 CDD와 스터디를 비교할 때 발견된 중요한 차이점이 사례집 버전을 검증됨(validated) 상태로 이동하는 것을 차단해야 하는지 여부를 나타내십시오.

비교를 실행하고 검증 상태로의 이동을 차단하기 위한 기본값은 일반적으로 수행되어야 합니다.조직 내에서 언제, 누가 이러한 우회 옵션을 사용할 수 있어야 하는지 고려하십시오.선택한 항목은 저장되어 EDC 도구(EDC Tools) > 작업 내역(Job History) 영역에 표시됩니다.

실제 비교 및 경고와 오류 유형을 구성하는 요소에 대해서는 아래의 핵심 데이터 정의 검증 섹션을 참조하십시오.

이 작업 실행 결과는 두 개의 CSV(하나는 CDD 비교와 관련된 오류/경고, 다른 하나는 Studio의 나머지 검증 확인용)가 포함된 ZIP 파일입니다.

마지막 섹션에 설명된 작업을 수행하는 EDC API는 다음과 같습니다.

EDC API / 작업(Action) Studio 동등 단계 메모
핵심 데이터 정의 파일 업로드 핵심 데이터 정의 검증 업로드(Studio) 이 API에 대한 매개변수를 사용하여 교체할 수 있습니다(즉, 하나의 API 호출로 삭제 및 새 파일 업로드).
핵심 데이터 정의 파일 삭제 핵심 데이터 정의 파일 삭제(Studio)  
핵심 데이터 정의 파일 검색 핵심 데이터 정의 액세스 이 API는 API를 통해 첨부된 JSON 파일을 스트리밍합니다. 현재 이 엔드포인트는 '사례집 버전에 연결된 CDD가 있습니까?'를 감지하는 유일한 방법입니다.
작업 시작(Studio 검증) 핵심 데이터 정의 검증 실행 작업을 시작하기 위해 적용 가능한 유형은 design_validations__v입니다. 작업에서 결과를 검색하는 것은 다른 작업 유형과 동일한 방법을 따릅니다.

예제를 포함하여 각 엔드포인트에 대한 전체 세부 정보는 EDC API 참조를 확인하십시오.

핵심 데이터 정의 검증

방법론

사례집 버전에 첨부된 CDD와 Veeva EDC 스터디의 실제 스터디 설계를 비교하기 위한 주요 기준은 다음과 같습니다.

  • CDD에는 존재하지만 Studio의 스터디 설계에는 존재하지 않는 주요 구성 요소(이벤트 그룹, 양식, 코드리스트 선택 항목 등) → 오류
  • Studio의 스터디 설계에는 존재하지만 CDD에는 존재하지 않는 주요 구성 요소(이벤트 그룹, 양식, 코드리스트 선택 항목 등) → 경고
  • 속성에 따라 다름
  • 모든 설계 수준에서의 일치는 설계 이름에 의해 수행됩니다.(예: 이상 사례 양식의 "AE").일반적으로 양식 설계 이름은 내보내기 테이블/파일의 이름이 되는 반면, 아이템의 이름은 내보내기 테이블/파일의 열 이름이 됩니다.
  • 다른 모든 Studio 검증 확인과 마찬가지로 다음 사항이 적용됩니다.
    • 경고는 검증됨 사례집 버전 상태로의 이동을 차단하지 않습니다.
    • 오류는 검증됨 사례집 버전 상태로의 이동을 차단합니다.
  • CDD의 일반적인 구조는 전체 스터디 설계(CDE)의 하위 집합입니다.비교 목적으로 전체 CDE를 업로드할 수 있지만 아래 나열된 필드만 비교됩니다.

CDD 구조 요약

CDD 구조에는 상위 수준의 스터디 속성과 4개의 주요 섹션이 포함됩니다.

  • eventgroup_def는 스터디의 정렬된 일정입니다.즉, 이벤트 그룹, 각각에 포함된 이벤트, 해당 이벤트에 포함된 양식입니다.
  • form_def에는 스터디 일정(eventgroup_def 섹션) 내의 어딘가에서 사용되는 각 양식에 대한 아이템이 포함됩니다.양식의 아이템 그룹, 해당 아이템 그룹의 아이템, 그리고 아이템이 할당된 코드리스트 또는 단위 정의를 사용하는 위치.
  • unit_def에는 스터디 설계 어딘가에서 하나 이상의 아이템이 사용하는 각 단위 정의에 대한 아이템이 포함됩니다.이 아이템에서는 단위 선택이 추가로 정의됩니다.
  • codelist_def에는 스터디 설계 어딘가에서 하나 이상의 아이템이 사용하는 각 코드리스트에 대한 아이템이 포함됩니다.이 아이템에서는 코드리스트의 선택 사항이 추가로 정의됩니다.

필드별

CDD 전반에 걸쳐 수행되는 비교는 Studio 검증 작업 중에 발생합니다.이러한 비교는 오류 또는 경고로 분류됩니다(아래 표 참조).Vault는 또한 발생한 문제 ID 값 내에 유형을 나타냅니다(오류의 경우 "E", 경고의 경우 "W").

JSON 위치 메모
study_name_production 프로덕션의 현재(또는 예상되는) 스터디 레이블 지정
version 스터디 설계에서 비교 중인 사례집 버전과 일치해야 합니다. 이들이 다를 경우 경고가 발생하지만 비교는 계속됩니다.
(스터디의 정렬된 일정: 포함된 이벤트 그룹)  
eventgroup_def/name 이것이 일치하는 아이템, 즉 '양쪽 모두에 있음'을 의미합니다.
eventgroup_def/label 다를 경우 경고
eventgroup_def/repeat_maximum 다를 경우 오류. 이벤트 그룹이 반복되지 않으면 '1'이 됩니다.
eventgroup_def/external_id 다를 경우 경고
eventgroup_def/event_def 이 이벤트 그룹의 경우, 그룹에 포함된 이벤트
(스터디의 정렬된 일정: 각 이벤트 그룹의 이벤트)  
eventgroup_def/event_def/name 이것이 일치하는 아이템, 즉 '양쪽 모두에 있음'을 의미합니다.
eventgroup_def/event_def/label 다를 경우 경고
eventgroup_def/event_def/external_id 다를 경우 경고
eventgroup_def/event_def/ 이 이벤트의 경우, 이벤트에 포함된 양식
(스터디의 정렬된 일정: 각 이벤트 내의 양식)  
eventgroup_def/event_def/form_def/name 이것이 일치하는 아이템, 즉 '양쪽 모두에 있음'을 의미합니다.
eventgroup_def/event_def/form_def/label 다를 경우 경고
eventgroup_def/event_def/form_def/repeat_maximum 다를 경우 오류. 양식이 반복되지 않으면 '1'이 됩니다.
eventgroup_def/event_def/form_def/external_id 다를 경우 경고
(양식 정의: 주요 속성)  
form_def/name 이것이 일치하는 아이템, 즉 '양쪽 모두에 있음'을 의미합니다.
form_def/label 다를 경우 경고
form_def/repeat_maximum 다를 경우 오류. 양식이 반복되지 않으면 '1'이 됩니다.
form_def/external_id 다를 경우 경고
form_def/itemgroup_def/ 이 양식의 경우, 양식에 포함된 아이템 그룹
(양식 정의: 양식 내 아이템 그룹, 정렬됨)  
form_def/itemgroup_def/name 이것이 일치하는 아이템, 즉 '양쪽 모두에 있음'을 의미합니다.
form_def/itemgroup_def/label 다를 경우 경고
form_def/itemgroup_def/repeat_maximum 다를 경우 오류. 양식이 반복되지 않으면 '1'이 됩니다.
form_def/itemgroup_def/external_id 다를 경우 경고
form_def/itemgroup_def/item_def/ 이 아이템 그룹의 경우, 그룹에 포함된 아이템
(양식 정의: 양식의 아이템 그룹 내 아이템, 정렬됨)  
form_def/itemgroup_def/item_def/name 이것이 일치하는 아이템, 즉 '양쪽 모두에 있음'을 의미합니다.
form_def/itemgroup_def/item_def/external_id 다를 경우 경고
form_def/itemgroup_def/item_def/label 다를 경우 경고
form_def/itemgroup_def/item_def/data_type 다를 경우 오류. 예: text__v, integer__v, float__v 등.
form_def/itemgroup_def/item_def/precision 다를 경우 오류. Float로 정의된 아이템의 경우 허용되는 '소수점 이하' 자릿수
form_def/itemgroup_def/item_def/length 다를 경우 오류
form_def/itemgroup_def/item_def/codelist_def 다를 경우 오류. 아이템이 코드리스트 유형인 경우, 아이템이 사용하는 코드리스트 정의(선택 사항은 이후 섹션에서 정의됨)
form_def/itemgroup_def/item_def/unit_def 다를 경우 오류. 아이템이 단위 유형인 경우, 아이템이 사용하는 단위 정의(단위 선택은 이후 섹션에서 정의됨)
form_def/itemgroup_def/item_def/allow_unknown_day 다를 경우 오류
form_def/itemgroup_def/item_def/allow_unknown_month 다를 경우 오류
form_def/itemgroup_def/item_def/allow_unknown_time 다를 경우 오류
(단위 정의)  
unit_def/name 이것이 일치하는 아이템, 즉 '양쪽 모두에 있음'을 의미합니다.
unit_def/external_id 다를 경우 경고
unit_def/choice/ 이 단위 정의의 경우, 허용되는 단위 선택
unit_def/choice/name 이것이 (선택 사항에 대해) 일치하는 아이템, 즉 '양쪽 모두에 있음'을 의미합니다.
unit_def/choice/label 다를 경우 경고
unit_def/choice/external_id 다를 경우 경고
(코드리스트 정의)  
codelist_def/name 이것이 일치하는 아이템, 즉 '양쪽 모두에 있음'을 의미합니다.
codelist_def/external_id 다를 경우 경고
codelist_def/choice/ 이 단위 정의의 경우, 허용되는 단위 선택
codelist_def/choice/code 이것이 (선택 사항에 대해) 일치하는 아이템, 즉 '양쪽 모두에 있음'을 의미합니다.
codelist_def/choice/label 다를 경우 경고
codelist_def/choice/external_id 다를 경우 경고

문제 ID

가능한 문제 ID와 발생 시기는 다음과 같습니다.출력의 요약 및 설명 열은 문제를 추가로 설명하고 어떤 설계 엔터티/속성이 관련되어 있는지 나타냅니다.

발생한 문제 ID 발생 시기/참고
DDE-001 파일 구조가 유효하지 않으며, 마지막 섹션에 설명된 영역을 준수하지 않습니다.
DDW-002 CDD에 스터디 일정이 없으며 비교할 양식, 코드리스트 및 단위 정의만 있습니다.
DDE-003 프로덕션에 예상되는 스터디 이름
DDW-004 스터디 설계와 연결된 파일이 비교 대상(스터디 설계)과 다른 사례집 버전(포함됨)을 가지고 있는 것으로 보입니다.다른 모든 비교는 계속 진행되며, 이는 경고로만 기록됩니다.
DDE-099 이러한 검증를 실행하려는 시도와 관련된 일반적인 오류입니다.추가 조사를 위해 지원팀 연락처가 필요할 수 있습니다.
DDE-101 엔터티(이벤트 그룹, 이벤트, 양식 등)가 스터디 설계에는 있지만 CDD에는 없습니다.
DDW-102 엔터티(이벤트 그룹, 이벤트, 양식 등)가 CDD에는 있지만 스터디 설계에는 없습니다.
DDE-103 엔터티(이벤트 그룹, 이벤트, 양식 등)가 양쪽 모두에 있지만 중요한 속성이 다릅니다.
DDW-104 엔터티(이벤트 그룹, 이벤트, 양식 등)가 양쪽 모두에 있지만 덜 중요한 속성이 다릅니다.