문서 Export Custom 템플릿

Requirements Portal의 문서 Export Wizard를 사용하면 요구사항과 V&V 활동에서 편집 가능한 Microsoft Word *.docx 파일을 손쉽게 생성할 수 있습니다. 미리 정의된 템플릿을 사용하거나 직접 만든 템플릿을 업로드할 수 있습니다. 이 Wizard는 Jinja 템플릿 엔진을 활용하는 Python-Docx-Template 라이브러리를 기반으로 작동합니다. 이 두 도구를 함께 활용하면 Custom 템플릿을 만들 수 있습니다.

Python-Docx-Template 라이브러리

Python-Docx-Template 라이브러리는 Python-Docx 라이브러리의 기능을 확장하는 강력한 도구입니다. Jinja 템플릿 엔진을 통합하여 Word 파일 내에서 콘텐츠를 동적으로 생성할 수 있습니다. 즉, 변수, 반복문, 조건문을 사용하여 문서에 데이터를 즉시 채울 수 있습니다. Word 문서에 에스프레소 한 잔 같은 활력을 불어넣는 셈입니다.

서식 있는 텍스트 필드의 경우 Export 템플릿에서 r 접두사를 사용해야 합니다. 예를 들어 요구사항 텍스트 필드는 템플릿에 r requirement.text 형식으로 포함해야 합니다.

Export 템플릿 관리

Requirements Portal 인스턴스에서 사용할 수 있는 템플릿은 Settings – Export templates 페이지에 표시됩니다. 이 페이지에 액세스하려면 오른쪽 상단의  아이콘을 클릭하고, 표시되는 메뉴에서 Settings을 선택한 다음, 왼쪽 창의 목록에서 Export templates을 선택합니다.

  • 기본적으로 요구사항 문서 Export용 템플릿 3개와 V&V 활동 문서 Export용 템플릿 3개, 총 6개의 템플릿이 제공됩니다.

    • 요구사항 Export 템플릿에 대한 자세한 내용은 문서 Export 페이지를 참조하세요.

    • V&V 활동 Export 템플릿에 대한 자세한 내용은 문서 Export 페이지를 참조하세요.

  • 새 사용자 정의 템플릿을 추가하려면 페이지 왼쪽 상단의  버튼을 클릭합니다. 표시되는 Add template 창에서 Applicable objects 드롭다운을 사용하여 새 템플릿을 Requirements 또는 V&V Activities 중 어디에 적용할지 선택한 다음, Select template 영역에서 템플릿 파일을 선택합니다.

    대화 상자에서  버튼을 클릭하여 템플릿을 추가합니다. 추가된 템플릿은 Export templates 페이지의 목록에 표시되며, 문서 Export에 사용할 수 있습니다.

  • 모든 템플릿의 파일을 다운로드할 수 있습니다. 다운로드하려면 원하는 템플릿의 Name 열에서  버튼을 클릭하고 Download 명령을 선택합니다. 브라우저 설정에 따라 파일이 미리 지정된 위치에 자동으로 다운로드되거나, 하드 드라이브의 저장 위치를 선택하라는 메시지가 표시됩니다.

  • 사용자 정의 템플릿은 새 템플릿 파일로 덮어쓸 수 있습니다. 원하는 템플릿의 Name 열에서  버튼을 클릭하고, 표시되는 메뉴에서 Overwrite Template 명령을 선택합니다. 열리는 Overwrite template 창에서 템플릿의 적용 대상을 지정하고 새 파일을 선택합니다. I confirm I want to overwrite 옵션을 활성화하고  버튼을 클릭하여 작업을 완료합니다.

부록 – 요구사항 Export 템플릿의 데이터 객체 구조

Requirements Portal 인스턴스에서는 여러 기본 요구사항 Export 템플릿을 사용할 수 있습니다.

  • Specification Doc.docx – 이 템플릿은 문서 보기 기능과 유사한 형태로 요구사항을 생성하고 Export합니다.

  • Specification Table.docx – 기존 템플릿으로, 가장 중요한 요구사항 속성을 깔끔한 표 형식으로 제공합니다.

  • Requirement Traceability and Verification Matrix.docx – 이 템플릿을 사용하면 요구사항의 상위 항목, 하위 항목, 설계 참조 정보와 검증 및 유효성 확인의 의도 및 상태가 포함된 doc 파일을 생성할 수 있습니다.

  • Requirements Verification Matrix.docx – 이 템플릿을 사용하면 요구사항의 검증 및 유효성 확인 의도와 상태에 대한 정보가 포함된 doc 파일을 생성할 수 있습니다.

문서 작성 목적에 맞게 섹션을 자유롭게 추가, 제거 또는 수정하세요. 위에 나열된 순서대로 기본 템플릿 파일을 살펴본 후에는 보고서에 포함할 수 있는 정보의 범위를 더 넓혀 보고 싶어질 수 있습니다.

다음은 요구사항 Export 템플릿이 정보를 가져오는 객체의 기본 구조입니다.

필드 정렬

Jinja 템플릿 문서에서 Sort 함수를 사용하여 요구사항을 정렬할 수 있습니다. 예를 들어 |sort(attribute='identifier')을 추가하면 식별자 열을 기준으로 요구사항이 영숫자 순으로 정렬됩니다.

예:

{% for requirement in requirements|selectattr("specification_id", "equalto", specification.id)|selectattr("group_id", "none") |sort(attribute='identifier') -%}

Custom 열

현재 문서 Export 도구를 사용하면 Custom 열의 값을 손쉽게 Export할 수 있습니다. 단순한 텍스트 기반 Custom 열에는 다음과 같은 일반 구조를 사용할 수 있습니다.

{% for custom_field in requirement.custom_fields|selectattr(“field”, “equalto”, “Name of Custom Column”) %}{{r custom_field.value }}{% endfor %}

Name of Custom Column 텍스트를 열 머리글에 표시된 실제 열 이름으로 바꾸세요.

Custom 열이 텍스트 형식이 아니라 다중 선택 옵션인 경우, 다음 코드를 사용하고 용도에 맞게 수정할 수 있습니다.

{%- if requirement.custom_fields -%}
     {%- set additional_info_values = [] -%}
     {%- set category_values = [] -%}
     {%- set additional_info_custom_fields = requirement.custom_fields | selectattr('field', 'equalto', 'Additional Information') -%}
     {% for custom_field in additional_info_custom_fields -%}
      {%- set additional_info_values = additional_info_values + custom_field.value -%}
     {% endfor -%}
     {%- set category_custom_fields = requirement.custom_fields | selectattr('field', 'equalto', 'Category') -%}
     {% for custom_field in category_custom_fields -%}
           {%- set category_values = category_values + custom_field.value -%}
     {% endfor -%}
{%- set additional_info_string = additional_info_values | join(';') -%}
{%- set category_string = category_info_values | join(';') -%}
{%- endif -%}

부록 – V&V 활동 Export 템플릿의 데이터 객체 구조

Requirements Portal 인스턴스에서는 여러 기본 V&V 활동 Export 템플릿을 사용할 수 있습니다.

  • V&V Activity Document.docx – Export 대상으로 선택한 활동에 대한 정보를 포함합니다.

  • V&V Matrix.docx – Export 대상으로 선택한 활동과 요구사항 및 관련 블록 사이의 연결 정보를 포함합니다.

  • V&V Runs Document.docx – Export 대상으로 선택한 활동의 실행 정보를 포함합니다.

다음은 V&V 활동 Export 템플릿이 정보를 가져오는 객체의 기본 구조입니다.

AI-LocalizedAI로 번역됨
만약 문제가 있으시다면, 텍스트/이미지를 선택하신 상태에서 Ctrl + Enter를 누르셔서 저희에게 피드백을 보내주세요.
Contents
기능 가용성

사용할 수 있는 기능은 보유한 Altium 솔루션(Altium Develop, Altium Agile Teams, Altium Agile Enterprise, 또는 Altium Designer(활성 기간 중))에 따라 달라집니다.

실제 소프트웨어에서 문서화된 기능이 보이지 않는 경우, Altium 영업팀에 문의하여 자세한 내용을 확인하세요.

Contents