トラブルチケットイベントペイロードの変更

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間:2分
  • 基本のトラブルチケットイベント通知の実装には、デフォルトのトラブルチケットイベントタイプの例が複数用意されています。実際のニーズを満たすために、実装内でこれらのイベントのペイロードを変更することが必要になる場合があります。実装に追加する新しいトラブルチケットイベントのペイロードを構成する必要がある場合もあります。

    このセクションでは、「インシデントの属性変更イベント」トラブルチケットイベントのペイロードを変更する方法について説明します。これらの同じ手順を使用して、トラブルチケットイベントタイプのペイロードを変更します。

    すべてのトラブルチケットイベントペイロードにイベントヘッダー属性を追加する

    すべてのトラブルチケットイベントペイロードにイベントヘッダー属性を追加するには、TroubleTicketNotificationUtil スクリプトインクルードの addAdditionalEventAttributes() メソッドを上書きする必要があります。このメソッドに新しい属性を追加すると、すべてのトラブルチケットイベントペイロードにヘッダーレベルの属性が追加されます。

    次のコード例は、すべてのトラブルチケットイベントペイロードに属性 schemaLocation を追加する方法を示しています。

    addAdditionalEventAttributes’: function(tmfEventPayload) {
      // Add "schemaLocation" as a header attribute
      TroubleTicketEventObject.schemaLocation = "http://xx/Event.schema.json",
    }

    特定のトラブルチケットイベントペイロードに属性を追加する

    特定のトラブルチケットイベントペイロードに属性を追加するには、TroubleTicketNotificationUtil スクリプトインクルードの addAttributeChangeTroubleTicketAttributes() メソッドなど、そのイベントに関連付けられたメソッドを上書きする必要があります。このメソッドに新しい属性を追加すると、その特定のトラブルチケットイベントペイロードにイベントレベルの属性が追加されます。

    次のコード例は、「インシデントの属性変更イベント」トラブルチケットイベントに属性 correlationId を追加する方法を示しています。

    addAttributeChangeTroubleTicketAttributes: function(troubleTicketGr) {
      var troubleTicketResource = {};
      var troubleTicketAttributesObj = {};
      this.addMandatoryTroubleTicketAttributes(troubleTicketAttributesObj, troubleTicketGr);
    
    // Add the new attribute correlation id.
      TroubleTicketAttributesObj.correlationId = troubleTicketGr._value.correlation_id;
      troubleTicketResource.troubleTicket = troubleTicketAttributesObj;
      return troubleTicketResource;
    },