GraphQL 조회 유형

조직으로 가져오는 데이터는 GraphQL 조회를 사용하여 검사할 수 있습니다. 수동으로 조회를 실행하거나, 조회를 자동화하거나, 자동화된 규칙을 통해 조회를 실행할 수 있습니다.

Supply Chain Intelligence Suite 데이터 조회는 GraphQL 조회 명령어를 사용합니다. 조회 명령어의 형식에는 조회 유형, 괄호로 묶인 입력 매개변수, 중괄호로 묶인 리턴된 오브젝트의 출력 형식이 포함됩니다.

query type (input paramters){output parameters}

조회 유형은 조회 중인 데이터 유형 (비즈니스 이벤트 또는 비즈니스 오브젝트) 및 대상으로 지정되는 데이터 웨어하우스 (이벤트 웨어하우스 또는 오브젝트 웨어하우스) 를 표시합니다. 입력 매개변수는 조회되는 내용을 표시하고 출력 형식은 결과 오브젝트를 표시해야 하는 방법을 표시합니다.

현재 데이터 웨어하우스별로 그룹화된 네 가지 기본 조회 유형이 가능합니다.

이벤트 웨어하우스

errorEvents: 오류 이벤트 세부사항을 기반으로 오류 이벤트 목록을 리턴하며, 이는 조회할 오류 유형 (수집 또는 처리) 을 지정합니다. ErrorEventsCursor를 리턴합니다.

businessObjectEvents: 비즈니스 오브젝트에 영향을 주는 이벤트의 세부사항 입력을 기반으로 비즈니스 오브젝트 이벤트 목록을 리턴합니다. BusinessEventsCursor를 리턴합니다.

businessRuleEvents: 규칙 실행으로 인한 이벤트의 세부사항 입력을 기반으로 비즈니스 규칙 이벤트 목록을 리턴합니다. BusinessRulesCursor를 리턴합니다.

오브젝트 웨어하우스

businessObjects: 비즈니스 오브젝트 식별 정보 및 조회를 수행하는 데 사용되는 직렬화된 보기의 이름을 기반으로 비즈니스 오브젝트 목록을 리턴합니다. BusinessObjectsCursor를 리턴합니다.

다음 샘플 조회는 특정 ID별로 단일 비즈니스 오브젝트 이벤트를 리턴합니다.

{
  businessObjectEvents(
    simpleFilter: {
      businessObject: { 
        type: Order
        id: "372c9cdb-1077-464e-9132-b29fa25544d2"
      },
      tenantId: "e2_aRj_3np92C2Tl9uWIyh0vQP8N8"
    }, 
    cursorParams: { 
      first: 1  # Maximum number of items to return
    }
  ) {
    totalCount
    pageInfo {
      endCursor
      hasNextPage
    }
    edges {
      cursor
      object {
        eventCode
        infoHubObjectId
        objectType
        tenantId
        timestampEventOccurred
        timestampEventReceived
        eventDetails {
          ... on BusinessObjectEventDetails {
            businessObject {
              id
              type
            }
            eventSource {
              type
              EDI {
                transactionType
                size
              }
            }
          }
        }
      }
    }
  }
}

조회 입력 매개변수

필수 입력 매개변수는 수행되는 조회 유형에 따라 다릅니다. 그러나 여러 입력 매개변수가 조회 유형에서 공통입니다.

businessObjectEvents

businessObjectEvents 조회 유형은 지정된 입력 매개변수 값을 기반으로 이벤트 웨어하우스에서 비즈니스 이벤트 목록을 리턴합니다.

이 조회의 입력 매개변수는 다음과 같습니다.

eventParams: BusinessEventInput을 가리킵니다.

simpleFilter: BusinessObjectEventDetailsInput을 가리킵니다.

advancedFilter: BooleanExp을 가리킵니다.

savedFilter: SavedFilter을 가리킵니다.

cursorParams: CursorInput을 가리킵니다.

BusinessObjectEventDetailsInput

이 유형은 이벤트에 관련된 비즈니스 오브젝트 오퍼레이션에 대한 입력을 제공하며 다음 속성을 포함합니다.

tenantId: 이벤트 생성을 담당하는 테넌트의 글로벌 ID입니다.

businessObjectEventCode: 이 이벤트와 관련된 비즈니스 오브젝트 조작의 유형 (갱신삽입 (upsert) 또는 아카이브) 입니다.

businessObject: BusinessObjectInput을 가리킵니다.

BusinessObjectInput

이 유형은 포함된 비즈니스 오브젝트 자체에 대한 입력을 제공하며 다음 속성을 포함합니다.

id: 오브젝트가 작성될 때 생성되는 비즈니스 오브젝트의 글로벌 고유 ID입니다.

type: 비즈니스 오브젝트의 유형을 표시하는 BusinessObjectType 열거 값을 가리킵니다.

globalIdentifiers: 동일한 유형의 다른 비즈니스 오브젝트 및 동일한 테넌트 내에서 이 비즈니스 오브젝트를 고유하게 식별해야 하는 오브젝트 속성의 이름 또는 값 쌍 배열입니다. Supply Chain Intelligence Suite 는 globalIdentifiers, 테넌트 및 오브젝트 유형의 모든 고유 조합에 대해 고유 ID를 생성합니다.

localIdentifiers: 비즈니스 오브젝트 자체 내에서 로컬 참조를 위해 이 오브젝트를 고유하게 식별하는 오브젝트 속성의 이름 또는 값 쌍의 정렬된 배열입니다. 특정 비즈니스 오브젝트에는 오더 내의 오더 라인 및 하위 라인과 같은 상위 오브젝트를 다시 참조할 수 있는 중첩된 오브젝트가 있습니다.

businessRuleEvents

businessRuleEvents 조회 유형은 지정된 입력 매개변수 값을 기반으로 비즈니스 규칙에 의해 생성되는 이벤트 웨어하우스의 비즈니스 이벤트 목록을 리턴합니다.

이 조회의 입력 매개변수는 다음과 같습니다.

eventParams: BusinessEventInput을 가리킵니다.

simpleFilter: BusinessRuleEventDetailsInput을 가리킵니다.

advancedFilter: BooleanExp을 가리킵니다.

savedFilter: SavedFilter을 가리킵니다.

cursorParams: CursorInput을 가리킵니다.

aggregationParams: AggregationParams을 가리킵니다.

BusinessRuleEventDetailsInput

이 유형은 비즈니스 이벤트를 생성한 비즈니스 규칙에 대한 세부사항을 제공하며 다음 속성을 포함합니다.

tenantId: 이벤트 생성을 담당하는 테넌트의 글로벌 ID입니다.

rule: ID, 이름 및 소스별로 규칙을 지정할 수 있는 RuleInput 유형을 가리킵니다.

dimensionValues: 쿼리를 제한할 차원 값을 지정하는 이름/값 쌍의 배열입니다. 차원은 해당 속성의 모든 고유 값이 다른 비즈니스 이벤트를 생성하는 기본 비즈니스 오브젝트의 속성입니다.

AggregationParams

이 유형을 사용하면 조회에서 리턴되는 값을 집계, 요약 및 정렬할 수 있으며 다음 속성을 포함합니다.

dimension: 집계가 발생하는 기반이 되는 기본 비즈니스 오브젝트 속성 및 데이터 유형입니다. 지정된 속성에 대해 발견되는 모든 고유 값에 대해 다른 집계가 수행됩니다.

reduce: 선택적으로, 축소 조작은 쿼리에서 리턴되는 데이터에 대해 수행될 수 있으며 AggregationReduce를 가리킵니다.

paginationParams: 조회에서 리턴할 값 수, 결과를 정렬하는 데 사용할 속성 및 오름차순 또는 내림차순으로 정렬할지 여부를 선택적으로 지정할 수 있습니다.

AggregationReduce

이 유형에는 수행할 축소 조작 유형 및 해당 축소의 출력이 표현되는 방법에 대한 지시사항이 포함되며 다음 속성이 포함됩니다.

expression: AggregationReduceExpression을 가리킵니다.

output: 표현식 출력의 결과 및 데이터 유형을 보유하는 데 사용할 새 속성 resultAlias를 표시합니다.

AggregationReduceExpression

이 유형은 축소 알고리즘을 정의하는 수학적 연산을 보유하며 다음 속성을 포함합니다.

operator: AggregationReduceOperator 를 가리키고 수행되는 수학 연산을 지정합니다.

fieldPath: 조작에 대한 입력으로 제공되는 비즈니스 오브젝트 또는 이벤트 속성입니다.

type: ScalarType 를 가리키고 fieldPath 값의 데이터 유형을 표시합니다.

errorEvents

errorEvents 조회 유형은 지정된 입력 매개변수 값을 기반으로 이벤트 웨어하우스에서 오류 이벤트 목록을 리턴합니다. 비즈니스 오브젝트 처리 중에 오류가 발생하면 Supply Chain Intelligence Suite 에서 오류 이벤트가 생성됩니다. 데이터 처리는 백그라운드에서 비동기적으로 발생할 수 있으므로 오류가 발생하는지 여부를 판별하는 유일한 방법은 오류 이벤트를 조회하는 것입니다.

이 조회의 입력 매개변수는 다음과 같습니다.

eventParams: BusinessEventInput을 가리킵니다.

simpleFilter: ErrorEventDetailsInput을 가리킵니다.

advancedFilter: BooleanExp을 가리킵니다.

savedFilter: SavedFilter을 가리킵니다.

cursorParams: CursorInput을 가리킵니다.

ErrorEventDetailsInput

이 유형은 오류 이벤트의 특성에 대한 세부사항을 제공하며 다음 속성을 포함합니다.

tenantId: 이벤트 생성을 담당하는 테넌트의 글로벌 ID입니다.

type: 데이터 수집 중에 이벤트가 발생했는지 여부를 나타내는 오류 이벤트의 유형입니다. IngestionErrorEventDetails또는 데이터의 백그라운드 처리, ProcessingErrorEventDetails.

businessObjects

businessObjects 조회 유형은 지정된 입력 매개변수 값을 기반으로 오브젝트 웨어하우스에서 비즈니스 오브젝트 목록을 리턴합니다.

이 조회의 입력 매개변수는 다음과 같습니다.

hint: 이전에 저장된 구체화된 보기를 지정하는 viewId 속성을 포함하는 Hint 유형을 가리킵니다. 보기는 조회 결과에 리턴되는 내용을 정의합니다.

simpleFilter: BusinessObjectInput을 가리킵니다.

advancedFilter: BooleanExp을 가리킵니다.

savedFilter: SavedFilter을 가리킵니다.

cursorParams: CursorInput을 가리킵니다.

공통 입력 매개변수 유형

BooleanExp

부울 표현식은 부울 true 또는 false 결과를 생성하는 연산자와 링크된 일련의 비교입니다. 비교는 명시적 값을 Supply Chain Intelligence Suite 비즈니스 오브젝트 또는 비즈니스 이벤트의 속성과 비교합니다. 연산에는 논리 연산자 AND, OR및 NOT과 비교 연산자 (예: GREATER_THAN및 EQUALS) 가 포함됩니다. 논리 연산자는 BooleanExp유형이기도 하며, 이 유형을 사용하면 BooleanExp 문을 임의로 중첩할 수 있는 순환이 가능합니다.

기타 참조되는 유형은 다음과 같습니다.

ComparisonOp: 특정 유형의 값을 SELECT 속성으로 표시되는 비즈니스 오브젝트 또는 이벤트의 속성과 비교합니다.

ComparisonListOp: 특정 유형의 값 목록을 SELECT 속성으로 표시되는 비즈니스 오브젝트 또는 이벤트의 속성과 비교합니다. 비즈니스 오브젝트 또는 이벤트 속성도 목록으로 가정되므로 VALUE에 의해 지정되는 모든 항목은 비교가 true를 리턴하도록 SELECT에 의해 리턴되는 모든 항목과 일치해야 합니다.

ComparisonOperandType: 비교에 사용되는 값 데이터 유형의 열거입니다.

기타 공통 유형

BusinessEventInput: 모든 유형의 비즈니스 이벤트 조회는 이벤트 자체에 대한 공통 속성 세트 (예: 이벤트의 시간소인, 이벤트의 고유 ID및 이벤트에 관련된 오브젝트의 유형) 를 지원합니다.

SavedFilter: 조회 결과를 세분화하기 위한 필터는 필터 서비스를 사용하여 사전 정의할 수 있으며 조회에서 항상 필터 세부사항을 표현하는 대신 filterId 속성을 사용하여 참조할 수 있습니다.

CursorInput: 결과가 페이지 매김을 위해 해당 오브젝트 또는 이벤트의 커서 값을 사용하여 시작되어야 하는 비즈니스 오브젝트 또는 이벤트를 표시합니다. 또한 조회에서 리턴할 수를 표시합니다.

AggregationReduceOperator: 비즈니스 규칙 이벤트 조회에서 결과를 집계하는 동안 감소 조작 중에 가능한 조작의 열거입니다.

ScalarType: 집계 조작 중에 속성과 연관된 값의 데이터 유형을 참조합니다.

SortOrder: 리턴된 결과를 정렬해야 하는 방법과 정렬할 비즈니스 오브젝트 또는 이벤트의 소스 필드를 지정합니다.

BusinessObjectType: Supply Chain Intelligence Suite에서 지원되는 모든 비즈니스 오브젝트 유형을 나열합니다.

조회 출력 형식

쿼리에서 리턴되는 데이터는 실행 중인 쿼리의 유형에 따라 다릅니다. 마찬가지로 쿼리 자체에 지정된 출력 형식도 쿼리 유형에 따라 다릅니다. 네 개의 쿼리 유형이 있으므로 네 개의 가능한 리턴된 오브젝트 및 연관된 출력 형식이 있습니다.

errorEvents: ErrorEventsCursor
businessObjectEvents: BusinessEventsCursor
businessRuleEvents: BusinessRulesCursor
businessObjects: BusinessObjectsCursor

리턴된 각 유형은 커서 인터페이스를 구현하며, 이는 결과가 인덱스 가능한 페이지 번호가 매겨진 오브젝트 목록임을 의미합니다.

커서

커서 인터페이스에는 세 가지 기본 속성이 있습니다.

edges: Edge 인터페이스를 구현하는 오브젝트 유형의 배열입니다.

pageInfo: edges 배열에서 마지막 데이터 오브젝트의 커서 값 (포인터) 을 포함하여 현재 페이지의 데이터에 대한 세부사항 ( endCursor) 및 다음 페이지 ( hasNextPage) 가 있는지 여부.

totalCount: 조회와 일치하는 데이터 오브젝트의 총 수입니다.

네 개의 조회 결과 커서 ErrorEventsCursor, BusinessEventsCurs 및 BusinessObjectsCursor중 세 개는 커서 인터페이스 정의와 매우 유사하며 Edge 오브젝트에서 구현되는 오브젝트만 다릅니다. BusinessRulesCursor, 그러나, 집계 결과를 렌더링하는 것을 처리하기 위해 커서 구현에 더 많은 속성을 포함시키는 것은 다릅니다.

참고: Edge 유형에서 객체의 구현이 매우 다양하기 때문에, ' Supply Chain Intelligence Suite이 구현하는 다양한 유형의 비즈니스 객체 및 이벤트에 따라 해당 옵션에 대해 자세히 알아보는 가장 좋은 방법은 GraphQL 인트로스펙션 자습서에 설명된 대로 ' Supply Chain Intelligence Suite 데이터 모델을 인트로스펙션하는 것입니다

Edge

에지 인터페이스는 쿼리에 대한 입력 매개변수로 지정된 쿼리 기준과 일치하는 커서 작성 또는 인덱스화된 데이터 오브젝트를 나타냅니다. 실제 구현은 조회에서 리턴되는 데이터의 유형에 따라 다릅니다. 모든 구현에는 인터페이스에서 정의하는 두 개의 속성이 있습니다.

cursor: 이 에지로 표시되는 비즈니스 오브젝트 또는 이벤트의 고유 색인 ID입니다.

object: 인터페이스를 구현하는 비즈니스 오브젝트 또는 이벤트를 가리킵니다. 인터페이스에는 id 속성만 포함됩니다. 구현은 조회에서 리턴되는 데이터의 유형에 따라 광범위하게 다릅니다.

BusinessRulesCursor

Cursor 인터페이스의 세 가지 속성 ( edges, pageInfo및 totalCount) 을 구현하는 것 외에도 BusinessRulesCursor 는 비즈니스 규칙에서 집계 결과를 렌더링하기 위한 두 개의 추가 속성도 구현합니다.

aggregationResults: AggregationResult을 가리킵니다.

aggregationResultsTotalCount: 일치하는 차원에 따라 리턴된 집계 결과의 총 수입니다.

AggregationResult

집계는 여러 차원에 대해 수행되는 축소 계산을 정의합니다. 차원은 해당 속성의 모든 고유 값이 다른 집계를 생성하는 기본 비즈니스 오브젝트의 속성입니다. 이 유형에는 두 가지 속성이 있습니다.

dimensionValues: 생성된 각 집계 값의 차원 값을 나열하는 이름 및 값 쌍의 배열입니다.

values: 이름 속성이 조회의 집계 정의에서 resultAlias 를 지정하고 값이 결과 계산 (축소) 인 이름/값 쌍의 배열입니다. 값은 축소 조작의 특성에 따라 문자열 (value) 또는 부동 소수점 (numValue) 유형일 수 있습니다. 배열에 있는 값의 인덱스는 dimensionValues 배열에 있는 연관된 차원의 인덱스에 해당합니다.