PSBPublicAPIUtil - 범위 지정, 전역

  • 릴리스 버전: Xanadu
  • 업데이트 날짜 2024년 08월 01일
  • 읽기7분
  • PSBPublicAPIUtil 스크립트 포함은 구성 레코드에 대한 서비스 브리지 작업을 수행하는 데 사용할 수 있는 메서드를 제공합니다.

    이 스크립트 포함을 사용하여 작업을 수행할 수 있는 구성 기록에는 두 가지 유형 서비스 브리지 이 있습니다.
    • 원격 기록 생성자(RRP)
    • 원격 작업 정의(RTD)
    이러한 구성 기록에 대해 다음 서비스 브리지 작업을 수행할 수 있습니다.
    • 체크 아웃: 지정된 구성 기록의 초안 버전을 만듭니다. 게시된 버전은 계속 고객이 사용할 수 있습니다.
    • 게시: 지정된 구성 기록의 초안 버전을 게시하고 고객이 사용할 수 있게 합니다.
    • 보관: 지정된 구성 기록의 비활성 버전을 보관하고 고객이 사용할 수 없게 만듭니다.
    • 폐기: 지정된 구성 기록의 모든 버전을 폐기하고 고객이 사용할 수 없게 만듭니다.

    구성 기록에 대한 서비스 브리지 자세한 내용은 다음 문서를 참조하십시오 Create configuration revisions.

    이 API 서비스 브리지 에 액세스하려면 for Providers 애플리케이션(sn_sb_pro) 및 Base(sn_sb)가 서비스 브리지 인스턴스에 설치되어 있어야 합니다.

    sb 스크립트 포함을 사용하여 이 API에서 메서드를 호출합니다. 그러나 이러한 메서드의 코드는 PSBPublicAPIUtil 스크립트 포함에 있습니다.

    전역 범위에서 이러한 메서드를 호출할 때는 다음 구문을 사용합니다.
    sb.checkout(glideRecord);
    sb.publish(glideRecord);
    sb.archive(glideRecord);
    sb.retire(glideRecord);
    범위가 지정된 애플리케이션에서 호출할 때는 다음 구문을 사용합니다.
    global.sb.checkout(glideRecord);
    global.sb.publish(glideRecord);
    global.sb.archive(glideRecord);
    global.sb.retire(glideRecord);

    PSBPublicAPIUtil - archive(glideRecord)

    지정된 GlideRecord가 유효한 서비스 브리지 구성 기록인지 확인하고 기록이 "비활성" 상태인지 확인합니다. 이 유효성 확인에 통과하면 지정된 구성 기록을 보관하고 동일한 구성 기록의 다른 모든 버전은 그대로 둡니다.

    구성 개정 및 관련 상태에 대한 자세한 내용은 을 참조하십시오 Create configuration revisions.

    표 1. 매개변수
    이름 유형 설명
    glideRecord GlideRecord 보관할 구성 기록입니다.
    이 레코드는 다음 중 하나일 수 있습니다.
    • 원격 기록 생성자(RRP): 원격 기록 생성자 [sn_sb_pro_remote_record_producer] 테이블에 있는 기록입니다.
    • 원격 작업 정의(RTD): 원격 작업 정의[sn_sb_pro_remote_task_def] 테이블에 있는 기록입니다.
    표 2. 반환
    유형 설명
    부울 구성 기록이 보관되었는지 여부를 나타내는 플래그입니다.
    가능한 값:
    • true: 구성 기록이 보관되었습니다.
    • false: 오류가 발생했습니다. 구성 기록이 보관되지 않았습니다.

    다음 코드 예제에서는 FDS 구성 레코드의 전역 범위에서 이 메서드를 호출하는 방법을 보여 줍니다.

    var grConfig = new GlideRecord('sn_sb_pro_remote_record_producer'); // Configuration table that contains the desired record 
    grConfig.get('0ed11101ff6aca10c1befe258c4fd99e'); // Sys_id of the configuration record to publish
    var isExecuted = sb.archive(grConfig);

    PSBPublicAPIUtil - checkout(glideRecord)

    지정된 GlideRecord가 유효한 서비스 브리지 구성 기록인지 확인하고 기록이 "게시됨" 상태인지 확인합니다. 이 유효성 검사를 통과하면 지정된 구성 기록의 새 버전이 작성되고 상태 필드가 "초안"으로 설정됩니다.

    표 3. 매개변수
    이름 유형 설명
    glideRecord GlideRecord 체크아웃할 구성 기록입니다.
    이 레코드는 다음 중 하나일 수 있습니다.
    • 원격 기록 생성자(RRP): 원격 기록 생성자 [sn_sb_pro_remote_record_producer] 테이블에 있는 기록입니다.
    • 원격 작업 정의(RTD): 원격 작업 정의[sn_sb_pro_remote_task_def] 테이블에 있는 기록입니다.
    표 4. 반환
    유형 설명
    GlideRecord 성공하면 상태 필드가 "초안"으로 설정된 새로 작성된 구성 기록이 반환됩니다.

    오류가 발생한 경우 null을 반환합니다.

    다음 코드 예제에서는 RTD 구성 레코드의 전역 범위에서 이 메서드를 호출하는 방법을 보여 줍니다.

    var grConfig = new GlideRecord('sn_sb_pro_remote_task_def'); // Configuration table that contains the desired record 
    grConfig.get('0ed11101ff6aca10c1befe258c4fd99e'); // Sys_id of the configuration record to checkout
    var checkoutGr = sb.checkout(grConfig);

    PSBPublicAPIUtil - publish(glideRecord)

    지정된 GlideRecord가 유효한 서비스 브리지 구성 기록인지 확인하고 기록이 "초안" 상태인지 확인합니다. 이 확인에 통과하면 구성 기록의 초안 버전이 게시됩니다.

    표 5. 매개변수
    이름 유형 설명
    glideRecord GlideRecord 게시할 구성 기록입니다.
    이 레코드는 다음 중 하나일 수 있습니다.
    • 원격 기록 생성자(RRP): 원격 기록 생성자 [sn_sb_pro_remote_record_producer] 테이블에 있는 기록입니다.
    • 원격 작업 정의(RTD): 원격 작업 정의[sn_sb_pro_remote_task_def] 테이블에 있는 기록입니다.
    표 6. 반환
    유형 설명
    부울 구성 기록이 게시되었는지 여부를 나타내는 플래그입니다.
    가능한 값:
    • true: 구성 기록이 게시되었습니다.
    • false: 오류가 발생했습니다. 구성 기록이 게시되지 않았습니다.

    다음 코드 예제에서는 RRP 구성 레코드의 전역 범위에서 이 메서드를 호출하는 방법을 보여 줍니다.

    var grConfig = new GlideRecord('sn_sb_pro_remote_record_producer’'); // Configuration table that contains the desired record 
    grConfig.get('0ed11101ff6aca10c1befe258c4fd99e'); // Sys_id of the configuration record to publish
    var isExecuted = sb.publish(grConfig);

    PSBPublicAPIUtil - retire(glideRecord)

    지정된 GlideRecord가 유효한 서비스 브리지 구성 기록인지 확인하고 기록이 유효한 상태인지 확인합니다. 이 유효성 검사를 통과하면 지정된 버전의 구성 기록이 폐기되고 동일한 구성 기록의 다른 모든 수정 버전도 폐기됩니다.

    구성 개정 및 관련 상태에 대한 자세한 내용은 을 참조하십시오 Create configuration revisions.

    표 7. 매개변수
    이름 유형 설명
    glideRecord GlideRecord 폐기할 구성 기록입니다.
    이 레코드는 다음 중 하나일 수 있습니다.
    • 원격 기록 생성자(RRP): 원격 기록 생성자 [sn_sb_pro_remote_record_producer] 테이블에 있는 기록입니다.
    • 원격 작업 정의(RTD): 원격 작업 정의[sn_sb_pro_remote_task_def] 테이블에 있는 기록입니다.
    표 8. 반환
    유형 설명
    부울 구성 기록이 폐기되었는지 여부를 나타내는 플래그입니다.
    가능한 값:
    • true: 구성 기록이 폐기되었습니다.
    • false: 오류가 발생했습니다. 구성 기록이 폐기되지 않았습니다.

    다음 코드 예제에서는 RTD 구성 레코드의 전역 범위에서 이 메서드를 호출하는 방법을 보여 줍니다.

    var grConfig = new GlideRecord('sn_sb_pro_remote_task_def'); // Configuration table that contains the desired record 
    grConfig.get('0ed11101ff6aca10c1befe258c4fd99e'); // Sys_id of the configuration record to checkout
    var isExecuted = sb.retire(grConfig);