イベント - グローバル

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

    • イベント API は、イベント内の値の設定と取得を可能にするメソッドを提供します。

    これらのイベントは MID サーバー から ServiceNow インスタンスに送信されます。イベントを正常に送信するには、MID サーバー と ServiceNow インスタンス間の接続を定義する必要があります。

    Event API を使用して、イベント内のフィールドを追加/更新します。SNEventSenderProvider API を使用して、イベント送信者オブジェクトをインスタンス化します。その後で IEventSender API を使用して、ServiceNow インスタンスにイベントを送信します。

    この API にアクセスするには、Event Management (com.glideapp.itom.snac) プラグインを有効にする必要があります。イベント管理プラグインには、個別のサブスクリプションが必要であり、アクティブ化する必要があります。このプラグインにはデモ データが含まれ、関連プラグインがまだアクティブ化されていない場合はアクティブ化します。

    イベント管理の詳細については、「 イベント管理」を参照してください。

    Event - Event()

    Event コンストラクターをインスタンス化します。

    表 : 1. パラメーター
    名前 タイプ 説明
    なし 
    var event = new Event();
var esource = event.getField("source");
var eseverity = event.getField("severity");

    Event - getField(文字列 field)

    渡された Event Management フィールドの現在の値を返します。

    表 : 2. パラメーター
    名前 タイプ 説明
    フィールド 文字列 返される Event Management フィールド値の名前です。
    表 : 3. 返される内容
    タイプ 説明
    文字列 要求された Event Management フィールドの値です。 
    var event = new Event();
var eventSource = event.getField("source");
var eventSeverity = event.getField("severity");

    Event - setAdditionalInfo(文字列 additionalInfo)

    関連するイベントの既存の additional_info フィールドを、渡された JSON 文字列に置き換えます。

    注:
    setField() メソッドを使用して、additional_infoフィールド内の特定のフィールドを更新できます。
    表 : 4. パラメーター
    名前 タイプ 説明
    additionalInfo 文字列 additional_info フィールドに保存する JSON 文字列 (キー/値ペア) です。
    注:
    このパラメーターは、既存の情報を置き換えます。既存のフィールドは更新されません。
    表 : 5. 返される内容
    タイプ 説明
    なし 
    event.setAdditionalInfo("{\"evtComponent\":\"Microsoft-Windows- WindowsUpdateClient\",\"evtMessage\":\"Installation Failure: Windows failed. Error 0x80070490\"}");

    Event - setField(文字列 key, 文字列 value)

    関連するイベントに指定されたフィールドを設定します。

    渡された key が事前定義されたイベントフィールドと一致する場合、このメソッドは、対応するイベントフィールドを更新します。それ以外の場合、このメソッドは、渡された value を適用する前に key パラメーターをイベントの additional_info セクションに追加します。

    このメソッドを使用して変更できる、事前定義されたイベントフィールドは次のとおりです。

    フィールド 説明
    additional_info 関連するイベントの additional_info フィールドに追加するキー/値ペアです。渡されたキーが既に存在する場合、その値は上書きされます。

    最大長：4,000 文字

    関連 UI フィールド：追加情報
    ci_identifier 構成アイテムを一意に特定する JSON 文字列です。例：{"name":"SAP ORA01","type":"Oracle"}。

    最大長：1,000 文字
    cmdb_ci イベントをバインドする構成アイテム [cmdb_ci] レコードの sys_id です。

    デフォルト：Null
    説明 イベントの自由形式の説明です。

    最大長：4,000 文字

    関連する UI フィールド： 説明

    デフォルト：Null
    event_class イベントを生成した Enterprise Message Service (EMS) です。例えば、"Solarwinds" や "SCOM" です。

    最大長：100

    関連する UI フィールド：ソースインスタンス

    デフォルト：Null
    message_key 一意のイベント識別子です。既存のイベント重大度を上書きするには、同じ message_key 値を使用します。

    最大長：1,024 文字

    関連 UI フィールド：メッセージキー

    デフォルト：source、node、type、resource、および metric name の組み合わせです。
    resolution_state イベントの解決ステータスです。
    有効な値：
    • New：対応するイベントの解決ステータスはオープンです。
    • Closing：対応するイベントの解決ステータスは終結/クローズ済みです。

    関連する UI フィールド：解決ステータス

    デフォルト：New
    resource イベントに関連付けるノードリソースです。例えば、”Disk C:”、”CPU-1" や、プロセスやサービスの名前です。

    最大長：100 文字

    関連 UI フィールド：リソース
    severity イベント重大度です。
    有効な値：
    • 0：クリア - アクションは必要ありません。このイベントからはアラートが作成されません。既存のアラートはクローズされています。
    • 1： Ok - アラートが作成されました。リソースはまだ機能しています。
    • 2： 警告 - リソースはまだ機能していますが、注意が必要です。
    • 3：マイナー - 部分的な、重大でない機能停止またはパフォーマンス低下が発生しました。
    • 4：メジャー - 主要な機能に深刻な障害が発生するかパフォーマンスが低下しています。
    • 5：重大 - 即時アクションが必要です。リソースが機能していないか、リソースに重大な問題が発生する危険性が高まっています。

    関連する UI フィールド： 重大度

    デフォルト：Null
    ソース イベントをトリガーした EMS のインスタンスです。通常はコネクタインスタンスの名前です。

    最大長：200 文字

    関連 UI フィールド：ソース

    デフォルト：Null
    time_of_event ソースシステムでイベントが発生した UTC 時間です。

    形式："yyyy-MM-dd HH:mm:ss"

    最大長：40 文字

    関連する UI フィールド：イベントの時刻

    デフォルト：現在の日付/時刻
    type イベントが関連する測定基準タイプです (ディスクや CPU など)。この値は、アラートの作成元のイベントレコードを識別するために使用されます。

    最大長：100 文字

    関連 UI フィールド：タイプ

    デフォルト：Null
    注:
    また、setText() メソッドを使用してdescriptionフィールドを更新し、setTimeOfEvent() メソッドを使用してイベント時間を更新することもできます。

    イベントの詳細については、「 イベント管理」を参照してください。

    表 : 6. パラメーター
    名前 タイプ 説明
    key 文字列 イベントで追加または更新するキーの名前です。事前定義されたイベントフィールドの詳細については、「 イベント収集のイベントフィールド形式」を参照してください。
    値 文字列 関連するイベントフィールドに保存する情報です。
    注:
    value 文字列は、格納される前にトリミングされ、複数のスペースが 1 つのスペースに置き換えられます。
    表 : 7. 返される内容
    タイプ 説明
    なし 
    var event = new Event();
event.setField("source","SAP Solman");
event.setField("severity","3");
event.setField("time_of_event", "2019-18-05 13:12:05");
event.setField("type", "SAP object");
event.setField("user", "admin"); // parameter will be added to additional_info section

    Event - setText(文字列 text)

    関連するイベントの description フィールドを渡された値に設定します。

    注:
    Event - setField(文字列 key, 文字列 value) メソッドを使用して、現在のイベントの text フィールドを設定することもできます。setField() メソッドとは異なり、このメソッドは渡されたテキストをトリミングしません。
    表 : 8. パラメーター
    名前 タイプ 説明
    text 文字列 関連するイベントの description フィールドに保存するテキストです。

    最大長：4,000 文字
    表 : 9. 返される内容
    タイプ 説明
    なし 
    var event = new Event();
event.setText("SAP Solman");

    Event - setTimeOfEvent(文字列 timeOfEvent)

    関連するイベントの time_of_event フィールドを、渡された UTC 時刻値に設定します。

    注:
    Event - setField(文字列 key, 文字列 value) メソッドを使用して time_of_event フィールドを設定することもできます。
    表 : 10. パラメーター
    名前 タイプ 説明
    timeOfEvent 文字列 time_of_event フィールドに設定する UTC 時刻値です。

    形式："yyyy-MM-dd HH:mm:ss"

    最大長：40 文字
    表 : 11. 返される内容
    タイプ 説明
    なし 
    var event = new Event();
event.setTimeOfEvent("2019-18-05 13:12:05");