보고서

개요

보고서 서식 작성 및 생성 기능은 정기적인 데이터 보고, 분석 결과 요약, 의사결정에 필요한 자료를 자동으로 생성하는 데 활용됩니다.

사용자는 미리 정의한 서식에 따라 쿼리문으로 데이터를 가공하고, 이를 기반으로 테이블, 차트, 텍스트 등의 구성 요소를 배치하여 보고서를 생성할 수 있습니다.

이 기능을 통해 반복적인 보고 작업을 자동화하고, 분석 결과를 일관된 형식으로 신속하게 공유할 수 있습니다.

보고서 서식 목록 조회

분석 > 보고서 메뉴에서 보고서 서식 목록을 조회하거나 검색할 수 있습니다.

보고서 서식 목록

  • 그룹: 보고서 서식이 속한 분류 그룹. 좌측 트리에서 그룹별로 조회하거나 검색할 수 있습니다.
  • 이름: 보고서 서식의 이름
  • 설명: 보고서 서식에 대한 설명
  • 소유자: 보고서 서식을 생성한 사용자 계정
  • 수정일: 보고서가 마지막으로 수정된 날짜 또는 생성일
  • 보고서: 해당 서식을 기준으로 보고서를 생성하거나 지정한 날짜의 보고서를 조회할 수 있는 버튼입니다.

목록에서 특정 보고서 서식을 찾으려면 도구 모음에 있는 검색창을 사용하세요. 입력한 단어가 이름, 설명에 포함된 보고서 서식이 조회되며, 검색은 대소문자를 구분하지 않습니다.

보고서 서식 생성

보고서 서식을 생성하려면,

  1. 보고서 목록 우측 상단에서 추가 버튼을 클릭하세요.
  2. 공통 설정항목 설정을 입력하고 확인 버튼을 클릭하세요.
Note
보고서 서식 그룹을 선택한 상태에서 서식을 생성하면 해당 그룹에 보고서 서식이 등록됩니다. 그룹을 선택하지 않고 생성하면 "미분류"로 표시됩니다.
공통 설정

공통 설정 섹션에서 보고서의 기본 정보를 설정하세요.

보고서 서식 - 공통 설정

  • 이름: 보고서 서식의 이름을 입력하세요(최대 50자).
  • 설명: 보고서 서식에 대한 설명을 입력하세요(최대 2,000자).
항목 설정

보고서 서식 항목을 추가하세요. 여러 개의 내용을 구성하려면 항목 추가 버튼을 클릭하세요.

보고서 서식 - 항목 추가

  • 유형: 항목의 유형을 선택하세요.
    • 단락: 보고서 서식에 텍스트 형태의 내용을 삽입하려면 단락을 선택하세요. 쿼리 결과의 line 필드 값을 문단 형식으로 표시합니다. 레코드가 여러 개일 경우, 각 문단이 순차적으로 나열됩니다.
    • : 보고서 서식에 표 형태의 내용을 삽입하려면 표를 선택하세요. 쿼리 결과를 표 형태로 표시합니다. 출력 순서는 쿼리 결과에 따라 결정되며, fieldsorder 명령어로 조정할 수 있습니다.
    • 메모: 보고서 서식에 메모 형태의 내용을 삽입하려면 메모를 선택하세요. 쿼리 결과의 line 필드 값을 외곽선 박스 안의 메모 형식으로 표시합니다. 레코드가 여러 개일 경우, 각 메모가 개별 메모로 표시됩니다.
    • 그래프: 보고서 서식에 차트를 삽입하려면 그래프를 선택하세요.
      • 차트는 쿼리 결과에 따라 독립 변수 필드(X축)와 종속 변수 필드(Y축)를 자동으로 인식해 생성됩니다.
        • 독립 변수 필드: 차트의 기준 필드(날짜, 문자열, IP 주소 유형 필드)
        • 종속 변수 필드: 독립 변수에 대해 표시할 값 필드(정수, 실수 유형 필드)
      • 쿼리 결과에서 독립 변수가 될 수 있는 필드는 반드시 1 개만 존재해야 하며, 종속 변수로 지정 가능한 컬럼은 1 개 이상 있어야 합니다.
      • 단, 파이 차트의 경우 종속 변수 필드는 반드시 1개이어야 합니다.
  • 제목: 항목의 제목을 입력하세요. 보고서 내 소제목으로 사용되며, 필요 시 생략할 수 있습니다.
  • 쿼리: 해당 항목에 표시할 데이터를 쿼리문으로 작성하세요(최대 2,000자).
    • $("from"), $("to") 매개변수를 활용하면 특정 기간에 대한 데이터를 처리할 수 있습니다. 보고서 생성에 입력된 기간이 해당 매개변수로 전달됩니다.
    • 쿼리 입력 후, 테스트 버튼을 클릭하면 새 창에서 쿼리 실행 결과를 확인할 수 있습니다. 쿼리를 입력해야 테스트 버튼이 활성화됩니다.
도구 모음

도구 모음을 사용하여 보고서 항목을 효율적으로 관리할 수 있습니다.

보고서 서식 도구 모음

도구 왼쪽부터 다음과 같습니다.

  • 표시/숨김: 보고서 생성 시 해당 항목의 표시 여부를 설정. Alt 키를 누른 채 클릭하면 모든 항목의 표시/숨김 상태를 일괄 변경할 수 있습니다.
  • 항목 순서 이동: 해당 항목의 순서를 위/아래로 이동. Alt 키를 누르고 클릭하면 가장 위나 아래로 옮길 수 있습니다.
  • 삭제: 해당 항목을 삭제. ALT 키를 누르고 클릭하면 모든 항목을 삭제할 수 있습니다.

보고서 서식 수정

보고서 서식을 수정하려면,

  1. 보고서 서식 목록에서 수정할 서식의 이름을 클릭하세요.
  2. 보고서 서식 수정 화면에서 보고서 서식의 공통 설정항목 설정을 수정하고 확인 버튼을 클릭해 변경 사항을 저장하세요.

보고서 생성 및 조회

웹 콘솔에서 보고서 조회

보고서 서식을 기반으로 지정한 날짜의 데이터를 조회할 수 있습니다.

  1. 보고서 서식 목록에서 조회할 보고서 서식 행의 조회 버튼을 클릭하세요.

    보고서 생성 시작

  2. 보고서 조회 화면 상단에서 조회할 날짜를 설정한 후 실행 버튼을 클릭하세요. 지정한 날짜의 데이터를 바탕으로 보고서가 생성되어 미리보기 화면에 표시됩니다.

    보고서 생성 실행

  3. 생성된 보고서는 화면 오른쪽 상단의 다운로드 버튼을 클릭하여 Word 문서 (docx), 한글 문서 (hwpx), 웹 문서 (html), PDF 중에서 원하는 형식으로 다운로드할 수 있습니다.

    보고서 다운로드

쿼리 기반 보고서 생성 및 조회

sonar-send-report 명령을 사용하면 쿼리로 직접 보고서를 생성하여 이메일로 발송할 수 있습니다. 예약된 쿼리 기능과 함께 활용하면 주기적인 자동 보고서 발송이 가능합니다.

sonar-send-report 명령을 사용할 때는 사용하려는 보고서 서식의 GUID가 필요합니다. GUID는 보고서 서식 목록에서 보고서 이름을 클릭했을 때 웹 브라우저 주소창에서 확인할 수 있습니다.

보고서 서식의 GUID 확인

보고서 서식 삭제

보고서 서식을 삭제하려면,

  1. 보고서 서식 목록에서 삭제할 보고서 서식을 선택하세요.
  2. 목록 우측 상단의 삭제 버튼을 클릭하세요.
  3. 보고서 서식 삭제 대화상자에서 삭제할 보고서 서식을 확인하고 삭제 버튼을 클릭하세요.

보고서 서식 그룹 관리

보고서 서식 그룹은 등록한 보고서 서식을 분류하고 관리하는 데 사용됩니다.

보고서 서식 그룹 추가

보고서 서식 그룹을 추가하려면,

  1. 분석 > 보고서 화면에서 보고서 서식 그룹 목록 상단의 추가 버튼을 클릭하세요.

  2. 보고서 서식 그룹 추가 대화상자에서 그룹 정보를 입력한 후 확인 버튼을 클릭하세요.

    보고서 서식 그룹 추가

    • 이름(필수): 보고서 서식 그룹의 이름을 입력하세요(최대 50자).
    • 설명: 보고서 서식 그룹에 대한 설명을 입력하세요(최대 2,000자).
    • 상위 그룹: 상위 그룹을 선택하지 않으면 이 그룹은 최상위 그룹으로 등록됩니다.

보고서 서식 그룹 수정

보고서 서식 그룹을 수정하려면,

  1. 분석 > 보고서 화면의 왼쪽의 그룹 목록에서 수정할 서식 그룹을 선택하세요.
  2. 그룹 목록 상단의 톱니바퀴 아이콘을 클릭하세요.
  3. 보고서 서식 그룹 편집 대화상자에서 수정할 내용을 입력한 뒤 확인 버튼을 클릭해 변경 사항을 저장하세요.

보고서 서식 그룹 삭제

보고서 서식 그룹을 삭제하려면,

  1. 분석 > 보고서 화면에서 삭제할 보고서 서식 그룹을 클릭하세요.
  2. 목록 상단의 휴지통 아이콘을 클릭하세요.
  3. 보고서 서식 그룹 삭제 대화상자에서 삭제할 그룹을 확인하고 삭제 버튼을 클릭하세요.
    • 하위 그룹 모두 제거:
      • 이 옵션을 선택하면, 해당 그룹과 모든 하위 그룹이 삭제되며, 포함된 보고서 서식은 상위 그룹으로 이동됩니다. 상위 그룹이 없으면 미분류로 분류됩니다.
      • 이 옵션을 선택하지 않으면, 현재 그룹만 삭제되고, 하위 그룹과 서식은 상위 그룹으로 이동됩니다. 상위 그룹이 없으면 미분류로 분류됩니다.

보고서 서식 그룹 변경

보고서 서식을 다른 그룹으로 이동하려면,

  1. 보고서 서식 목록에서 이동할 보고서 서식을 선택하세요.
  2. 도구 모음에서 이동 버튼을 클릭한 후, 보고서 서식 이동 대화상자에서 대상 그룹을 선택하고 이동 버튼을 클릭하세요.