TMFTopicEventAPIUtilOOB - 범위 지정됨

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

    • TMFTopicEventAPIUtilOOB 스크립트 포함에는 이벤트 [em_event] 테이블에서 이벤트를 생성, 업데이트 및 삭제하기 위해 외부 트리거 정의에 의해 트리거되는 이벤트 알림 관리 Open API 요청을 처리하는 함수가 포함되어 있습니다.

    이 스크립트 포함에는 이벤트 알림 관리 Open API에 대한 기본 구현이 포함되어 있습니다. 이 API의 기본 기능을 변경하려면 TMFTopicEventAPIUtil 스크립트 포함에서 이 스크립트 포함에 포함된 함수를 재정의해야 합니다.

    이 스크립트 포함은 sn_ind_tmf642 네임스페이스에서 실행되며 Telecommunications Alarm Management Open API(app-ind-tmfapi-alarm) 플러그인을 활성화해야 합니다.

    이러한 함수를 재정의하는 방법에 대한 자세한 내용은 Event Notification Management Open API 개발자 가이드.

    Event Notification Management Open API에 대한 자세한 내용은 을 참조하십시오이벤트 알림 관리 개방형 API.

    TMFTopicEventAPIUtilOOB - getAlarmChangeEventSchema()

    ALARM_CHANGE_EVENT_SCHEMA(경보 변경 이벤트)를 처리할 때 사용되는 페이로드 스키마를 반환합니다.

    이 함수는 AlarmChangeEvent 플로우 작업 호출 프로세스의 일부로 호출됩니다. TMFTopicEventAPIUtil 스크립트 포함의 기본 기능과 TMFAlarmAPIConstants 스크립트 포함의 스키마를 재정의하여 이 함수의 기능을 변경할 수 있습니다.

    표 1. 매개변수
    이름 유형 설명
    없음
    표 2. 반환
    유형 설명
    문자열 TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA에 정의된 스키마입니다. 
    // Schema validation
var schema = this.getAlarmChangeEventSchema();
var validationResults = this.schemaValidator.validateJSON(changeAlarmPayload, schema);
if (validationResults.length > 0) {
  this.responseObject.status = TMFAlarmAPIConstants.EVENT_TRANSFORMATION_ERROR;
  this.responseObject.responseError.errorMessage = TMFAlarmAPIConstants.MESSAGES.CHANGE_ERROR;
  this.responseObject.responseError.errorReason = TMFAlarmAPIConstants.MESSAGES.CHANGE_ERROR_PAYLOAD;
  var messageDetails = [];
  for (var i = 0; i < validationResults.length; i++)
    messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
  this.responseObject.responseError.details = messageDetails;
  return this.responseObject;

    TMFTopicEventAPIUtilOOB - getAlarmCreateEventSchema()

    경보 생성 이벤트(ALARM_CREATE_EVENT_SCHEMA)를 처리할 때 사용되는 페이로드 스키마를 반환합니다.

    이 함수는 AlarmCreateEvent 플로우 작업 호출 프로세스의 일부로 호출됩니다. TMFTopicEventAPIUtil 스크립트 포함의 기본 기능과 TMFAlarmAPIConstants 스크립트 포함의 스키마를 재정의하여 이 함수의 기능을 변경할 수 있습니다.

    표 3. 매개변수
    이름 유형 설명
    없음
    표 4. 반환
    유형 설명
    문자열 TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA에 정의된 스키마 
    // Schema validation
var schema = this.getAlarmCreateEventSchema();
var validationResults = this.schemaValidator.validateJSON(eventAlarmObject, schema);
if (validationResults.length > 0) {
  this.responseObject.status = TMFAlarmAPIConstants.EVENT_TRANSFORMATION_ERROR;
  this.responseObject.responseError.errorMessage = TMFAlarmAPIConstants.MESSAGES.CREATE_ERROR;
  this.responseObject.responseError.errorReason = TMFAlarmAPIConstants.MESSAGES.CREATE_ERROR_PAYLOAD;
  var messageDetails = [];
  for (var i = 0; i < validationResults.length; i++)
    messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
  this.responseObject.responseError.details = messageDetails;
  return this.responseObject;
}

    TMFTopicEventAPIUtilOOB - getAlarmDeleteEventSchema()

    경보 삭제 이벤트(ALARM_DELETE_EVENT_SCHEMA)를 처리할 때 사용되는 페이로드 스키마를 반환합니다.

    이 함수는 AlarmDeleteEvent 플로우 작업 호출 프로세스의 일부로 호출됩니다. TMFTopicEventAPIUtil 스크립트 포함의 기본 기능과 TMFAlarmAPIConstants 스크립트 포함의 스키마를 재정의하여 이 함수의 기능을 변경할 수 있습니다.

    표 5. 매개변수
    이름 유형 설명
    없음
    표 6. 반환
    유형 설명
    문자열 TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA에 정의된 스키마입니다. 
    // Schema validation
var schema = this.getAlarmDeleteEventSchema();
var validationResults = this.schemaValidator.validateJSON(deleteAlarmPayload, schema);
if (validationResults.length > 0) {
  this.responseObject.status = TMFAlarmAPIConstants.EVENT_TRANSFORMATION_ERROR;
  this.responseObject.responseError.errorMessage = TMFAlarmAPIConstants.MESSAGES.CLEAR_ERROR;
  this.responseObject.responseError.errorReason = TMFAlarmAPIConstants.MESSAGES.CLEAR_ERROR_PAYLOAD;
  var messageDetails = [];
  for (var i = 0; i < validationResults.length; i++)
    messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
  this.responseObject.responseError.details = messageDetails;
  return this.responseObject;
}

    TMFTopicEventAPIUtilOOB - mapAlarmChangeObjectToEvent(alarmObject, GlideRecord newEventGr)

    전달된 변경 요청 페이로드의 매개변수를 이벤트 [em_event] 테이블의 지정된 기록에 있는 필드에 매핑합니다.

    필드 매핑을 사용자 지정하여 이벤트 [em_event] 테이블에 데이터를 추가하거나 기본 필드 매핑을 변경할 수 있습니다. 매핑을 수정하려면 TMFTopicEventAPIUtil 스크립트 포함에서 동일한 이름과 매개 변수를 가진 함수를 만들어 TMFTopicEventAPIUtilOOB 스크립트 포함의 매핑을 재정의합니다. 매핑에 필드를 추가하는 경우 이러한 필드를 연결된 스키마(TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA)에도 추가해야 합니다.

    이 함수는 transformAndPersistChangeEvent() 함수의 일부로 호출됩니다.

    표 7. 매개변수
    이름 유형 설명
    알람오브젝트 객체 페이로드는 TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA에 정의된 스키마에 정의된 것과 일치해야 합니다.
    newEventGr GlideRecord 이벤트 [em_event] 테이블에서 업데이트할 기록의 GlideRecord입니다.
    표 8. 반환
    유형 설명
    없음 
    this.mapAlarmChangeObjectToEvent(additionalInfoObj, newEventGr);

var id = newEventGr.insert();
return gs.nil(id) ? id : newEventGr.message_key;

    TMFTopicEventAPIUtilOOB - mapCreateAlarmObjectToEvent(Object alarmObject, GlideRecord eventGr)

    전달된 요청 페이로드 생성의 매개변수를 이벤트 [em_event] 테이블의 지정된 기록에 있는 필드에 매핑합니다.

    필드 매핑을 사용자 지정하여 이벤트 [em_event] 테이블에 데이터를 추가하거나 기본 필드 매핑을 변경할 수 있습니다. 매핑을 수정하려면 TMFTopicEventAPIUtil 스크립트 포함에서 동일한 이름과 매개 변수를 가진 함수를 만들어 TMFTopicEventAPIUtilOOB 스크립트 포함의 매핑을 재정의합니다. 매핑에 필드를 추가하는 경우 이러한 필드를 연결된 스키마(TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA)에도 추가해야 합니다.

    이 함수는 transformAndPersistAlarmCreateEvent() 함수의 일부로 호출됩니다.

    표 9. 매개변수
    이름 유형 설명
    알람오브젝트 객체 페이로드는 TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA에 정의된 스키마에 정의된 것과 일치해야 합니다.
    eventGr GlideRecord 이벤트 [em_event] 테이블의 기록 GlideRecord입니다.
    표 10. 반환
    유형 설명
    없음 
    this.mapCreateAlarmObjectToEvent(eventAlarmObject, eventGr);
var id = eventGr.insert();
return gs.nil(id) ? id : msgKey;

    TMFTopicEventAPIUtilOOB - mapDeleteAlarmObjectToEvent(객체 additionalInfoObj, GlideRecord newEventGr)

    전달된 삭제 요청 페이로드의 매개변수를 이벤트 [em_event] 테이블의 지정된 기록에 있는 필드에 매핑합니다.

    필드 매핑을 사용자 지정하여 이벤트 [em_event] 테이블에 데이터를 추가하거나 기본 필드 매핑을 변경할 수 있습니다. 매핑을 수정하려면 TMFTopicEventAPIUtil 스크립트 포함에서 동일한 이름과 매개 변수를 가진 함수를 만들어 TMFTopicEventAPIUtilOOB 스크립트 포함의 매핑을 재정의합니다. 매핑에 필드를 추가하는 경우 이러한 필드를 연결된 스키마(TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA)에도 추가해야 합니다.

    이 함수는 transformAndPersistDeleteEvent() 함수의 일부로 호출됩니다.

    표 11. 매개변수
    이름 유형 설명
    알람오브젝트 객체 페이로드는 TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA에 정의된 스키마에 정의된 것과 일치해야 합니다.
    newEventGr GlideRecord 페이로드의 필드를 이벤트 [em_event] 테이블의 필드에 매핑하는 데 사용할 기록의 GlideRecord입니다.
    표 12. 반환
    유형 설명
    없음 
    this.mapDeleteAlarmObjectToEvent(additionalInfoObj, newEventGr);
var id = newEventGr.insert();
return gs.nil(id) ? id : newEventGr.message_key;

    TMFTopicEventAPIUtilOOB - prepareEventAlarmRecordResponse(String, msgKey, 객체, alarmObject, 객체, responseObject)

    이벤트 지우기를 포함하여 이벤트 작성 또는 업데이트 후에 응답 객체를 생성합니다.

    이 함수는 processAlarmCreateEvent(),processChangeAlarm() 및 processDeleteAlarmEvent() 함수에 의해 호출됩니다. TMFTopicEventAPIUtil 스크립트 포함에서 기본 기능을 재정의하여 이 함수의 기능을 변경할 수 있습니다.

    표 13. 매개변수
    이름 유형 설명
    메시지 키 문자열 메시지 키입니다. 이 키는 이벤트가 생성될 때 생성됩니다. 이벤트 [em_event] 테이블의 메시지 키 필드에 있습니다.
    알람오브젝트 객체 처리할 이벤트 페이로드입니다. 이 페이로드의 형식은 처리 중인 이벤트 유형과 상관관계가 있어야 합니다. 이러한 페이로드에 대한 스키마는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject 객체 빈 응답 객체입니다. 이 객체를 사용하여 페이로드 스키마 검증과 관련된 문제를 기록합니다.
    데이터 유형: 객체
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject입니다.responseError 객체 확인 중에 발생한 오류에 대한 상세 정보입니다.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject입니다.responseError를 일으킵니다.세부 정보 배열 호출 루틴에 다시 전달할 추가 정보입니다.
    예:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject입니다.responseError를 일으킵니다.오류 메시지 문자열 발생한 오류를 설명하는 오류 메시지입니다. 사용 가능한 오류 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.responseError를 일으킵니다.오류 이유 문자열 엔드포인트가 실패한 이유입니다. 사용 가능한 오류 이유는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.상태 문자열 함수 호출의 상태입니다. 사용 가능한 상태 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.successResponse 객체 함수 호출의 성공적인 응답입니다. 예를 들어 이 값에 페이로드 객체를 저장할 수 있습니다.
    표 14. 반환
    유형 설명
    responseObject 함수 호출의 상태에 대한 세부 정보입니다.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject입니다.상태 함수 호출의 상태입니다. 사용 가능한 상태 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.successResponse 함수 호출의 성공적인 응답입니다. 예를 들어 이 값에 페이로드 객체를 저장할 수 있습니다.
    responseObject입니다.responseError 확인 중에 발생한 오류에 대한 상세 정보입니다.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject입니다.responseError를 일으킵니다.세부 정보 호출 루틴에 다시 전달할 추가 정보입니다.
    예:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject입니다.responseError를 일으킵니다.오류 메시지 발생한 오류를 설명하는 오류 메시지입니다. 사용 가능한 오류 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.responseError를 일으킵니다.오류 이유 엔드포인트가 실패한 이유입니다. 사용 가능한 오류 이유는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다. 
    processDeleteAlarm: function(additionalInfoObj, gr, deleteAlarmPayload, responseObject) {
var msgKey = this.transformAndPersistDeleteEvent(additionalInfoObj, gr);
var responsePayload = this.prepareEventAlarmRecordResponse(msgKey, deleteAlarmPayload, responseObject);
this._logger.logDebug("processDeleteAlarmEvent");
return responsePayload;
},

    TMFTopicEventAPIUtilOOB - processAlarmChangeEvent(Object changeAlarmPayload)

    가 AlarmChangeNotification으로 설정된 경우 eventType 이벤트 [em_event] 테이블의 기록 업데이트 프로세스를 시작합니다.

    이 함수는 AlarmChangeEvent 플로우 작업에 의해 호출됩니다. TMFTopicEventAPIUtil 스크립트 포함에서 기본 기능을 재정의하여 이 함수의 기능을 변경할 수 있습니다.

    표 15. 매개변수
    이름 유형 설명
    changeAlarmPayload 객체 처리할 이벤트 변경 페이로드입니다. 페이로드는 TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA에 정의된 스키마와 일치해야 합니다.
    표 16. 반환
    유형 설명
    responseObject 함수 호출의 상태에 대한 세부 정보입니다.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject입니다.responseError 확인 중에 발생한 오류에 대한 상세 정보입니다.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject입니다.responseError를 일으킵니다.세부 정보 호출 루틴에 다시 전달할 추가 정보입니다.
    예:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject입니다.responseError를 일으킵니다.오류 메시지 발생한 오류를 설명하는 오류 메시지입니다. 사용 가능한 오류 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.responseError를 일으킵니다.오류 이유 엔드포인트가 실패한 이유입니다. 사용 가능한 오류 이유는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.상태 함수 호출의 상태입니다. 사용 가능한 상태 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.successResponse 함수 호출의 성공적인 응답입니다. 예를 들어 이 값에 페이로드 객체를 저장할 수 있습니다. 
    Called by the AlarmChangeEvent flow action

    TMFTopicEventAPIUtilOOB - processAlarmCreateEvent(Object eventAlarmObject)

    가 eventTypeAlarmCreateNotification으로 설정된 경우 이벤트 [em_event] 테이블에서 기록 생성 프로세스를 시작합니다.

    이 함수는 AlarmCreateEvent 플로우 작업에 의해 호출됩니다. TMFTopicEventAPIUtil 스크립트 포함에서 기본 기능을 재정의하여 이 함수의 기능을 변경할 수 있습니다.

    표 17. 매개변수
    이름 유형 설명
    eventAlarm객체 객체 이벤트가 처리할 페이로드를 생성합니다. 페이로드는 TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA에 정의된 스키마와 일치해야 합니다.
    표 18. 반환
    유형 설명
    responseObject 함수 호출의 상태에 대한 세부 정보입니다.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject입니다.responseError 확인 중에 발생한 오류에 대한 상세 정보입니다.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject입니다.responseError를 일으킵니다.세부 정보 호출 루틴에 다시 전달할 추가 정보입니다.
    예:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject입니다.responseError를 일으킵니다.오류 메시지 발생한 오류를 설명하는 오류 메시지입니다. 사용 가능한 오류 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.responseError를 일으킵니다.오류 이유 엔드포인트가 실패한 이유입니다. 사용 가능한 오류 이유는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.상태 함수 호출의 상태입니다. 사용 가능한 상태 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.successResponse 함수 호출의 성공적인 응답입니다. 예를 들어 이 값에 페이로드 객체를 저장할 수 있습니다. 
    Called by AlarmCreateEvent flow action.

    TMFTopicEventAPIUtilOOB - processDeleteAlarmEvent(객체 deleteAlarmPayload)

    가 AlarmDeleteNotification으로 설정된 경우 eventType 이벤트 [em_event] 테이블에서 경보 이벤트를 지우는 프로세스를 시작합니다.

    이 함수는 상태 필드를 지우고 이벤트 경보를 닫습니다. 또한 전달된 페이로드의 모든 매개변수를 업데이트합니다.

    이 함수는 AlarmDeleteEvent 흐름 작업에 의해 호출됩니다. TMFTopicEventAPIUtil 스크립트 포함에서 기본 기능을 재정의하여 이 함수의 기능을 변경할 수 있습니다.

    표 19. 매개변수
    이름 유형 설명
    deleteAlarmPayload 객체 처리할 이벤트 삭제 페이로드입니다. 페이로드는 TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA에 정의된 스키마와 일치해야 합니다.
    표 20. 반환
    유형 설명
    responseObject 함수 호출의 상태에 대한 세부 정보입니다.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject입니다.responseError 확인 중에 발생한 오류에 대한 상세 정보입니다.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject입니다.responseError를 일으킵니다.세부 정보 호출 루틴에 다시 전달할 추가 정보입니다.
    예:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject입니다.responseError를 일으킵니다.오류 메시지 발생한 오류를 설명하는 오류 메시지입니다. 사용 가능한 오류 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.responseError를 일으킵니다.오류 이유 엔드포인트가 실패한 이유입니다. 사용 가능한 오류 이유는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.상태 함수 호출의 상태입니다. 사용 가능한 상태 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.successResponse 함수 호출의 성공적인 응답입니다. 예를 들어 이 값에 페이로드 객체를 저장할 수 있습니다. 
    Called by AlarmDeleteEvent flow action.

    TMFTopicEventAPIUtilOOB - transformAndPersistAlarmCreateEvent(객체 alarmObject)

    연결된 이벤트 생성 매핑 값을 사용하여 전달된 이벤트 생성 페이로드를 변환하고 이벤트 [em_event] 테이블에 정보를 저장합니다.

    이 함수는 흐름 작업의 일부로 processAlarmCreateEvent() 함수에 의해 호출됩니다. TMFTopicEventAPIUtil 스크립트 포함에서 기본 기능을 재정의하여 이 함수의 기능을 변경할 수 있습니다.

    표 21. 매개변수
    이름 유형 설명
    알람오브젝트 객체 이벤트 [em_event] 테이블에서 기록을 생성하는 데 사용할 페이로드입니다. 페이로드는 TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA에 정의된 스키마와 일치해야 합니다.
    표 22. 반환
    유형 설명
    문자열 이벤트의 고유 ID(메시지 키)입니다.

    이 함수는 AlarmCreateEvent 흐름 작업에 의해서만 호출되므로 코드 예제가 제공되지 않습니다.

    TMFTopicEventAPIUtilOOB - transformAndPersistChangeEvent(객체 additionalInfoObj, GlideRecord existingGr)

    관련 변경 이벤트 매핑 값을 사용하여 전달된 변경 이벤트 페이로드를 변환하고 업데이트된 정보를 이벤트 [em_event] 테이블 내의 전달된 GlideRecord에 저장합니다.

    이 함수는 흐름 작업의 일부로 processAlarmChangeEvent() 함수에 의해 호출됩니다. TMFTopicEventAPIUtil 스크립트 포함에서 기본 기능을 재정의하여 이 함수의 기능을 변경할 수 있습니다.

    표 23. 매개변수
    이름 유형 설명
    additionalInfoObj 객체 매개변수에 지정된 기록의 필드를 업데이트하는 데 사용할 페이로드입니다 existingGr . 페이로드는 TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA에 정의된 스키마와 일치해야 합니다.
    기존GR GlideRecord 업데이트할 이벤트 [em_event] 테이블에 있는 이벤트 기록의 GlideRecord입니다.
    표 24. 반환
    유형 설명
    문자열 이벤트의 고유 ID(메시지 키)입니다.

    이 함수는 AlarmChangeEvent 흐름 작업에 의해서만 호출되므로 코드 예제가 제공되지 않습니다.

    TMFTopicEventAPIUtilOOB - transformAndPersistDeleteEvent(Object additionalInfoObj GlideRecord existingGr)

    연결된 삭제 이벤트 매핑 값을 사용하여 전달된 삭제(지우기) 이벤트 페이로드를 변환하고 이벤트 [em_event] 테이블 내에서 전달된 GlideRecord에 업데이트된 정보를 저장합니다.

    이 함수는 흐름 작업의 일부로 >processAlarmDeleteEvent() 함수에 의해 호출됩니다. TMFTopicEventAPIUtil 스크립트 포함에서 기본 기능을 재정의하여 이 함수의 기능을 변경할 수 있습니다.

    표 25. 매개변수
    이름 유형 설명
    additionalInfoObj 객체 매개변수에 지정된 기록에서 지우기 이벤트 필드를 업데이트하는 데 사용할 페이로드입니다 existingGr . 페이로드는 TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA에 정의된 스키마와 일치해야 합니다.
    기존GR GlideRecord 경보를 지울 이벤트 [em_event] 테이블에 있는 이벤트 기록의 GlideRecord입니다.
    표 26. 반환
    유형 설명
    문자열 이벤트의 고유 ID(메시지 키)입니다.

    이 함수는 AlarmDeleteEvent 흐름 작업에 의해서만 호출되므로 코드 예제가 제공되지 않습니다.

    TMFTopicEventAPIUtilOOB - validateSubscription(Object eventAlarmObject, Object responseObject)

    구독에 대한 유효성 검사를 수행합니다.

    이 유효성 검사에는 이벤트 알림을 만드는 데 사용되는 콜백 URL과 eventType 페이로드가 등록되었는지 확인하는 작업이 포함됩니다.

    이 함수는 processAlarmCreateEvent(),processChangeAlarm() 및 processDeleteAlarmEvent() 함수에 의해 호출됩니다. TMFTopicEventAPIUtil 스크립트 포함에서 기본 기능을 재정의하여 이 함수의 기능을 변경할 수 있습니다.

    표 27. 매개변수
    이름 유형 설명
    eventAlarm객체 객체 확인할 이벤트 페이로드입니다. 이 페이로드의 형식은 처리 중인 이벤트 유형과 상관관계가 있어야 합니다. 이러한 페이로드에 대한 스키마는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject 객체 빈 응답 객체입니다. 이 객체를 사용하여 페이로드 스키마 검증과 관련된 문제를 기록합니다.
    데이터 유형: 객체
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject입니다.상태 문자열 함수 호출의 상태입니다. 사용 가능한 상태 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.successResponse 객체 함수 호출의 성공적인 응답입니다. 예를 들어 이 값에 페이로드 객체를 저장할 수 있습니다.
    responseObject입니다.responseError 객체 확인 중에 발생한 오류에 대한 상세 정보입니다.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject입니다.responseError를 일으킵니다.세부 정보 배열 호출 루틴에 다시 전달할 추가 정보입니다.
    예:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject입니다.responseError를 일으킵니다.오류 메시지 문자열 발생한 오류를 설명하는 오류 메시지입니다. 사용 가능한 오류 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.responseError를 일으킵니다.오류 이유 문자열 엔드포인트가 실패한 이유입니다. 사용 가능한 오류 이유는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    표 28. 반환
    유형 설명
    responseObject 함수 호출의 상태에 대한 세부 정보입니다.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject입니다.responseError 확인 중에 발생한 오류에 대한 상세 정보입니다.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject입니다.responseError를 일으킵니다.세부 정보 호출 루틴에 다시 전달할 추가 정보입니다.
    예:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject입니다.responseError를 일으킵니다.오류 메시지 발생한 오류를 설명하는 오류 메시지입니다. 사용 가능한 오류 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.responseError를 일으킵니다.오류 이유 엔드포인트가 실패한 이유입니다. 사용 가능한 오류 이유는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.상태 함수 호출의 상태입니다. 사용 가능한 상태 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.successResponse 함수 호출의 성공적인 응답입니다. 예를 들어 이 값에 페이로드 객체를 저장할 수 있습니다.

    이 함수는 AlarmCHANGEEvent 흐름 작업에 의해서만 호출되므로 코드 예제가 제공되지 않습니다.

    TMFTopicEventAPIUtilOOB - verifyAlarmChangeEventPayload(객체 changeAlarmPayload, 객체 responseObject)

    전달된 변경 이벤트 페이로드에 대한 추가 검증을 정의하는 기능을 제공합니다.

    이 함수는 흐름 작업의 일부로 processAlarmChangeEvent() 함수에 의해 호출됩니다. 현재 변경 페이로드에 대해 제공된 추가 페이로드 확인이 없습니다. TMFTopicEventAPIUtil 스크립트 포함의 기본 기능을 재정의하여 이 함수에 대한 기능을 추가할 수 있습니다.

    표 29. 매개변수
    이름 유형 설명
    changeAlarmPayload 객체 확인할 페이로드입니다. 페이로드는 TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA에 정의된 스키마와 일치해야 합니다.
    responseObject 객체 빈 응답 객체입니다. 이 객체를 사용하여 페이로드 스키마 검증과 관련된 문제를 기록합니다.
    데이터 유형: 객체
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject입니다.responseError 객체 확인 중에 발생한 오류에 대한 상세 정보입니다.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject입니다.responseError를 일으킵니다.세부 정보 배열 호출 루틴에 다시 전달할 추가 정보입니다.
    예:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject입니다.responseError를 일으킵니다.오류 메시지 문자열 발생한 오류를 설명하는 오류 메시지입니다. 사용 가능한 오류 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.responseError를 일으킵니다.오류 이유 문자열 엔드포인트가 실패한 이유입니다. 사용 가능한 오류 이유는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.상태 문자열 함수 호출의 상태입니다. 사용 가능한 상태 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.successResponse 객체 함수 호출의 성공적인 응답입니다. 예를 들어 이 값에 페이로드 객체를 저장할 수 있습니다.
    표 30. 반환
    유형 설명
    responseObject 함수 호출의 상태에 대한 세부 정보입니다.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject입니다.responseError 확인 중에 발생한 오류에 대한 상세 정보입니다.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject입니다.responseError를 일으킵니다.세부 정보 호출 루틴에 다시 전달할 추가 정보입니다.
    예:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject입니다.responseError를 일으킵니다.오류 메시지 발생한 오류를 설명하는 오류 메시지입니다. 사용 가능한 오류 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.responseError를 일으킵니다.오류 이유 엔드포인트가 실패한 이유입니다. 사용 가능한 오류 이유는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.상태 함수 호출의 상태입니다. 사용 가능한 상태 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.successResponse 함수 호출의 성공적인 응답입니다. 예를 들어 이 값에 페이로드 객체를 저장할 수 있습니다. 
     // Apply customized validations if applicable, defaults to no error
var changePayloadResponse = this.verifyAlarmChangeEventPayload(changeAlarmPayload, this.responseObject);
if (!gs.nil(changePayloadResponse.responseError.errorMessage))
  return changePayloadResponse;

    TMFTopicEventAPIUtilOOB - verifyAlarmCreateEventPayload(객체 alarmObject, 객체 responseObject)

    전달된 이벤트 생성 페이로드에 대한 추가 검증을 정의하는 기능을 제공합니다.

    이 함수는 흐름 작업의 일부로 processAlarmCreateEvent() 함수에 의해 호출됩니다. 현재 페이로드 생성에 대한 추가 페이로드 확인이 제공되지 않았습니다. TMFTopicEventAPIUtil 스크립트 포함의 기본 기능을 재정의하여 이 함수에 대한 기능을 추가할 수 있습니다.

    표 31. 매개변수
    이름 유형 설명
    alarm페이로드 객체 확인할 페이로드입니다. 페이로드는 TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA에 정의된 스키마와 일치해야 합니다.
    responseObject 객체 빈 응답 객체입니다. 이 객체를 사용하여 페이로드 스키마 검증과 관련된 문제를 기록합니다.
    데이터 유형: 객체
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject입니다.상태 문자열 함수 호출의 상태입니다. 사용 가능한 상태 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.successResponse 객체 함수 호출의 성공적인 응답입니다. 예를 들어 이 값에 페이로드 객체를 저장할 수 있습니다.
    responseObject입니다.responseError 객체 확인 중에 발생한 오류에 대한 상세 정보입니다.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject입니다.responseError를 일으킵니다.세부 정보 배열 호출 루틴에 다시 전달할 추가 정보입니다.
    예:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject입니다.responseError를 일으킵니다.오류 메시지 문자열 발생한 오류를 설명하는 오류 메시지입니다. 사용 가능한 오류 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.responseError를 일으킵니다.오류 이유 문자열 엔드포인트가 실패한 이유입니다. 사용 가능한 오류 이유는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    표 32. 반환
    유형 설명
    responseObject 함수 호출의 상태에 대한 세부 정보입니다.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject입니다.responseError 확인 중에 발생한 오류에 대한 상세 정보입니다.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject입니다.responseError를 일으킵니다.세부 정보 호출 루틴에 다시 전달할 추가 정보입니다.
    예:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject입니다.responseError를 일으킵니다.오류 메시지 발생한 오류를 설명하는 오류 메시지입니다. 사용 가능한 오류 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.responseError를 일으킵니다.오류 이유 엔드포인트가 실패한 이유입니다. 사용 가능한 오류 이유는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.상태 함수 호출의 상태입니다. 사용 가능한 상태 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.successResponse 함수 호출의 성공적인 응답입니다. 예를 들어 이 값에 페이로드 객체를 저장할 수 있습니다. 
    // Apply customized validations if applicable, defaults to no error
var creatPayloadResponse = this.verifyAlarmCreateEventPayload(eventAlarmObject, this.responseObject);
if (!gs.nil(creatPayloadResponse.responseError.errorMessage))
  return creatPayloadResponse;

    TMFTopicEventAPIUtilOOB - verifyDeleteEventPayload(객체 deleteAlarmPayload, 객체 responseObject)

    전달된 삭제 이벤트 페이로드에 대한 추가 검증을 정의하는 기능을 제공합니다.

    이 함수는 흐름 작업의 일부로 processDeleteAlarmEvent() 함수에 의해 호출됩니다. 현재 페이로드 삭제에 대한 추가 페이로드 확인이 제공되지 않습니다. TMFTopicEventAPIUtil 스크립트 포함의 기본 기능을 재정의하여 이 함수에 대한 기능을 추가할 수 있습니다.

    표 33. 매개변수
    이름 유형 설명
    deleteAlarmPayload 객체 확인할 페이로드입니다. 페이로드는 TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA에 정의된 스키마와 일치해야 합니다.
    responseObject 객체 빈 응답 객체입니다. 이 객체를 사용하여 페이로드 스키마 검증과 관련된 문제를 기록합니다.
    데이터 유형: 객체
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject입니다.상태 문자열 함수 호출의 상태입니다. 사용 가능한 상태 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.successResponse 객체 함수 호출의 성공적인 응답입니다. 예를 들어 이 값에 페이로드 객체를 저장할 수 있습니다.
    responseObject입니다.responseError 객체 확인 중에 발생한 오류에 대한 상세 정보입니다.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject입니다.responseError를 일으킵니다.세부 정보 배열 호출 루틴에 다시 전달할 추가 정보입니다.
    예:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject입니다.responseError를 일으킵니다.오류 메시지 문자열 발생한 오류를 설명하는 오류 메시지입니다. 사용 가능한 오류 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.responseError를 일으킵니다.오류 이유 문자열 엔드포인트가 실패한 이유입니다. 사용 가능한 오류 이유는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    표 34. 반환
    유형 설명
    responseObject 함수 호출의 상태에 대한 세부 정보입니다.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject입니다.responseError 확인 중에 발생한 오류에 대한 상세 정보입니다.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject입니다.responseError를 일으킵니다.세부 정보 호출 루틴에 다시 전달할 추가 정보입니다.
    예:
    var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
  messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject
    responseObject입니다.responseError를 일으킵니다.오류 메시지 발생한 오류를 설명하는 오류 메시지입니다. 사용 가능한 오류 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.responseError를 일으킵니다.오류 이유 엔드포인트가 실패한 이유입니다. 사용 가능한 오류 이유는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.상태 함수 호출의 상태입니다. 사용 가능한 상태 메시지는 TMFAlarmAPIConstants 스크립트 포함에 정의되어 있습니다.
    responseObject입니다.successResponse 함수 호출의 성공적인 응답입니다. 예를 들어 이 값에 페이로드 객체를 저장할 수 있습니다. 
    // Apply customized validations if applicable, defaults to no error
var deletePayloadResponse = this.verifyDeleteEventPayload(deleteAlarmPayload, this.responseObject);
if (!gs.nil(deletePayloadResponse.responseError.errorMessage))
  return deletePayloadResponse;