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

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

    • 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 インスタンスの両方が、オープンメッセージバスを介してイベントを公開できます。詳細については、「オープンメッセージバスを使用するようにプロデューサーイベント通知フレームワークを構成する」を参照してください。

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

    このドキュメントでは、これらのメッセージバス実装を ServiceNow エコシステムに展開するために上書きする必要があるスクリプトインクルードを含め、実行する必要があるシステム設定について説明します。

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

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

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

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

    デフォルト：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 = Hermes メッセージングサービス
    • openMessageBus = メッセージバスを開く
    • both = イベント/メッセージは両方のメッセージバスで送信されます。

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

    単位：ミリ秒

    デフォルト:90,000