Skip to Content

mvSQL Runtime Function - EVENT()

Summary

Returns information about the current event execution.

Syntax

event(<parameter>)

Parameters

parameter

A parameter that determines which event attribute is returned. Valid parameters include:

  • 'contextid' - Unique identifier that can be used to correlate events that occur within a single operation such as a business CRUD rule.
  • 'rowid' - Unique identifier for the row on which the event was invoked. In the case of an business CRUD rule, this refers to the target row.
  • 'source.rowid' - Unique identifier for the business CRUD Insert and Update source row.
  • 'exception' - Exception message or empty string if no exception was thrown. This value is accessible to action failure handlers if the event failed as a result of an exception.

Returns

string

See the parameter.

Remarks

The event() function is typically used in action failure handlers to track row-level failures when executing business CRUD rules. The context and row identifiers can be correlated with event history entries. See Event History for more information.

When executed outside the context of an event, the event() function returns zero-filled, empty values. The contextid, rowid and source.rowid parameters return an empty GUID. The exception parameter returns an empty string.

Note

event() runtime by design only captures messages from the Vinyl framework. It cannot be used in combination with Business Logic Validations, for example.

Examples

event('contextid')

Returns:

'5e1eb577-c4a0-4681-bd72-f15a2980e273'

event('rowid')

Returns:

'5e1eb577-c4a0-4681-bd72-f15a2980e273'

event('source.rowid')

Returns:

'5e1eb577-c4a0-4681-bd72-f15a2980e273'

event('exception')

Returns:

'Access Denied'