Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

opEvents panels are customisable views that allow you to create filtered perspectives of your event data. Each panel appears as an option in the Panels dropdown menu in the opEvents interface, giving users quick access to their specialised event views.

image (1).pngImage RemovedImage Added

Configuration Location and Structure

Panels are configured in the /usr/local/omk/conf/ConfigPanelsEventsPanels.json file. This file contains a JSON object where each key represents a unique panel configuration. You can define multiple panels within this single configuration file, and they will all appear in the Panels dropdown menu in the order they're defined.

This file will not exist on a fresh install.

Basic Structure

Code Block
languagejson
{
    "panel-identifier-1": {
        "title": "First Panel",
        "description": "Description of first panel",
        "model": "events",
        "filter": {
            "field": "filter_expression"
        }
    },
    "panel-identifier-2": {
        "title": "Second Panel",
        "description": "Description of second panel",
        "model": "events",
        "filter": {
            "field": "filter_expression"
        }
    }
}

For example a panel with the name panel-identifier-1 will create a /omk/opEvents/panels/panel-identifier-1

Schema Fields Reference

Field

Type

Required

Description

title

string

Yes

The display name of the panel shown as the title

description

string

Yes

Description of the panel shown in navigation

model

string

Yes

Data model to use (currently "events")

filter

object

Yes

Collection of field:filter_expression pairs

table_schema

string

No

If you wish to use custom table schema

Customising Table Schemas

Filter Expressions

The filter object supports several types of matching, giving you flexibility in how you filter your events. You can choose the matching method that best suits your needs:

...