Event administration (IRPCEventsAdmin)
Reads, exports and deletes the vault's event log, turns event logging on or off, and stores the caller's saved event log filters.
MFAdmin uses this interface to admininistrate events.
| gRPC service | MFiles.IRPCEventsAdmin |
|---|---|
| Book and level | Administration API, specialized |
| Methods | 13 |
| Proto file | mfiles/IRPCEventsAdmin.proto |
Overview
M-Files Admin uses this service for the vault's event log: viewing, exporting and clearing it.
Every method needs a vault session and the vault right manage_events (part of full control);
a normal user gets "Access denied." (0x800407E4 with reason 0x800400A9).
- Logging on or off: IsEventLoggingEnabled, EnableEventLogging.
- Read events (Event): find the ID range with GetMinAndMaxEventIDs, then read pages with GetEventsRange.
- Export and delete: after saving the events elsewhere, record the export with EventsExported and remove them with DeleteEventsRange; ClearEvents removes all events.
- Saved filters of the event log viewer, private to each user: SaveEventLogFilter, GetEventLogFilters, DeleteEventLogFilters, GetEventLogFilterRecord, UpdateEventLogFilterDefaultValue.
Client version. GetEventsRange and
GetEvents fail with "The installed M-Files client
version is older than the M-Files Server version." (0x80040930) unless the session was opened
with client_data.version 12.0.5192.0 or newer. Log in with client_data.version set to the
server_version from QueryVersion.
-1 means "no filter". Event ID bounds and object filters use -1 for "not set". The proto3 default 0 is a real value: a request left at its defaults matches no events.
Advanced event log features (21 CFR Part 11 compliance): when they are enabled in the vault, event logging cannot be turned off and ClearEvents is refused; DeleteEventsRange still works.
Methods
| Method | Summary | Facts |
|---|---|---|
| ClearEvents | Deletes all events of the vault. | admin session |
| DeleteEventLogFilters | Deletes saved event log filters of the calling user by ID. | admin session idempotent |
| DeleteEventsRange | Deletes the events whose IDs are in the given range. | admin session |
| EnableEventLogging | Turns event logging of the vault on or off. | admin session idempotent |
| EventsExported | Records in the event log that a range of events was exported. | admin session |
| GetEventLogFilterRecord | Gets the conditions of the calling user's default event log filter. | admin session idempotent |
| GetEventLogFilters | Gets the event log filters saved by the calling user. | admin session idempotent |
| GetEvents | Gets all events of the vault. | admin session |
| GetEventsRange | Gets events by ID range and filters, oldest or newest first, with an optional maximum count. | admin session idempotent |
| GetMinAndMaxEventIDs | Gets the smallest and largest event ID in the vault's event log. | admin session |
| IsEventLoggingEnabled | Tells whether event logging is on in the vault. | admin session idempotent |
| SaveEventLogFilter | Saves a named event log filter for the calling user. | admin session idempotent |
| UpdateEventLogFilterDefaultValue | Makes a saved event log filter the user's default filter, or clears its default flag. | admin session idempotent |