TroubleTicketNotificationUtilOOB - 범위 지정됨

TroubleTicketNotificationUtilOOB 스크립트 포함은 문제 티켓 알림 이벤트에 대한 TMF 호환 페이로드를 정의하고 생성하는 데 사용되는 메서드를 제공합니다.

이 스크립트 포함의 메서드를 다음과 같이 재정의합니다.

• 기존 문제 티켓 이벤트 유형에 속성을 추가/제거합니다.
• 새 문제 티켓 이벤트 유형에 대한 속성을 정의합니다.

자세한 내용은 생산자 이벤트 알림 프레임워크를 사용하여 문제 티켓 알림 구성 문서를 참조하십시오.

이 스크립트 포함은 sn_ind_tsm_sdwan 네임스페이스 내에서 실행됩니다.

호출하는 사용자에게 ticket_integrator 역할이 있어야 합니다.

TroubleTicketNotificationUtilOOB - addAdditionalEventAttributes(객체 tmfEventPayload)

전달된 TMF 문제 티켓 이벤트 페이로드에 사용자 지정 이벤트 헤더 속성을 추가합니다. 이 메서드에서 추가된 속성은 모든 문제 티켓 이벤트에 대한 이벤트 수준 헤더에 추가됩니다.

표 1. 매개변수

이름	유형	설명
tmf이벤트 페이로드	객체	TMF 준수 문제 티켓 이벤트 페이로드입니다. 이 이벤트 페이로드의 형식에 대한 자세한 내용은 TMF621 문제 티켓 관리 API REST 사양 v5.0.0 및 TMF688 이벤트 관리 API 사용자 가이드 v4.0.0을 참조하십시오.

표 2. 반환

유형	설명
없음

다음 코드 예제에서는 이 메서드를 호출하는 방법을 보여 줍니다.

constructTMFEvent: function(eventId) {
  var troubleTicketEvent = {};
  if (gs.nil(eventId)) {
    troubleTicketEvent.eventId = gs.generateGUID();
  } else {
    troubleTicketEvent.eventId = eventId;
  }
  troubleTicketEvent['@type'] = Constants.EVENT_TYPE_TROUBLE_TICKET;
  this.addAdditionalEventAttributes(troubleTicketEvent);
  return troubleTicketEvent;
},

TroubleTicketNotificationUtilOOB - constructTMFEvent(String eventId)

페이로드의 이벤트 섹션에서 TMF688 준수 헤더 속성을 생성합니다. 이러한 속성은 모든 이벤트 페이로드에서 일관됩니다.

기본 구현에서 이 메서드는 eventId 및 @type header 특성을 추가합니다.

이 메서드는 도우미 메서드 addAdditionalEventAttributes()를 호출합니다. 이 메서드에서는 이벤트 페이로드에 다른 헤더 속성을 추가할 수 있습니다. 자세한 내용은 문제 티켓 이벤트 페이로드 수정 문서를 참조하십시오.

표 3. 매개변수

이름	유형	설명
eventId	문자열	관련 이벤트의 고유 식별자입니다. 이 값은 모든 고유 값일 수 있습니다. 기본 구현에서 이벤트 ID를 전달하지 않으면 값이 시스템에서 생성된 GUID로 설정됩니다.

표 4. 반환

유형	설명
객체	이벤트 수준 속성이 설정된 TMF 페이로드입니다. 이 이벤트 페이로드의 형식에 대한 자세한 내용은TMF688 이벤트 관리 API 사용자 가이드 v4.0.0을 참조하십시오.

다음 코드 예제에서는 문제 티켓 속성 변경 페이로드를 생성할 때 이 메서드를 호출하여 이벤트 헤더 속성을 생성하는 방법을 보여 줍니다.

generateTroubleTicketAttributeChangePayload: function(incidentGr, eventType, eventId) {
  var tmfEventPayload = this.constructTMFEvent(eventId);
  tmfEventPayload.eventType = eventType;
  tmfEventPayload.event = this.addAttributeChangeTroubleTicketAttributes(incidentGr);

  return tmfEventPayload;
},

TroubleTicketNotificationUtilOOB - generateCreateTroubleTicketEventPaylaod(객체, incidentGr, 문자열, eventType, 문자열, eventId)

인시던트 이벤트 유형에 대한 연결된 생성 문제 티켓에 대한 TMF 준수 페이로드를 구성합니다.

이 메서드는 연결된 이벤트 유형이 TROUBLE_TICKET_CREATE인 "TroubleTicketCreateEvent"일 때 실행됩니다. 이 메서드는 두 개의 도우미 메서드를 호출합니다.

• constructTMFEvent(): 페이로드에 이벤트 헤더 속성(TMF688)을 추가합니다.
• addCreateTroubleTicketAttributes(): 이 메서드를 재정의하여 페이로드에 필수 및 선택 사항인 문제 티켓 속성(TMF621)을 추가합니다. 이 메서드는 기본 구현의 스텁일 뿐입니다.

TroubleTicketNotificationUtil 스크립트 포함에서 이러한 도우미 메서드를 재정의하여 TMF 호환 페이로드에서 이벤트 헤더와 문제 티켓 특성을 모두 구성할 수 있습니다.

표 5. 매개변수

이름	유형	설명
incidentGr	객체	문제 티켓 이벤트 생성을 유발한 JSON 형식의 Glide 기록입니다. 이 Glide 기록의 정보를 사용하여 TMF621 준수 문제 티켓 이벤트 페이로드를 구성합니다.
eventType	문자열	관련된 문제 티켓 이벤트 유형의 고유 식별자입니다. 이 메서드의 기본 구현의 경우 항상 "TroubleTicketCreateEvent"입니다. 모든 기본 문제 티켓 이벤트 유형의 목록은 sn_api_notif_mgmt의 Constants.EVENT_TYPES 참조하십시오 . 상수 스크립트 포함 파일입니다.
eventId	문자열	관련 이벤트의 고유 식별자입니다.

표 6. 반환

유형	설명
객체	TMF 준수 문제 티켓 이벤트 페이로드입니다. 이 이벤트 페이로드의 형식에 대한 자세한 내용은 TMF621 문제 티켓 관리 API REST 사양 v5.0.0 및 TMF688 이벤트 관리 API 사용자 가이드 v4.0.0을 참조하십시오.

다음 코드 예제에서는 이 메서드를 호출하는 방법을 보여 줍니다.

fetchEventHandlerAndCreateTMFEvent: function(eventSnapshot, eventType, eventId) {
  var eventPayload;
  switch (eventType) {
    case Constants.EVENT_TYPES.TROUBLE_TICKET_STATUS_CHANGE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateTroubleTicketStatusChangePayload(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_CREATE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateCreateTroubleTicketEventPaylaod(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_ATTRIBUTE_CHANGE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateTroubleTicketAttributeChangePayload(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_CREATE_FOR_CASE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateCreateTroubleTicketEventPaylaodForCase(eventSnapshot, eventType, eventId);
      break;

    default:
      this._logger.debug("Event with id " + eventId + " could not find the matching payload generator");
      eventPayload = null;
  }
return eventPayload;
},

TroubleTicketNotificationUtilOOB - generateCreateTroubleTicketEventPaylaodForCase(객체, incidentGr, 문자열, eventType, 문자열, eventId)

케이스 이벤트 유형에 대한 연결된 생성 문제 티켓에 대한 TMF 준수 페이로드를 구성합니다.

이 메서드는 연결된 이벤트 유형이 TROUBLE_TICKET_CREATE_FOR_CASE "TroubleTicketCreateEventForCase"일 때 실행됩니다. 이 메서드는 두 개의 도우미 메서드를 호출합니다.

• constructTMFEvent(): 페이로드에 이벤트 속성(TMF688)을 추가합니다.
• addCreateTroubleTicketAttributesForCase(): 이 메서드를 재정의하여 필수 및 선택 사항인 문제 티켓 속성(TMF621)을 페이로드에 추가합니다. 이 메서드는 기본 구현의 스텁일 뿐입니다.

TroubleTicketNotificationUtil 스크립트 포함에서 이러한 도우미 메서드를 재정의하여 TMF 호환 페이로드에서 이벤트 헤더와 문제 티켓 특성을 모두 구성할 수 있습니다.

표 7. 매개변수

이름	유형	설명
incidentGr	객체	문제 티켓 이벤트 생성을 유발한 JSON 형식의 Glide 기록입니다. 이 Glide 기록의 정보를 사용하여 TMF621 준수 문제 티켓 이벤트 페이로드를 구성합니다.
eventType	문자열	관련된 문제 티켓 이벤트 유형의 고유 식별자입니다. 이 메서드의 기본 구현의 경우 항상 "TroubleTicketCreateEvent"입니다. 모든 기본 문제 티켓 이벤트 유형의 목록은 sn_api_notif_mgmt의 Constants.EVENT_TYPES 참조하십시오 . 상수 스크립트 포함 파일입니다.
eventId	문자열	관련 이벤트의 고유 식별자입니다.

표 8. 반환

유형	설명
객체	TMF 준수 문제 티켓 이벤트 페이로드입니다. 이 이벤트 페이로드의 형식에 대한 자세한 내용은 TMF621 문제 티켓 관리 API REST 사양 v5.0.0 및 TMF688 이벤트 관리 API 사용자 가이드 v4.0.0을 참조하십시오.

다음 코드 예제에서는 이 메서드를 호출하는 방법을 보여 줍니다.

fetchEventHandlerAndCreateTMFEvent: function(eventSnapshot, eventType, eventId) {
  var eventPayload;
  switch (eventType) {
    case Constants.EVENT_TYPES.TROUBLE_TICKET_STATUS_CHANGE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateTroubleTicketStatusChangePayload(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_CREATE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateCreateTroubleTicketEventPaylaod(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_ATTRIBUTE_CHANGE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateTroubleTicketAttributeChangePayload(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_CREATE_FOR_CASE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateCreateTroubleTicketEventPaylaodForCase(eventSnapshot, eventType, eventId);
      break;

    default:
      this._logger.debug("Event with id " + eventId + " could not find the matching payload generator");
      eventPayload = null;
  }
return eventPayload;
},

TroubleTicketNotificationUtilOOB - generateTroubleTicketAttributeChangePayload(객체, incidentGr, 문자열, eventType, 문자열, eventId)

인시던트 이벤트 유형의 문제 티켓 속성 변경 이벤트에 대한 TMF 준수 페이로드를 구성합니다.

이 메서드는 연결된 이벤트 유형이 TROUBLE_TICKET_ATTRIBUTE_CHANGE "TroubleTicketAttributeChangeEvent"일 때 실행됩니다. 이 메서드는 두 개의 도우미 메서드를 호출합니다.

• constructTMFEvent(): 페이로드에 이벤트 속성(TMF688)을 추가합니다.
• addAttributeChangeTroubleTicketAttributes(): 이 메서드를 재정의하여 페이로드에 필수 및 선택 사항인 문제 티켓 속성(TMF621)을 추가합니다. 이 메서드는 기본 구현의 스텁일 뿐입니다.

TroubleTicketNotificationUtil 스크립트 포함에서 이러한 도우미 메서드를 재정의하여 TMF 호환 페이로드에서 이벤트 헤더와 문제 티켓 특성을 모두 구성할 수 있습니다.

표 9. 매개변수

이름	유형	설명
incidentGr	객체	문제 티켓 이벤트 생성을 유발한 JSON 형식의 Glide 기록입니다. 이 Glide 기록의 정보를 사용하여 TMF621 준수 문제 티켓 이벤트 페이로드를 구성합니다.
eventType	문자열	관련된 문제 티켓 이벤트 유형의 고유 식별자입니다. 이 메서드의 기본 구현의 경우 항상 "TroubleTicketCreateEvent"입니다. 모든 기본 문제 티켓 이벤트 유형의 목록은 sn_api_notif_mgmt의 Constants.EVENT_TYPES 참조하십시오 . 상수 스크립트 포함 파일입니다.
eventId	문자열	관련 이벤트의 고유 식별자입니다.

표 10. 반환

유형	설명
객체	TMF 준수 문제 티켓 이벤트 페이로드입니다. 이 이벤트 페이로드의 형식에 대한 자세한 내용은 TMF621 문제 티켓 관리 API REST 사양 v5.0.0 및 TMF688 이벤트 관리 API 사용자 가이드 v4.0.0을 참조하십시오.

다음 코드 예제에서는 이 메서드를 호출하는 방법을 보여 줍니다.

fetchEventHandlerAndCreateTMFEvent: function(eventSnapshot, eventType, eventId) {
  var eventPayload;
  switch (eventType) {
    case Constants.EVENT_TYPES.TROUBLE_TICKET_STATUS_CHANGE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateTroubleTicketStatusChangePayload(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_CREATE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateCreateTroubleTicketEventPaylaod(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_ATTRIBUTE_CHANGE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateTroubleTicketAttributeChangePayload(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_CREATE_FOR_CASE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateCreateTroubleTicketEventPaylaodForCase(eventSnapshot, eventType, eventId);
      break;

    default:
      this._logger.debug("Event with id " + eventId + " could not find the matching payload generator");
      eventPayload = null;
  }
return eventPayload;
},

TroubleTicketNotificationUtilOOB - generateTroubleTicketStatusChangePayload(객체, incidentGr, 문자열, eventType, 문자열, eventId)

인시던트 이벤트 유형에 대한 관련 문제 티켓 상태 변경 이벤트에 대한 TMF 준수 페이로드를 구성합니다.

이 메서드는 연결된 이벤트 유형이 TROUBLE_TICKET_STATUS_CHANGE "TroubleTicketStatusChangeEvent"일 때 실행됩니다. 이 메서드는 두 개의 도우미 메서드를 호출합니다.

• constructTMFEvent(): 페이로드에 이벤트 속성(TMF688)을 추가합니다.
• addStatusChangeTroubleTicketAttributes(): 이 메서드를 재정의하여 필수 및 선택 사항인 문제 티켓 속성(TMF621)을 페이로드에 추가합니다. 이 메서드는 기본 구현의 스텁일 뿐입니다.

TroubleTicketNotificationUtil 스크립트 포함에서 이러한 도우미 메서드를 재정의하여 TMF 호환 페이로드에서 이벤트 헤더와 문제 티켓 특성을 모두 구성할 수 있습니다.

표 11. 매개변수

이름	유형	설명
incidentGr	객체	문제 티켓 이벤트 생성을 유발한 JSON 형식의 Glide 기록입니다. 이 Glide 기록의 정보를 사용하여 TMF621 준수 문제 티켓 이벤트 페이로드를 구성합니다.
eventType	문자열	관련된 문제 티켓 이벤트 유형의 고유 식별자입니다. 이 메서드의 기본 구현의 경우 항상 "TroubleTicketCreateEvent"입니다. 모든 기본 문제 티켓 이벤트 유형의 목록은 sn_api_notif_mgmt의 Constants.EVENT_TYPES 참조하십시오 . 상수 스크립트 포함 파일입니다.
eventId	문자열	관련 이벤트의 고유 식별자입니다.

표 12. 반환

유형	설명
객체	TMF 준수 문제 티켓 이벤트 페이로드입니다. 이 이벤트 페이로드의 형식에 대한 자세한 내용은 TMF621 문제 티켓 관리 API REST 사양 v5.0.0 및 TMF688 이벤트 관리 API 사용자 가이드 v4.0.0을 참조하십시오.

다음 코드 예제에서는 이 메서드를 호출하는 방법을 보여 줍니다.

fetchEventHandlerAndCreateTMFEvent: function(eventSnapshot, eventType, eventId) {
  var eventPayload;
  switch (eventType) {
    case Constants.EVENT_TYPES.TROUBLE_TICKET_STATUS_CHANGE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateTroubleTicketStatusChangePayload(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_CREATE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateCreateTroubleTicketEventPaylaod(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_ATTRIBUTE_CHANGE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateTroubleTicketAttributeChangePayload(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_CREATE_FOR_CASE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateCreateTroubleTicketEventPaylaodForCase(eventSnapshot, eventType, eventId);
      break;

    default:
      this._logger.debug("Event with id " + eventId + " could not find the matching payload generator");
      eventPayload = null;
  }
return eventPayload;
},