임베디드 대시보드 및 시각적 객체를 위한 런타임 데이터 필터링 - Amazon QuickSight
용어 및 개념설정SDK 메서드 인터페이스

임베디드 대시보드 및 시각적 객체를 위한 런타임 데이터 필터링

Amazon QuickSight 임베딩 SDK에서 필터 메서드를 사용하여 런타임 시 서비스형 소프트웨어(SaaS) 애플리케이션 내에서 QuickSight 필터의 성능을 활용할 수 있습니다. 런타임 필터를 통해 비즈니스 소유자는 애플리케이션을 임베디드 QuickSight 대시보드 및 시각적 객체와 통합할 수 있습니다. 이를 수행하려면 애플리케이션에서 사용자 지정 필터 제어를 생성하고 애플리케이션의 데이터를 기반으로 필터 사전 설정을 적용합니다. 그런 다음 개발자는 런타임 시 최종 사용자를 위한 필터 구성을 개인화할 수 있습니다.

개발자는 QuickSight 임베딩 SDK를 사용하여 임베디드 대시보드 또는 시각적 객체에서 필터를 생성, 쿼리, 업데이트 및 제거할 수 있습니다. FilterGroup 데이터 모델을 사용하여 애플리케이션에 QuickSight 필터 객체를 생성하고 필터 메서드를 사용하여 임베디드 대시보드 및 시각적 객체에 적용합니다. QuickSight 임베딩 SDK 사용에 대한 자세한 내용은 GitHub의 amazon-quicksight-embedding-sdk를 참조하세요.

사전 조건 

시작하기 전에 QuickSight 임베딩 SDK 버전 2.5.0 이상을 사용하고 있는지 확인합니다.

용어 및 개념

다음 용어는 임베디드 런타임 필터링을 사용할 때 유용할 수 있습니다.

  • 필터 그룹 - 개별 필터의 그룹입니다. FilterGroup 내에 있는 필터는 서로 OR 처리됩니다. FilterGroup 내의 필터는 동일한 시트 또는 시각적 객체에 적용됩니다.

  • 필터 - 단일 필터입니다. 필터는 범주, 숫자 또는 날짜/시간 필터 유형일 수 있습니다. 필터에 대한 자세한 정보는 필터를 참조하세요.

설정

시작하기 전에 다음 자산 및 정보가 준비되어 있는지 확인합니다.

  • 범위를 FilterGroup으로 지정할 시트의 시트 ID입니다. 이는 임베딩 SDK의 getSheets 메서드를 사용하여 얻을 수 있습니다.

  • 필터링하려는 데이터세트의 데이터세트 및 열 식별자입니다. 이는 DescribeDashboardDefinition API 작업을 통해 얻을 수 있습니다.

    사용하는 열 유형에 따라 임베디드 자산에 추가할 수 있는 필터 유형에 제한이 있을 수 있습니다. 필터 제한에 대한 자세한 정보는 필터를 참조하세요.

  • 해당하는 경우 범위를 FilterGroup으로 지정할 시각적 객체의 시각적 ID입니다. 이는 임베딩 SDK의 getSheetVisuals 메서드를 사용하여 얻을 수 있습니다.

    getSheetVisuals 메서드 외에도 추가하는 FilterGroup의 범위는 현재 선택한 시트로만 지정할 수 있습니다.

이 기능을 사용하려면 QuickSight 임베딩 SDK를 통해 애플리케이션에 대시보드 또는 시각적 객체가 이미 내장되어 있어야 합니다. QuickSight 임베딩 SDK 사용에 대한 자세한 내용은 GitHub의 amazon-quicksight-embedding-sdk를 참조하세요.

SDK 메서드 인터페이스

대시보드 임베딩 getter 메서드

다음 테이블에서는 개발자가 사용할 수 있는 다양한 대시보드 임베딩 getter 메서드를 설명합니다.

메서드 설명

getFilterGroupsForSheet(sheetId: string)

파라미터에 제공된 시트에 현재 범위가 지정된 모든 FilterGroups를 반환합니다.

getFilterGroupsForVisual(sheetId: string, visualId: string)

파라미터에 제공된 시각적 객체로 범위가 지정된 모든 FilterGroups를 반환합니다.

파라미터에 제공된 시트가 임베디드 대시보드에서 현재 선택한 시트가 아닌 경우 위 메서드는 오류를 반환합니다.

시각적 객체 임베딩 getter 메서드

다음 테이블에서는 개발자가 사용할 수 있는 다양한 시각적 객체 임베딩 getter 메서드를 설명합니다.

메서드 설명

getFilterGroups()

현재 범위가 임베디드 시각적 객체로 지정된 모든 FilterGroups를 반환합니다.

Setter 메서드

다음 테이블에서는 개발자가 대시보드 또는 시각적 객체 임베딩에 사용할 수 있는 다양한 setter 메서드를 설명합니다.

메서드 설명

addFilterGroups(filterGroups: FilterGroup[])

제공된 FilterGroups를 임베디드 대시보드 또는 시각적 객체에 추가하고 적용합니다. 추가 성공 여부를 나타내는 ResponseMessage가 반환됩니다.

updateFilterGroups(filterGroups: FilterGroup[])

파라미터에 제공된 FilterGroup과 동일한 FilterGroupId가 포함된 임베디드 환경에서 FilterGroups를 업데이트합니다. 업데이트 성공 여부를 나타내는 ResponseMessage가 반환됩니다.

removeFilterGroups(filterGroupsOrIds: FilterGroup[] | string[])

대시보드에서 제공된 FilterGroups를 제거하고 제거 시도가 성공 여부를 나타내는 ResponseMessage를 반환합니다.

제공되는 FilterGroup은 현재 선택된 임베디드 시트 또는 시각적 객체로 범위가 지정되어야 합니다.