TroubleTicketNotificationUtilOOB: スコープ指定

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：21分

    • TroubleTicketNotificationUtilOOB スクリプトインクルードは、トラブルチケット通知イベントの TMF 準拠ペイロードを定義および生成するために使用されるメソッドを提供します。

    このスクリプトインクルードのメソッドをオーバーライドして、次の操作を行います。
    • 既存のトラブルチケットイベントタイプに属性を追加/削除します。
    • 新しいトラブルチケットイベントタイプの属性を定義します。
    詳細については、「プロデューサーイベント通知フレームワークを使用したトラブルチケット通知の構成」を参照してください。

    このスクリプトインクルードは 、sn_ind_tsm_sdwan 名前空間内で実行されます。

    呼び出し元ユーザーには、ticket_integrator ロールが必要です。

    TroubleTicketNotificationUtilOOB:addAdditionalEventAttributes(オブジェクト tmfEventPayload)

    渡された TMF トラブルチケットイベントペイロードにカスタムイベントヘッダー属性を追加します。このメソッドによって追加された属性は、すべてのトラブルチケットイベントのイベントレベルのヘッダーに追加されます。

    表 : 1. パラメーター
    名前 タイプ 説明
    TMFEVENT ペイロード オブジェクト TMF 準拠のトラブルチケットイベントペイロード。このイベントペイロードの形式の詳細については、『 TMF621 Trouble Ticket Management API REST Specification v5.0.0 』および『 TMF688 Event Management API User Guide 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(文字列eventId)

    ペイロードのイベントセクションで TMF688 準拠のヘッダー属性を生成します。これらの属性は、すべてのイベントペイロードで一貫しています。

    デフォルトの実装では、このメソッドは eventId および @type ヘッダー属性を追加します。

    このメソッドは、ヘルパーメソッド addAdditionalEventAttributes() を呼び出します。このメソッドでは、他のヘッダー属性をイベントペイロードに追加できます。詳細については、「トラブルチケットイベントペイロードの変更」を参照してください。

    表 : 3. パラメーター
    名前 タイプ 説明
    eventId 文字列 関連するイベントの一意の識別子。これは任意の一意の値にすることができます。既定の実装では、イベント ID を渡さない場合、値はシステム生成 GUID に設定されます。
    表 : 4. 戻り値
    タイプ 説明
    オブジェクト イベントレベルの属性が設定された TMF ペイロード。このイベントペイロードの形式の詳細については、『TMF688 Event Management API User Guide v4.0.0』を参照してください。

    次のコード例は、トラブルチケット属性変更ペイロードを生成するときに、このメソッドを呼び出してイベントヘッダー属性を構築する方法を示しています。

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

  return tmfEventPayload;
},

    TroubleTicketNotificationUtilOOB:CreateTroubleTicketEventPaylaod(オブジェクト incidentGr, 文字列 eventType, 文字列 eventId)

    インシデントイベントタイプに関連付けられたトラブルチケットの作成の TMF 準拠ペイロードを構築します。

    このメソッドは、関連するイベントタイプが 「TroubleTicketCreateEvent」TROUBLE_TICKET_CREATE場合に実行されます。このメソッドは、次の 2 つのヘルパーメソッドを呼び出します。
    • 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 Trouble Ticket Management API REST Specification v5.0.0 』および『 TMF688 Event Management API User Guide 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:CreateTroubleTicketEventPaylaodForCase(オブジェクト incidentGr, 文字列 eventType, 文字列 eventId)

    ケースイベントタイプに関連付けられたトラブルチケットの作成の TMF 準拠ペイロードを構築します。

    このメソッドは、関連するイベントタイプが 「TroubleTicketCreateEventForCase」TROUBLE_TICKET_CREATE_FOR_CASE場合に実行されます。このメソッドは、次の 2 つのヘルパーメソッドを呼び出します。
    • 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 Trouble Ticket Management API REST Specification v5.0.0 』および『 TMF688 Event Management API User Guide 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 準拠ペイロードを構築します。

    このメソッドは、関連するイベントタイプが 「TroubleTicketAttributeChangeEvent」TROUBLE_TICKET_ATTRIBUTE_CHANGE場合に実行されます。このメソッドは、次の 2 つのヘルパーメソッドを呼び出します。
    • 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 Trouble Ticket Management API REST Specification v5.0.0 』および『 TMF688 Event Management API User Guide 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 準拠ペイロードを構築します。

    このメソッドは、関連するイベントタイプが 「TroubleTicketStatusChangeEvent」TROUBLE_TICKET_STATUS_CHANGE場合に実行されます。このメソッドは、次の 2 つのヘルパーメソッドを呼び出します。
    • 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 Trouble Ticket Management API REST Specification v5.0.0 』および『 TMF688 Event Management API User Guide 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;
},