eventmonitor Command

The eventmonitor command supports the ability to track events for business objects and relationships.

This page discusses:

User Level

System Administrator

Add Eventmonitor

Event monitors are defined using the Add Eventmonitor command

add eventmonitor NAME [ADD_ITEM {ADD_ITEM}];
  • ADD_ITEM defines the events to be monitored. The Add Eventmonitor clauses are:
    EVENT
    description VALUE
    [!|not] hidden
    property NAME [value STRING]
    property NAME to ADMIN [value STRING]
    • EVENT is:
      event businessobject add
      event businessobject delete
      event businessobject bestsofar
      event businessobject custom
      event businessobject modify
      event businessobject all
      event relationship add
      event relationship delete
      event relationship bestsofar
      event relationship custom
      event relationship modify
      event relationship modifyfrom
      event relationship modifyto
      event relationship modifytype
      event relationship all
      event admin add
      event admin delete
      event admin modify
      event transaction commit

Check Eventmonitor

Use this syntax to list the events you can include in an event monitor as shown in the Event list above.

check eventmonitor;

Copy Eventmonitor

You can copy the events from one event monitor to another event monitor

copy eventmonitor SRC_NAME DST_NAME [MOD_ITEM {MOD_ITEM}];
  • SRC_NAME is the source event monitor (copying from this event monitor)
  • DST_NAME is the destination event monitor (copying to this event monitor)
  • MOD_ITEM is an item listed in Modify Eventmonitor.

Log Eventmonitor

You can use the Log Eventmonitor command to log an event other than the ones listed in Add Eventmonitor.

log eventmonitor NAME PHYSICAL_ID LOG_EVENT;
  • NAME is the name of the event monitor
  • PHYSICAL_ID is the physical ID of the business object or relationship
  • LOG_EVENT is one of these:
    event | businessobject | custom
      |relationship    |

Modify Eventmonitor

Use the Modify Eventmonitor command to change the definition of an existing event monitor.

modify eventmonitor NAME [MOD_ITEM {MOD_ITEM}];
  • NAME is the name of the event monitor you want to modify.
  • MOD_ITEM is the type of modification you want to make. Each is specified in a modify clause, as listed in the following table. You only need to specify the fields to be modified.
    MOD_ITEMSpecifies
    add EVENTAdds the specified event (listed in Add Eventmonitor) to the event monitor.
    remove EVENTRemoves the specified event from the event monitor.
    description VALUEReplaces and existing description for the event monitor with the text in VALUE.
    hiddenThe hidden option is changed to specify that the event monitor is hidden.
    [!|not] hiddenThe hidden option is changed to specify that the event monitor is not hidden.
    add property NAME [to ADMIN] [value STRING]The named property is added to the event monitor with any specified value.
    remove property NAME [to ADMIN]The named property is removed from the event monitor.

Clear Eventmonitor

You can clear entries in an event monitor.

clear eventmonitor NAME [VAULT_PATTERN] [EVENT];
  • NAME is the name of the event monitor to be cleared.
  • VAULT_PATTERN restricts the events being cleared to the matching vaults.
  • EVENT defines which event to clear from the event monitor. If not specified, all events are cleared.