api - UI 빌더

  • 릴리스 버전: Washingtondc
  • 업데이트 날짜 2024년 02월 01일
  • 읽기32분

    • api API는 UI Builder에서 클라이언트 스크립트를 개발할 때 사용할 수 있는 메서드를 제공합니다.

    이 API는 페이지 스크립트라고도 하는 클라이언트 스크립트에 노출됩니다. 클라이언트 스크립트는 다음과 같이 페이지에서 발생하는 내용에 대한 응답으로 실행됩니다.
    • 버튼 클릭과 같은 사용자 상호작용 이벤트/동작.
    • 데이터 브로커 실행이 시작된 것과 같은 수명주기 이벤트입니다.
    이러한 스크립트는 프레임워크에 아무 것도 반환할 필요가 없으며 비동기 함수로 작성할 수 있습니다.
    이 API는 스크립팅된 속성 값에도 노출됩니다. 이러한 스크립트는 프레임워크 런타임이 다음과 같은 값을 계산해야 할 때마다 실행됩니다.
    • 구성요소 속성으로 전달합니다.
    • 구성요소 가시성 결정.
    • 페이로드와 함께 이벤트를 내보냅니다.
    이러한 스크립트는 비동기 함수로 작성할 수 없습니다. 또한 api.emit(), api.setState() 및 api.data.<data_resource_id>.*()와 같은 api 객체에 대한 부작용 메서드를 호출할 수 없습니다.

    api 객체에는 연결된 페이지 또는 구성요소의 컨텍스트 내에서 액세스할 수 있는 구성 종속 속성과 구성 독립적 속성이 모두 포함되어 있습니다. 이 개체 내의 속성은 직접 수정할 수 없습니다. 수정은 사용 가능한 방법을 통해서만 수행할 수 있습니다.

    API - api.context.props.<page_property_name>

    페이지 속성은 . 내에서 구성할 UI 빌더수 있습니다. 구성 값은 페이지가 사용되는 컨텍스트에 따라 달라집니다.

    표 1. 필드
    이름 유형 설명
    <page_property_name> 모두 사용 가능한 값은 클라이언트 스크립트 구현에 따라 다릅니다.

    이러한 속성에 액세스하려면 api.context.props.<page_property_name>을 사용합니다.

    예: 
    // A record page with property table could be accessed with
function isActivityStreamVisible({api}) {
  return api.context.props.table === 'incident';
}
    주:
    이러한 속성 값은 읽기 전용입니다. 스크립트에서 중첩된 객체 값을 변경하는 것은 지원되지 않습니다.

    API - api.context.session.<session_property>

    현재 사용자와 연결된 컨텍스트 세션 속성입니다.

    표 2. 사용 가능한 세션 속성
    이름 유형 설명
    isLoggedIn 부울 현재 사용자가 시스템에 로그인되어 있는지 여부를 나타내는 플래그입니다.
    가능한 값:
    • true: 현재 사용자가 로그인했습니다.
    • false: 현재 사용자가 로그인되어 있지 않습니다.
    properties.awaEnabled 문자열 현재 사용자에 대해 AWA(고급 작업 할당)의 작업 항목에 대한 자동 할당을 사용할 수 있는지 여부를 나타내는 시스템 속성 glide.awa.enabled입니다.
    가능한 값:
    • true: 사용자에 대해 AWA를 사용할 수 있습니다.
    • false: 사용자에 대해 AWA를 사용할 수 없습니다.

    자세한 내용은 Advanced Work Assignment와 함께 설치되는 구성요소를 참조하십시오.
    properties.forgetMe.value 문자열 로그인 정보가 캐시되지 않도록 로그인 페이지에서 내 기억 확인란을 제거할지 여부를 나타내는 glide.ui.forgetme 속성입니다.
    가능한 값:
    • true: 내 기억 확인란을 제거합니다.
    • false: 내 기억 확인란을 표시합니다.

    자세한 내용은 메일 주소 저장 제거를 참조하십시오.
    properties.sessionTimeLeft.value 문자열

    문자열로 강제 변환된 번호

    		 현재 세션이 시간 초과되기 전에 남은 마운트 시간을 판별하는 시스템 속성 glide.ui.session_timeleft입니다. 이 속성을 사용하여 제한 시간이 초과되기 전에 현재 세션의 범위를 확장하라는 메시지를 사용자에게 표시합니다.

    단위: 분
    properties.sessionTimeout.value 문자열

    문자열로 강제 변환된 번호

    		 초기 세션 시간 제한 값을 결정하는 시스템 속성 glide.ui.session_timeout입니다.

    단위: 분 - 1440분보다 큰 값은 1일로 처리됩니다.

    자세한 내용은 세션 활동 제한 시간을 참조하세요
    properties.trackingEnabled.value 문자열 기반 애플리케이션에 대한 웹 분석 라이브러리 로드 및 인스턴스화를 활성화/비활성화할지 여부를 나타내는 시스템 속성 glide.uxbuilder.tracking.enabled입니다 UI 빌더 .
    가능한 값:
    • true: 사용자에 대해 사용하도록 설정됩니다.
    • false: 사용자에 대해 사용할 수 없습니다.
    사용자.아바타 문자열 현재 사용자 아바타의 URL입니다.
    user.dateFormat 문자열 기본 날짜 형식입니다.
    사용자.도메인 문자열 현재 사용자의 도메인 경로입니다.
    user.firstName 문자열 현재 사용자의 이름입니다.
    user.fullName 문자열 현재 사용자의 이름과 성입니다.
    user.initials 문자열 현재 사용자의 이니셜입니다.
    user.language 문자열 현재 사용자가 사용하는 기본 언어입니다.
    user.preferences 개체 배열 사용자 기본 설정을 설명하는 이름-값 쌍입니다. 이러한 사용자 기본 설정은 사용자 기본 설정[sys_user_preference] 테이블에 기록으로 저장되며 사용자가 설정을 변경할 때마다 업데이트됩니다.

    자세한 내용은 Exploring user administration 문서를 참조하십시오.
    user.roles 배열 현재 사용자에게 할당된 역할의 목록(쉼표로 구분됨).
    user.sys_id 문자열 사용자 [sys_user] 테이블의 사용자 Sys_id입니다.
    사용자.시간 형식 문자열 사용자에 사용할 기본 시간 형식입니다.
    사용자.시간대 문자열 현재 사용자의 시간대입니다.
    사용자.timeZoneOffset 문자열 현재 사용자의 시간대 오프셋입니다.

    api - api.data.<data_resource_id>.lifecycle.lastFetchSucceeded

    지정된 데이터 자원 인스턴스에 대한 마지막 가져오기 시도가 성공적으로 완료되었는지 여부를 나타내는 부울 플래그입니다.

    값이 true이면 데이터 자원 인스턴스에 대한 마지막 가져오기 시도가 성공적으로 완료됩니다. 그렇지 않으면 false입니다.

    표 3. 필드
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.

    api - api.data.<data_resource_id>.addErrorMessage(페이로드 객체)

    현재 양식의 맨 위에 지정된 오류 메시지를 표시합니다.

    표 4. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    페이로드 객체 표시할 오류 메시지를 설명하는 객체입니다.
    "payload": {
  "message": "String"
}
    페이로드.메시지 문자열 표시할 오류 메시지입니다.
    표 5. 반환
    유형 설명
    없음 

    api.data.gform.addErrorMessage({message: 'Error message'});

    api -api.data.<data_resource_id>.addInfoMessage(payload 객체)

    현재 양식의 맨 위에 지정된 정보 메시지를 표시합니다.

    표 6. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    페이로드 객체 표시할 정보 메시지를 설명하는 객체입니다.
    "payload": {
  "message": "String"
}
    페이로드.메시지 문자열 표시할 정보 메시지입니다.
    표 7. 반환
    유형 설명
    없음 

    api.data.gform.addInfoMessage({message: 'Test message'});

    api - api.data.<data_resource_id>.addOption(페이로드 객체)

    지정된 선택 유형 필드에 옵션을 추가합니다.

    표 8. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    페이로드 객체 업데이트할 필드 값을 설명하는 객체입니다.
    "payload": {
  "choiceIndex": "String",
  "choiceLabel": "String",
  "choiceValue": "String",
  "fieldName": "String"
}
    payload.choiceIndex 문자열 옵션입니다. 옵션을 삽입할 선택 목록의 인덱스입니다.

    기본값: 선택 목록의 끝입니다.
    payload.choiceLabel 문자열 지정된 필드에 추가할 옵션의 레이블입니다.
    payload.choiceValue 문자열 지정된 필드에 추가할 옵션의 값입니다.
    payload.fieldName 문자열 지정된 옵션을 추가할 선택 유형 양식 필드의 이름입니다.
    표 9. 반환
    유형 설명
    없음 

    api.data.gform.addOption({fieldName: 'priority', choiceLabel: 'Extremely High', choiceValue: '10'});

    api - api.data.<data_resource_id>.addWarningMessage(payload 객체)

    현재 양식의 맨 위에 지정된 경고 메시지를 표시합니다.

    표 10. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    페이로드 객체 표시할 경고 메시지를 설명하는 객체입니다.
    "payload": {
  "message": "String"
}
    페이로드.메시지 문자열 표시할 경고 메시지입니다.
    표 11. 반환
    유형 설명
    없음 

    api.data.gform.addWarningMessage({message: 'Test message'});

    api - api.data.<data_resource_id>.clearMessage()

    현재 양식의 맨 위에서 모든 정보 메시지와 오류 메시지를 제거합니다.

    표 12. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    표 13. 반환
    유형 설명
    없음 

    api.data.gform.clearMessage();

    api - api.data.<data_resource_id>.clearOptions(페이로드 객체)

    지정된 선택 유형 필드에서 모든 옵션을 지웁니다.

    표 14. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    페이로드 객체 옵션을 지울 선택 유형 필드를 설명하는 객체입니다.
    "payload": {
  "fieldName": "String"
}
    payload.fieldName 문자열 옵션을 지울 선택 유형 필드의 이름입니다.
    표 15. 반환
    유형 설명
    없음 

    api.data.gform.clearOptions({fieldName: 'priority'});

    api - api.data.<data_resource_id>.executeUiAction(payload 객체)

    지정된 UI 작업을 실행합니다.

    표 16. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    페이로드 객체 실행할 UI 작업을 설명하는 객체입니다.
    "payload": {
  "actionSysId": "String"
}
    payload.actionSysId 문자열 실행할 UI 작업의 Sys_id입니다. UI 작업 [sys_ui_action] 테이블에 있습니다.
    표 17. 반환
    유형 설명
    없음 

    api.data.gform.executeUiAction({actionSysId: '60615ff90f730010ac7de6f8c4767e9a'});

    api - api.data.<data_resource_id>.execute(inputValues 객체)

    지정된 데이터 자원에 대해 실행 작업을 트리거합니다.

    이 메서드는 데이터 자원이 다음 유형 중 하나인 경우에만 사용할 수 있습니다.
    • 복합
    • GraphQL
    • REST
    • 스크립틀릿
    • 변환
    주:
    이 메서드는 해당 데이터 자원(sys_ux_data_broker_* 테이블) 기록에서 필드가 true로 설정된 경우에만 mutates_server_data 노출됩니다. api.data.<data_resource_Id>.refresh()에서 액세스할 수 있습니다.
    표 18. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    입력값 객체 지정된 데이터 자원에 전달할 객체입니다. 이 객체는 데이터 자원의 입력 매개변수를 따라야 합니다.
    표 19. 반환
    유형 설명
    없음

    이 코드 예제에서는 페이지의 전송 단추를 클릭할 때 호출되는 페이지 스크립트를 보여 줍니다. 이 페이지는 서버 데이터 자원 봇이 새 레코드를 생성하도록 구성됩니다.

    function handler({api}) {
  if (api.state.movieYear === 2020) {
    // The data resource used in this case specifies two input parameters: name and year
    api.data.create_movie_record.execute({
      name: api.state.movieName,
      year: api.state.movieYear
    });
  }
}

    api - api.data.<data_resource_id>.hideFieldMessage(payload 객체)

    지정된 필드 옆에 있는 가장 오래된 메시지를 숨기거나 필드와 연결된 모든 메시지를 지웁니다.

    표 20. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    페이로드 객체 숨길 필드 메시지를 설명하는 객체입니다.
    "payload": {
  "clearAll": Boolean,
  "fieldName": "String"
}
    페이로드.clearAll 부울 옵션입니다. 지정된 양식 필드와 연결된 모든 메시지를 지울지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 지정된 필드와 연결된 모든 메시지를 지웁니다.
    • false: 지정된 필드와 연결된 모든 메시지를 지우지 않습니다.

    기본값: false
    payload.fieldName 문자열 가장 오래된 메시지를 숨기거나 관련된 모든 메시지를 지울 양식 필드의 이름입니다.
    표 21. 반환
    유형 설명
    없음 

    api.data.gform.hideFieldMessage({fieldName: 'short_description'});

    api - api.data.<data_resource_id>.hideRelatedList(payload 객체)

    현재 양식에서 지정된 관련 목록을 숨깁니다.

    표 22. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    페이로드 객체 숨길 관련 목록을 설명하는 객체입니다.
    "payload": {
  "listTableName ": "String"
}
    payload.listTableName 문자열 숨길 관련 목록의 이름입니다. 관련 목록 [sys_ui_related_list] 테이블에 있습니다. 숨길 목록이 관계를 통해 이루어진 경우 이름 대신 목록의 sys_id 제공합니다.
    표 23. 반환
    유형 설명
    없음 

    api.data.gform.hideRelatedList({listTableName:'incident.parent_incident'});

    api - api.data.<data_resource_id>.hideRelatedLists()

    현재 양식에서 모든 관련 목록을 숨깁니다.

    표 24. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    표 25. 반환
    유형 설명
    없음 

    api.data.gform.hideRelatedLists();

    api - api.data.<data_resource_id>.refresh()

    지정된 변경되지 않는 데이터 자원 인스턴스에 대해 새로 고침 작업을 트리거합니다.

    데이터 자원에 의해 인출되는 기초 데이터가 변경되는 경우 이 메소드를 호출하십시오. 기록의 필드가 false로 설정된 경우 mutates_server_data 데이터 자원은 변경되지 않는 것으로 간주됩니다.

    이 메서드는 비동기식이며 지정된 데이터 리소스 인스턴스의 새로 고침을 트리거하는 내부 이벤트를 내보냅니다. 를 UI 빌더 사용하면 DATA_FETCH_SUCCEEDED 및 DATA_FETCH_FAILED 같은 데이터 자원 수명주기 이벤트에 대한 응답으로 클라이언트 스크립트를 트리거할 수 있습니다. 이러한 이벤트에 대한 자세한 내용은 이벤트 매핑을 참조하세요.

    이 메서드는 데이터 자원이 다음 유형 중 하나인 경우에만 사용할 수 있습니다.
    • 복합
    • GraphQL
    • REST
    • 스크립틀릿
    • 변환
    주:
    이 메서드는 해당 데이터 자원(sys_ux_data_broker_* 테이블) 기록에서 필드가 false로 설정된 경우에만 mutates_server_data 노출됩니다.
    표 26. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    표 27. 반환
    유형 설명
    없음

    이 코드 예제에서는 페이지에서 드롭다운 항목을 선택할 때 호출되는 페이지 스크립트를 보여 줍니다. 이 페이지는 문제 및 인시던트 테이블을 쿼리하는 두 개의 서버 데이터 리소스로 구성됩니다.

    function handler({api, event}) {
  const value = event.payload.value[0];
  if (value === 'problem')
    api.data.problem_list_1.refresh();
  else if(value === 'incident')
    api.data.incident_list_1.refresh();
}

    api - api.data.<data_resource_id>.reload()

    동일한 테이블과 sys_id 사용하여 현재 양식을 다시 로드합니다.

    표 28. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    표 29. 반환
    유형 설명
    없음 

    api.data.gform.reload();

    api - api.data.<data_resource_id>.removeOption(페이로드 객체)

    지정된 선택 유형 필드에서 옵션을 제거합니다.

    표 30. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    페이로드 객체 업데이트할 선택 유형 필드를 설명하는 객체입니다.
    "payload": {
  "choiceValue": "String",
  "fieldName": "String"
}
    payload.choiceValue 문자열 지정된 선택 유형 필드에서 제거할 옵션의 값입니다.
    payload.fieldName 문자열 지정된 값을 제거할 선택 유형 양식 필드의 이름입니다.
    표 31. 반환
    유형 설명
    없음 

    api.data.gform.removeOption({fieldName: 'priority', choiceValue: '1'});

    api - api.data.<data_resource_id>.save()

    UI 저장 작업을 사용하여 양식 제출을 트리거합니다.

    표 32. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    표 33. 반환
    유형 설명
    없음 

    api.data.gform.save();

    api - api.data.<data_resource_id>.setMandatory(객체 페이로드)

    지정된 양식 필드가 필수인지 여부를 설정합니다.

    표 34. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    페이로드 객체 업데이트할 필수 정보가 있는 필드를 설명하는 객체입니다.
    "payload": {
  "fieldName": "String",
  "mandatory": Boolean
}
    payload.fieldName 문자열 필수 값을 설정할 양식 필드의 이름입니다.
    페이로드.필수 부울 지정된 양식 필드가 필수임을 나타내는 플래그입니다. 이는 이 필드에 유효한 값이 포함되어 있지 않으면 양식을 저장할 수 없음을 의미합니다.
    유효한 값은 다음과 같습니다.
    • true: 필드가 필수입니다.
    • false: 필드는 선택 사항입니다.
    표 35. 반환
    유형 설명
    없음 

    api.data.gform.setMandatory({fieldName: 'short_description', mandatory: false});

    api - api.data.<data_resource_id>.setReadOnly(payload 객체)

    지정된 양식 필드의 읽기/쓰기 기능을 설정합니다.

    표 36. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    페이로드 객체 가독성 정보를 업데이트할 필드를 설명하는 객체입니다.
    "payload": {
  "fieldName": "String",
  "readonly": Boolean
}
    payload.fieldName 문자열 가독성을 설정할 양식 필드의 이름입니다.
    페이로드.읽기 전용 부울 지정된 양식 필드의 읽기/쓰기 기능을 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 필드가 읽기 전용입니다.
    • false: 필드 읽기/쓰기 상태입니다.
    표 37. 반환
    유형 설명
    없음 

    api.data.gform.setReadOnly({fieldName: 'short_description', readonly: false});

    api -api.data.<data_resource_id>.setValue(payload 객체)

    지정된 GlideForm 필드를 지정된 값으로 업데이트합니다. 필요에 따라 표시된 값을 동일한 지정된 값으로 업데이트할 수도 있습니다.

    양식의 값만 업데이트됩니다. 값은 데이터베이스에 저장되지 않습니다.

    표 38. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    페이로드 객체 값을 업데이트할 필드를 설명하는 객체입니다.
    "payload": {
  "displayValue": "String",
  "fieldName": "String",
  "value": "String"
}
    payload.displayValue 문자열 옵션입니다. 업데이트할 표시 값의 이름입니다. 비워 두면 표시 값이 수정되지 않습니다.
    payload.fieldName 문자열 업데이트할 양식 필드의 이름입니다.
    페이로드.값 문자열 필드를 업데이트할 값입니다.
    표 39. 반환
    유형 설명
    없음 

    api.data.gform.setValue({fieldName: 'short_description', value: 'short description'});

    api - api.data.<data_resource_id>.setVisible(payload 객체)

    지정된 양식 필드의 표시 여부를 설정합니다.

    표 40. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    페이로드 객체 가시성을 설정할 필드를 설명하는 객체입니다.
    "payload": {
  "fieldName": "String",
  "visibility": Boolean
}
    payload.fieldName 문자열 표시 여부를 설정할 양식 필드의 이름입니다.
    payload.visibility 부울 연결된 필드가 현재 양식에 표시되는지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 필드가 양식에 표시됩니다.
    • false: 필드가 양식에 표시되지 않습니다.
    표 41. 반환
    유형 설명
    없음 

    api.data.gform.setVisible({fieldName: 'short_description', visibility: false});

    api - api.data.<data_resource_id>.showFieldMessage(payload 객체)

    지정된 필드 옆에 지정된 메시지를 표시합니다.

    표 42. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    페이로드 객체 표시할 필드 메시지를 설명하는 객체입니다.
    "payload": {
  "fieldName": "String",
  "message": "String",
  "type": "String"
    payload.fieldName 문자열 메시지가 표시되어야 하는 필드의 이름입니다.
    페이로드.메시지 문자열 표시할 메시지입니다.
    페이로드.유형 문자열 옵션입니다. 표시할 메시지의 유형입니다.
    유효한 값은 다음과 같습니다.
    • error
    • 정보
    • warning

    기본값: info
    표 43. 반환
    유형 설명
    없음 

    api.data.gform.showFieldMessage({fieldName: 'short_description', message: 'Error message', type: 'error'});

    api - api.data.<data_resource_id>.showRelatedList(payload 객체)

    현재 양식에 지정된 관련 목록을 표시합니다.

    표 44. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    페이로드 객체 표시할 관련 목록을 설명하는 객체입니다.
    "payload": {
  "listTableName ": "String"
}
    payload.listTableName 문자열 표시할 관련 목록의 이름입니다. 관련 목록 [sys_ui_related_list] 테이블에 있습니다. 표시할 목록이 관계를 통해 이루어지는 경우 이름 대신 목록의 sys_id 제공합니다.
    표 45. 반환
    유형 설명
    없음 

    api.data.gform.showRelatedList({listTableName:'incident.parent_incident'});

    api - api.data.<data_resource_id>.showRelatedLists()

    현재 양식과 연결된 모든 관련 목록을 표시합니다.

    표 46. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    표 47. 반환
    유형 설명
    없음 

    api.data.gform.showRelatedLists();

    api - api.data.<data_resource_id>.submit()

    지정된 UI 작업을 사용하여 양식 제출을 트리거합니다.

    표 48. 매개변수
    이름 유형 설명
    data_resource_id 문자열 연결된 데이터 자원의 고유 식별자입니다. 이 메서드의 데이터 리소스는 Glide 양식(gform)을 기반으로 해야 합니다.

    사용 가능한 데이터 자원 인스턴스는 구성에 따라 다르며 에서 페이지에 UI 빌더데이터 자원을 추가할 때 정의됩니다.
    페이로드 객체 현재 양식을 제출하는 데 사용할 UI 작업을 설명하는 객체입니다.
    "payload": {
  "submitActionName": "String"
}
    payload.submitActionName 문자열 현재 양식을 제출하기 위해 실행할 UI 작업의 이름입니다.
    표 49. 반환
    유형 설명
    없음 

    api.data.gform.submit({submitActionName:'sysverb_ws_save'});

    api - api.emit(문자열, eventName, 객체 페이로드)

    지정된 이름과 페이로드를 가진 이벤트를 내보냅니다.

    내보내지는 이벤트 이름은 UX Macroponent 정의 [sys_ux_macroponent] 테이블에 저장된 연결된 페이지 정의의 디스패치된 이벤트 목록에 포함되어야 합니다. 이 표에 선언되지 않은 이벤트를 디스패치하는 api.emit 호출은 무시됩니다.

    이벤트에 대한 자세한 내용은 이벤트 작업을 참조하십시오.

    표 50. 매개변수
    이름 유형 설명
    eventName 문자열 내보낼 이벤트의 이름입니다. 이 이름은 UI 프레임워크 작업 명명 지침을 따라야 합니다.
    • ITEM_CHANGED와 같은 위쪽 뱀의 경우여야 합니다. 대문자의 모든 문자와 모든 공백이 밑줄로 대체되었습니다.
    • 과거형(예: BUTTON_CLICKED 또는 USER_SELECTED)이어야 합니다.

    이러한 작업 명명 지침에 대한 자세한 내용은 을 참조하십시오 https://developer.servicenow.com/dev.do#!/reference/now-experience/sandiego/ui-framework/main-concepts/dispatching-actions.
    페이로드 객체 옵션입니다. 발생한 이벤트와 함께 보낼 데이터가 들어 있는 객체입니다. 이 개체는 자유 형식이며 데이터를 수신하는 엔터티에 필요한 모든 데이터를 포함할 수 있습니다.
    주:
    기본 형식의 페이로드는 작동하지만 일관되지 않은 동작이 발생할 수 있습니다.
    표 51. 반환
    유형 설명
    없음

    다음 코드 예제에서는 연결된 items 페이로드와 함께 호출 NOW_UXF_PAGE#ADD_NOTIFICATIONS 된 이벤트를 내보내는 방법을 보여 줍니다.

    function handler({api}) { 
  api.emit('NOW_UXF_PAGE#ADD_NOTIFICATIONS', { 
    items: [
      { 
        id: 'alert1', 
        status: 'positive', 
        icon: 'check-circle-outline', 
        content: 'Here is some information!', 
        textLinkProps: { 
          label: 'More info',
          href: 'https://www.servicenow.com' 
        }, 
      action: {type: 'acknowledge'} 
      } 
    ] 
  }); 
}

    api - setState(문자열, stateParam, 임의의 값)

    지정된 클라이언트 상태 매개 변수의 값을 설정합니다.

    클라이언트 상태 매개 변수를 사용하여 페이지에서 공유 상태를 유지 관리합니다. 그런 다음 공유 상태를 페이지에 사용되는 구성 요소의 속성에 값으로 전달할 수 있습니다. 여러 페이지 스크립트에서 클라이언트 상태에 액세스하고 업데이트할 수도 있습니다. 일반적인 사용 사례는 페이지의 여러 양식 컨트롤에서 사용자가 입력한 값을 추적하는 것입니다. 양식이 제출되면 클라이언트 스크립트는 클라이언트 상태 매개변수에 저장된 모든 값을 사용하여 데이터 브로커로 새 레코드를 생성할 수 있습니다. 페이지에는 UI Builder를 통해 페이지에 대해 선언할 수 있는 하나 이상의 클라이언트 상태 매개변수가 있을 수 있습니다. 그런 다음 클라이언트 상태 매개변수를 하나 이상의 구성요소에 바인딩하여 클라이언트 상태 매개변수를 공유하거나 조치를 취할 수 있습니다.

    api.setState() 호출은 비동기식으로 실행되며 UI를 즉시 업데이트할 필요는 없습니다. 설정할 값이 클라이언트 상태 매개변수 또는 api 객체에 제공된 속성에 따라 달라 currentValue 지는 경우 api.setState() 메서드의 이 변형을 사용하여 오래된 값을 사용하지 않도록 해야 합니다.

    표 52. 매개변수
    이름 유형 설명
    스테이트팜 문자열 업데이트할 클라이언트 상태 매개변수의 이름입니다. 이 이름은 연결된 페이지의 클라이언트 상태 매개변수에서 선언되어야 합니다.

    클라이언트 상태 매개 변수 선언에 대한 자세한 내용은 클라이언트 상태 매개 변수 작업을 참조하세요.
    값 Any - 클라이언트 상태 매개 변수 선언과 동일해야 합니다. 지정된 클라이언트 상태 매개변수를 설정하는 값입니다.
    표 53. 반환
    유형 설명
    없음

    이 예는 now-input 구성요소에 입력 값이 설정될 때 이메일 클라이언트 상태 매개변수를 업데이트하기 위해 실행할 수 있는 스크립트를 보여줍니다.

    function handler({api, event}) {
    api.setState('email', event.payload.value);
}

    api - setState(문자열 stateParam, 함수 callbackFn)

    지정된 클라이언트 상태 매개변수의 값을 지정된 콜백 함수에서 반환된 값으로 설정합니다.

    콜백 함수는 두 개의 속성 currentValue (및 api)이 있는 객체와 함께 호출됩니다. 함수는 속성 또는 개체를 직접 변경 currentValue 해서는 안 됩니다 api .

    클라이언트 상태 매개 변수를 사용하여 페이지에서 공유 상태를 유지 관리합니다. 그런 다음 공유 상태를 페이지에 사용되는 구성 요소의 속성에 값으로 전달할 수 있습니다. 여러 페이지 스크립트에서 클라이언트 상태에 액세스하고 업데이트할 수도 있습니다. 일반적인 사용 사례는 페이지의 여러 양식 컨트롤에서 사용자가 입력한 값을 추적하는 것입니다. 양식이 제출되면 클라이언트 스크립트는 클라이언트 상태 매개변수에 저장된 모든 값을 사용하여 데이터 브로커로 새 레코드를 생성할 수 있습니다. 페이지에는 UI Builder를 통해 페이지에 대해 선언할 수 있는 하나 이상의 클라이언트 상태 매개변수가 있을 수 있습니다. 그런 다음 클라이언트 상태 매개변수를 하나 이상의 구성요소에 바인딩하여 클라이언트 상태 매개변수를 공유하거나 조치를 취할 수 있습니다.

    api.setState() 호출은 비동기식으로 실행되며 UI를 즉시 업데이트할 필요는 없습니다. 설정할 값이 클라이언트 상태 매개변수 또는 api 객체에 제공된 속성에 따라 달라 currentValue 지는 경우 api.setState() 메서드의 이 변형을 사용하여 오래된 값을 사용하지 않도록 해야 합니다.

    표 54. 매개변수
    이름 유형 설명
    스테이트팜 문자열 업데이트할 클라이언트 상태 매개변수의 이름입니다. 이 이름은 연결된 페이지의 클라이언트 상태 매개변수에서 선언되어야 합니다.

    클라이언트 상태 매개 변수 선언에 대한 자세한 내용은 클라이언트 상태 매개 변수 작업을 참조하세요.
    콜백 기능 값을 가져오기 위해 실행할 콜백 함수입니다.
    표 55. 반환
    유형 설명
    없음

    이 예제에서는 api.setState 를 사용하여 사용자를 페이지에 로그인하는 방법을 보여줍니다.

    function handler({api, event}) {
  const {name, value} = event.payload;
  if (name === 'username' || name === 'password') {
    // Update the loginParameters state object with the username/password value
    api.setState('loginParameters', ({currentValue}) => {
      return {
        ...currentValue,
        [name]: value
      };
    });
  }
}

    api - api.state.<client_state_parameter_name>

    지정된 클라이언트 상태 매개변수의 현재 값입니다.

    표 56. 필드
    이름 유형 설명
    <client_state_parameter_name> 임의 사용 가능한 클라이언트 상태 매개변수는 페이지 구성에 따라 다릅니다. 클라이언트 상태 매개변수의 이름입니다. 사용 가능한 클라이언트 상태는 클라이언트 스크립트 구현에 따라 다릅니다.

    사용 가능한 클라이언트 상태에 액세스하려면 api.state.<client_state_name>을 사용합니다.

    예: 
    function showRelatedLists({api}) { 
  return !api.state.isCustomListSelected; 
}
    주:
    이러한 속성 값은 읽기 전용입니다. 클라이언트 상태 매개변수를 업데이트하려면 api.setState()를 사용하십시오. 스크립트에서 중첩된 객체 값을 변경하는 것은 지원되지 않습니다.