イベント - グローバル
イベント API は、イベント内で値を設定および取得できるようにするメソッドを提供します。
これらのイベントは、 MID サーバー から ServiceNow インスタンスに送信されます。イベントを正常に送信できるようにするには、 MID サーバー と ServiceNow インスタンス間の接続を定義する必要があります。
イベント API を使用して、イベント内のフィールドを追加/更新します。SNEventSenderProvider API を使用して、イベント送信者オブジェクトをインスタンス化します。次に、 IEventSender API を使用してイベントを ServiceNow インスタンスに送信します。
この API にアクセスする前に、イベント管理 (com.glideapp.itom.snac) プラグインをアクティブ化する必要があります。イベント管理プラグインには個別のサブスクリプションが必要であり、アクティブ化する必要があります。このプラグインにはデモデータが含まれ、関連プラグインがまだ有効になっていない場合はアクティブ化します。
イベント管理の詳細については、「 イベント管理」を参照してください。
イベント:event()
イベントコンストラクターをインスタンス化します。
| 名前 | タイプ | 説明 |
|---|---|---|
| なし |
var event = new Event();
var esource = event.getField("source");
var eseverity = event.getField("severity");
イベント:getField(文字列フィールド)
渡されたイベント管理フィールドの現在の値を返します。
| 名前 | タイプ | 説明 |
|---|---|---|
| フィールド | 文字列 | 返すイベント管理フィールド値の名前。 |
| タイプ | 説明 |
|---|---|
| 文字列 | 要求されたイベント管理フィールドの値。 |
var event = new Event();
var eventSource = event.getField("source");
var eventSeverity = event.getField("severity");
イベント:setAdditionalInfo(文字列 additionalInfo)
関連するイベントの既存の additional_info フィールドを、渡された JSON 文字列に置き換えます。
| 名前 | タイプ | 説明 |
|---|---|---|
| additionalInfo | 文字列 | [ additional_info ] フィールドに保存する JSON 文字列 (キーと値のペア)。 注: このパラメーターは、既存の情報を置き換えます。既存のフィールドは更新されません。 |
| タイプ | 説明 |
|---|---|
| なし |
event.setAdditionalInfo("{\"evtComponent\":\"Microsoft-Windows- WindowsUpdateClient\",\"evtMessage\":\"Installation Failure: Windows failed. Error 0x80070490\"}");
イベント:setField(String key, String value)
関連するイベントの指定されたフィールドを設定します。
渡された key が事前定義されたイベントフィールドと一致する場合、メソッドは対応するイベントフィールドを更新します。それ以外の場合、メソッドは、渡されたvalueを適用する前に、イベントの additional_info セクションに key パラメーターを追加します。
このメソッドを使用して変更できる事前定義されたイベントフィールドは次のとおりです。
| フィールド | 説明 |
|---|---|
| additional_info | 関連イベントの additional_info フィールドに追加するキーと値のペア。渡されたキーが既に存在する場合、その値は上書きされます。 最大長:4,000 文字 関連 UI フィールド:追加情報 |
| ci_identifier | 構成アイテムを一意に識別する JSON 文字列。例:{"name":"SAP ORA01","type":"Oracle"}。 最大長:1,000 文字 |
| cmdb_ci | イベントのバインド先の構成アイテム [cmdb_ci] レコードのSys_id。 デフォルト:Null |
| description | イベントの自由形式の説明。 最大長:4,000 文字 関連 UI フィールド:説明 デフォルト:Null |
| event_class | イベントを生成した Enterprise Message Service (EMS)。例:「Solarwinds」や「SCOM」。 最大長:100 関連する UI フィールド:ソースインスタンス デフォルト:Null |
| message_key | 一意のイベント識別子。既存のイベント重大度を上書きするには、同じ message_key 値を使用します。 最大長:1024 文字 関連する UI フィールド:メッセージキー デフォルト: source、 node、 type、 resource、および metric nameの組み合わせ。 |
| resolution_state | イベント解決ステータス。 有効な値:
関連する UI フィールド:解決状況 デフォルト:新規 |
| resource | イベントに関連付けるノードリソース。たとえば、「Disk C:」、「CPI-1」、またはプロセスまたはサービスの名前です。 最大長:100 文字 関連 UI フィールド:リソース |
| severity | イベントの重大度。 有効な値:
関連する UI フィールド:重大度 デフォルト:Null |
| ソース | イベントをトリガーした EMS のインスタンス。通常はコネクターインスタンス名。 最大長:200 文字 関連する UI フィールド:ソース デフォルト:Null |
| time_of_event | ソースシステムでイベントが発生した UTC 時間。 形式:「yyyy-MM-dd HH:mm:ss」 最大長:40 文字 関連する UI フィールド:イベントの時刻 デフォルト:現在の日付/時刻 |
| type | ディスクや CPU など、イベントに関連するメトリクスタイプ。この値は、アラートの作成元のイベントレコードを識別するために使用されます。 最大長:100 文字 関連 UI フィールド:タイプ デフォルト:Null |
イベントの詳細については、「 イベント管理」を参照してください。
| 名前 | タイプ | 説明 |
|---|---|---|
| key | 文字列 | イベントで追加または更新するキーの名前。事前定義されたイベントフィールドの詳細については、 イベント収集のイベントフィールド形式を参照してください。 |
| value | 文字列 | 関連イベントフィールドに格納する情報。 注: value文字列は格納される前にトリミングされ、複数のスペースが 1 つのスペースに置き換えられます。 |
| タイプ | 説明 |
|---|---|
| なし |
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
イベント:setText(文字列テキスト)
関連イベントの description フィールドを渡された値に設定します。
| 名前 | タイプ | 説明 |
|---|---|---|
| テキスト | 文字列 | 関連イベントの description フィールドに格納するテキスト。 最大長:4000 文字 |
| タイプ | 説明 |
|---|---|
| なし |
var event = new Event();
event.setText("SAP Solman");
イベント:setTimeOfEvent(文字列 timeOfEvent)
関連イベントの time_of_event フィールドを渡された UTC 時間の値に設定します。
| 名前 | タイプ | 説明 |
|---|---|---|
| イベントの時間 | 文字列 | [ time_of_event ] フィールドに設定する UTC 時間値。 形式:「yyyy-MM-dd HH:mm:ss」 最大長:40 文字 |
| タイプ | 説明 |
|---|---|
| なし |
var event = new Event();
event.setTimeOfEvent("2019-18-05 13:12:05");