プロデューサーイベント通知フレームワーク開発者ガイド

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：4分

    • Producer Event Notification Framework for Telecommunications, Media, and Technology を使用すると、ネットワークに実装された メッセージバス を使用して、トラブルチケットなどのイベントを外部に配信できます。

    プロデューサーイベント通知フレームワークは、次の 2 つの異なるメッセージバスユースケースをサポートしています。
    1. Hermes メッセージングサービスを介したイベントの公開:Hermes Kafka を使用してイベントを公開する場合は、Kafka メッセージバスのプロデューサーイベント通知フレームワークを構成する必要があります。このメッセージバスは、クラウドベースのインスタンスでのみ使用できます。詳細については、「を使用するようにプロデューサーイベント通知フレームワークを構成する Hermes メッセージングサービス」を参照してください。

      Hermes を使用してトラブルチケット通知を公開する方法の詳細については、「 Producing outbound API notifications using Hermes」を参照してください。

      注:
      このユースケースを実装する前に、 Hermes メッセージングサービス がインスタンスにインストールされ、設定されている必要があります。詳細については、「Hermes Messaging Service」を参照してください。
    2. オープンメッセージバスを介したイベントの公開: インスタンスでカスタムメッセージバスを使用する場合は、オープンメッセージバスを使用して ServiceNow インスタンスからネットワーク上のコンシューマーにイベントを送信するようにプロデューサーイベント通知フレームワークを設定する必要があります。クラウドベースインスタンスとオンプレミス ServiceNow インスタンスの両方で、オープンメッセージバスを介してイベントを公開できます。詳細については、「Open Message Bus を使用するためのプロデューサーイベント通知フレームワークの構成」を参照してください。

      オープンメッセージバスを使用してトラブルチケット通知を発行する方法の詳細については、「 Producing outbound API notifications using the open message bus」を参照してください。

    このドキュメントでは、これらのメッセージ バス実装を ServiceNow エコシステムにデプロイするためにオーバーライドする必要があるスクリプト インクルードを含む、実行する必要があるシステム構成について説明します。

    プロデューサーシステムプロパティ

    次の表に、プロデューサーイベント通知フレームワークの機能を制御する ServiceNow インスタンス内のプロパティを示します。これらのプロパティのデフォルト値を確認し、必要に応じて特定の実装に合わせて変更します。これらのプロパティを変更するには、 ServiceNow UI で すべて > システムプロパティ > すべてのプロパティ.

    プロパティ 説明
    sn_api_notif_mgmt.event.log デバッグログに書き込まれるログのレベル。
    有効な値：
    • アラート
    • クリティカル
    • debug
    • エマールグ
    • Err
    • info
    • 通知
    • 警告

    デフォルト:err
    sn_api_notif_mgmt.glideミューテックス。スクリプト。マックススピン 受信キュー内のレコードに対するミューテックスロックの取得を試行する最大回数。

    デフォルト：100
    sn_api_notif_mgmt.glideミューテックス。スクリプト。スピン待機 受信キュー内のレコードのロックを取得する試行間の待機時間。

    単位：ミリ秒

    デフォルト：100
    sn_api_notif_mgmt.inboundqueue.batch.limit スケジューラーが受信キューから一度に プルして処理 するレコードの数 (1 つのバッチ)。

    デフォルト: 200
    sn_api_notif_mgmt.inboundqueue.maxrecords 1 回のスケジューラー実行でスケジューラーが受信キューからプルするレコードの最大数。この値は、 sn_api_notif_mgmt.inboundqueue.batch.limit パラメーターと組み合わせて使用します。

    たとえば、バッチ制限が 50 に設定され、maxrecords が 200, に設定され、 受信キュー内のレコードの数が 130 の場合、スケジューラーは 1 回の実行で 3 つの異なるレコードのバッチ (50 レコードの 2 つと 30 レコードの 1 つ) をプルします。受信キューのレコード数が 220 の場合、スケジューラーは 50 レコードの 4 つのバッチをプルし、残りの 20 レコードは次にスケジューラーが実行されるまで処理されません。

    この値を設定するときは、スケジューラが複数のバッチを処理するのにかかる時間も考慮し、それに応じて sn_api_notif_mgmt.schedule.max.runtime 値を設定する必要があります。

    デフォルト: 200
    sn_api_notif_mgmt.publisher_message_bus_configuration メッセージを Hermes メッセージングサービス、オープン・メッセージ・バス、またはその両方のメッセージ・バスのいずれを使用して公開するかを定義します。
    有効な値：
    • エルメス= Hermes メッセージングサービス
    • openMessageBus = オープン・メッセージ・バス
    • both = イベント/メッセージは両方のメッセージバスで送信されます。

    デフォルト:openMessageBus
    sn_api_notif_mgmt.schedule。max.runtime スケジュールジョブが失敗してエラーを報告するまでに実行できる最大時間。

    単位：ミリ秒

    デフォルト:90,000