Skip to content

Commit

Permalink
docs: Improve event text
Browse files Browse the repository at this point in the history
  • Loading branch information
DougLau committed Nov 25, 2024
1 parent 0dec7ec commit 0d359ae
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 22 deletions.
32 changes: 17 additions & 15 deletions docs/events.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
# Events

## Database Event Tables
There are a number of [database] tables for logging different types of events.

There are a number of event tables in the [database] for logging different
types of events. Most of these tables have a **view** in the public DB schema.
## Configuration

Select the `View ➔ System ➔ Event Config` menu item.

Each event type can be configured independently.

Field | Description
-------------|-------------------------
Name | Table name of event type
Enable Store | Enable or disable storing event type
Enable Purge | Enable or disable purging event type
Purge Days | Number of days to keep events before purging

## Event Tables

Most event tables have a **view** in the public DB schema.

Table Name | View
--------------------------|-------------------------
Expand All @@ -29,17 +43,5 @@ Table Name | View
`weather_sensor_sample` | `weather_sensor_sample_view`
`weather_sensor_settings` | `weather_sensor_settings_view`

## Event Configuration

Each event type can be configured independently.

**Name**: Table name of event type

**Enable Store**: Enable/disable storing event type

**Enable Purge**: Enable/disable purging event type

**Purge Days**: Number of days to keep events before purging


[database]: database.html
5 changes: 3 additions & 2 deletions docs/incidents.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ minutes). During this time, a cleared incident can be reactivated if necessary.

## Incident Events

Incidents and all updates are recorded in the database. There are two views
available:
Incidents and updates can be recorded as [events] in the database. There are
two views available:
* `incident_view` contains one record for each recorded incident
* `incident_update_view` contains a record for every update to each incident

Expand All @@ -63,6 +63,7 @@ devices to deploy for the incident.


[DMS]: dms.html
[events]: events.html
[LCS]: lcs.html
[suggested DMS]: incident_dms.html
[suggested LCS]: incident_lcs.html
Expand Down
2 changes: 1 addition & 1 deletion docs/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ resource. These include:
[domain]: users.html#domains
[encoder stream]: cameras.html#streams
[encoder type]: cameras.html#encoder-types
[event config]: events.html#event-configuration
[event config]: events.html#configuration
[flow stream]: flow_streams.html
[font]: fonts.html
[gate arm]: gate_arms.html
Expand Down
8 changes: 4 additions & 4 deletions docs/tolling.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,10 @@ If required, a message such as `OPEN` or `CLOSED` may be appended after the tag.

### Price Message Events

A price [event] can be stored when a message is sent to a DMS, and again when
the message is verified. The event includes the **date and time**,
**DEPLOYED** or **VERIFIED** status, **DMS id**, **toll zone**, _highest
density_ **detector(s)** and **price**.
An [event] can be stored in the `price_message_event` table when a message is
sent to a DMS, and again when the message is verified. The event includes the
**date and time**, **DEPLOYED** or **VERIFIED** status, **DMS id**,
**toll zone**, _highest density_ **detector(s)** and **price**.

The logged _toll zone_ is the last zone specified in the tag. In _priced_ mode,
the displayed price is logged. For _open_ or _closed_, a price of 0 is logged.
Expand Down

0 comments on commit 0d359ae

Please sign in to comment.