PAScorecard - 범위 지정됨

  • 릴리스 버전: Xanadu
  • 업데이트 날짜 2024년 08월 01일
  • 읽기9분

    • PAScorecard API를 사용하면 표시기 및 관련 기록(예: 세부 항목)에 대한 데이터를 가져올 수 있습니다.

    이 API는 퍼포먼스 분석 (com.snc.pa.analytics_center) 애플리케이션이 필요하며 SNC 네임스페이스에서 실행됩니다.

    PAScorecard - addParam(문자열 매개변수, 문자열 값)

    반환된 점수를 필터링하는 쿼리 매개변수를 추가합니다.

    동일한 PAScorecard 개체에서 이 메서드를 여러 번 호출하여 표시기 sys_id 및 분석 sys_id와 같은 여러 매개 변수를 전달합니다. 모든 매개 변수를 지정한 후 query() 를 호출하여 쿼리를 실행합니다.

    매개 변수 없이 PAScorecard 개체를 쿼리하면 API는 점수와 함께 에 표시되는 분석 허브모든 표시기 목록을 반환합니다.

    표 1. 매개변수
    이름 유형 설명
    세부 항목 문자열 세부 항목에 정의된 대로 구성된 차트 정보를 반환하는 세부 항목 Sys_id입니다. 예를 들어, 우선순위 세부 항목을 sys_id하여 각 우선순위 값에 대해 별도의 작업 차트 정보(예: 오픈 인시던트 수/우선순위/2 - 높음)를 반환합니다.
    breakdown_relation 문자열 해당 관계를 사용하여 반환된 데이터를 세분화하려면 세분화 관계의 sys_id 지정합니다. 매개변수를 include_available_breakdownstrue로 설정하여 사용 가능한 세부 항목 관계를 볼 수 있습니다.
    포함 문자열 일치하는 값이 있는 표시기에서만 결과를 반환하기 위한 이름 또는 설명의 쉼표로 구분된 목록입니다. 쉼표로 구분된 모든 목록 항목이 일치해야 하며, 그렇지 않으면 결과가 반환되지 않습니다. 목록은 OR 논리가 아닌 AND 논리를 따릅니다.
    표시 문자열 반환할 표시기의 유형을 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 에 표시되는 분석 허브 표시기만 반환합니다.
    • all: 모든 인디케이터를 반환합니다.

    기본값: true
    display_value 문자열 참조 및 선택 필드에 대한 데이터 검색 작업입니다.
    이 값을 기준으로 데이터베이스의 표시 값 및/또는 실제 값이 검색됩니다.
    • true 는 모든 필드의 표시 값을 반환합니다.
    • false 는 데이터베이스의 실제 값을 반환합니다.
    • 모두 실제 값과 표시 값을 모두 반환합니다.

    기본값: false
    elements_filter 문자열 요소 필터의 sys_id 지정하여 반환된 데이터에 해당 필터를 적용합니다.

    데이터 유형: 문자열
    exclude_reference_link 부울 참조 자원에 대한 URI와 같이 참조 필드에 제공된 추가 정보를 숨길지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 참조 필드에 제공된 추가 정보를 숨깁니다.
    • 아니오: 참조 필드에 제공된 추가 정보를 숨기지 않습니다.

    기본값: false
    즐겨찾기 부울 쿼리하는 사용자가 즐겨찾기에 해당하는 표시기만 반환할지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 쿼리하는 사용자의 즐겨찾기인 표시기만 반환합니다.
    • 아니오: 모든 인디케이터를 반환합니다.

    기본값: false
    시작 항목 문자열 점수를 반환할 가장 빠른 날짜입니다. 이 날짜 이후의 점수만 반환됩니다.

    이 매개 변수를 사용하려면 true로 설정해야 합니다include_scores.

    형식: ISO-8601 표준
    include_available_aggregates 문자열 집계가 적용되지 않은 경우 표시기에 사용 가능한 모든 집계를 반환할지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 집계가 적용되지 않은 경우 표시기에 사용 가능한 모든 집계를 반환합니다.
    • false: 집계를 반환하지 않습니다.

    기본값: false
    include_available_breakdowns 부울 표시기에 사용 가능한 모든 세부 항목을 반환할지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 표시기에 사용 가능한 모든 세부 항목을 반환합니다.
    • false: 세부 항목을 반환하지 않습니다.

    기본값: false
    include_forecast_scores 부울 에 대한 예측 데이터를 정의하는 날짜-값 쌍의 배열을 포함하는 forecast_scores 요소를 반환할지 여부를 나타내는 플래그입니다 분석 허브 .

    이 매개 변수를 사용하려면 true로 설정해야 합니다include_scores.

    유효한 값은 다음과 같습니다.
    • true: forecast_scores 요소를 반환합니다.
    • false: forecast_scores 요소를 반환하지 않습니다.

    기본값: false
    include_realtime 부울 표시기에 실시간 점수가 활성화되어 있는지 여부를 나타내는 realtime_enabled 요소와 실시간 점수 값을 포함하는 realtime_value 요소를 반환할지 여부를 나타내는 플래그입니다. 이 매개변수는 수식 표시기에 지원되지 않습니다.
    유효한 값은 다음과 같습니다.
    • true: realtime_enabled 요소를 반환합니다.
    • false: realtime_enabled 요소를 반환하지 않습니다.

    기본값: false
    include_scores 부울 에서 선택한 전체 시간 범위에 대한 표시기 점수를 반환할지 여부를 나타내는 플래그입니다 분석 허브 . 값을 지정하지 않으면 이 매개변수는 기본적으로 false로 설정되고 가장 최근의 점수 값만 반환합니다.

    반환되는 점수의 날짜 범위를 제한하려면 이 매개 변수를 from 및 to와 결합합니다.

    유효한 값은 다음과 같습니다.
    • true: 선택한 전체 시간 범위에 대한 표시기 점수를 반환합니다.
    • false: 선택한 전체 시간 범위에 대한 표시기 점수를 반환하지 않습니다.

    기본값: false
    include_target_color_scheme 부울 최소값과 최대값을 포함하는 target_color_scheme 요소를 반환할지 여부와 에 대한 대상 색 구성표의 각 섹션 색상을 반환할지 여부를 나타내는 플래그입니다 분석 허브 .
    유효한 값은 다음과 같습니다.
    • true: target_color_scheme 요소를 반환합니다.
    • false: target_color_scheme 요소를 반환하지 않습니다.

    기본값: false
    include_trendline_scores 문자열 추세선을 정의하는 분석 허브 날짜-값 쌍의 배열을 포함하는 trendline_scores 요소를 반환할지 여부를 나타내는 플래그입니다.

    이 매개 변수를 사용하려면 true로 설정해야 합니다include_scores.
    키 부울 키 표시기에 대한 결과만 반환할지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: trendline_scores 요소를 반환합니다.
    • false: trendline_scores 요소를 반환하지 않습니다.

    기본값: false
    제한 번호 반환할 최대 점수 수입니다.
    페이지 문자열 페이지 번호를 지정합니다. 예를 들어 기본 per_page 값(10)을 사용하여 20개의 표시기 분석 허브 를 쿼리하는 경우 페이지 값을 2로 지정하여 for 11-20을 분석 허브 검색합니다.
    per_page 번호 각 쿼리가 페이지에서 반환할 수 있는 최대 표시기 수입니다.

    기본값: 10

    최대: 100
    정렬 기준 문자열 결과를 정렬할 때 사용할 값입니다.
    유효한 값은 다음과 같습니다.
    • 탄알
    • 변경
    • 체인지퍼크
    • 날짜
    • 기본값
    • 방향
    • 기한
    • 빈도
    • 갭
    • 갭퍼크
    • 그룹
    • indicator_group
    • 이름
    • 순서
    • 대상
    • 추세
    • 값

    기본값: 값
    정렬 디렉토리 문자열 정렬 방향입니다.
    유효한 값은 다음과 같습니다.
    • asc: 오름차순을 나타냄
    • des: 내림차순을 나타냄

    기본값: 내림차순
    단계 번호 표시기 빈도에 따라 점수를 건너뛰는 숫자 값입니다. 예를 들어, 일별 표시기의 경우 매 3일마다, 또는 주간 표시기의 경우 매 3주마다의 점수만 반환하려면 값을 3으로 지정합니다.
    태그 문자열 표시기 그룹 sys_id 입력하여 해당 그룹의 표시기를 반환합니다. 이 매개 변수와 함께 사용하지 uuid 마십시오.
    대상 부울 대상값이 설정된 표시기에 대해서만 결과를 반환할지 여부를 나타내는 플래그입니다 분석 허브 .
    유효한 값은 다음과 같습니다.
    • true: 대상이 설정된 표시기에 대한 결과만 반환합니다.
    • false: 적용 가능한 모든 표시기에 대한 결과를 반환합니다.

    기본값: false
    대상 문자열 점수를 반환할 가장 늦은 날짜입니다. 이 날짜 또는 이전 날짜의 점수만 반환됩니다.

    이 매개 변수를 사용하려면 true로 설정해야 합니다include_scores.
    uuid 문자열 콜론으로 구분된 sys_id 값 목록을 입력하여 쿼리할 표시기, 세부 항목, 집계 및 도메인을 지정합니다. 매개변수는 다음 형식을 따릅니다.

    <indicator_sys_id>:<breakdown_sys_id>:<elements_filter_sys_id 또는 element_sys_ids>:<lvl-2 breakdown_sys_id>:<lvl-2 elements_filter_sys_id 또는 element_sys_ids>:<aggregate_sys_id>;<domain_sys_id>

    매개변수는 표시기 기록의 sys_id로 시작해야 합니다. 필요에 따라 세분화 및 세분화 요소의 sys_id 값을 추가하여 세분화를 기반으로 응답을 그룹화하고 집계 sys_id를 추가하여 해당 집계를 적용할 수 있습니다. 세부 항목을 집계와 함께 사용하거나 하나만 사용할 수 있습니다.

    기록의 sys_id 값을 얻는 방법에 대한 자세한 내용은 고유 기록 식별자(sys_id)를 참조하십시오.

    주:
    표시기가 기본 시계열을 사용하도록 구성된 경우 해당 표시기의 모든 분석 허브 값은 해당 시계열 집계를 사용합니다.
    표 2. 반환
    유형 설명
    없음

    이 예에서 uuid 매개변수는 오픈 인시던트 수 표시기를 지정하고 breakdown 매개변수는 우선순위 세부 항목을 지정합니다. 두 매개변수 모두 해당 기록의 sys_id 값으로 가집니다. query() 함수는 결과를 객체로 반환합니다.

    var sc = new SNC.PAScorecard(); //in a scoped app, do not use the SNC namespace
sc.addParam('uuid', 'fb007202d7130100b96d45a3ce6103b4');       // Number of open incidents
sc.addParam('breakdown', '0df47e02d7130100b96d45a3ce610399');  // by Priority
var result = sc.query();  // Query results, which are returned as an object
for (var i = 0; i < result.length; i++)
gs.info(result[i].name + ': ' + result[i].value + ' ' + result[i].unit.display_value);

    PAScorecard - 쿼리()

    지정된 매개변수를 기반으로 쿼리를 수행하고 결과를 객체로 반환합니다.

    이 메서드를 호출하기 전에 addParam(String parameter, String value)을 호출하여 PAScorecard 개체에 대한 매개 변수를 구성합니다.

    표 3. 매개변수
    이름 유형 설명
    없음
    표 4. 반환
    유형 설명
    객체 PAScorecard 개체입니다.

    PAScorecard - 결과()

    마지막 쿼리 결과를 객체로 가져옵니다.

    이 메서드는 쿼리를 수행하지 않습니다. 결과를 반환하기 전에 쿼리를 수행하려면 query()를 사용합니다.

    이 함수는 전역 이외의 범위에서 실행할 수 없습니다.

    표 5. 매개변수
    이름 유형 설명
    없음
    표 6. 반환
    유형 설명
    객체 마지막 쿼리의 결과로, JS 객체로 반환됩니다.