DeleteMIEvent parameters

The DeleteMIEvent macro is run at Scenario level. The macro can be used to delete all MI Events and the associated measure values, or optionally specify the item, location, period, tag or reference to determine the MI Events to be deleted.

For executing the macro, the value of the Command field must be specified in this format:

DeleteMIEvent([Measure Code], [Item Hierarchy Node], [Location Hierarchy Node], [Period label], [Tag], [Reference], [Filter])
Note: The optional parameters are specified in [ ].

This table lists the parameters used in the DeleteMIEvent macro:

Parameter Name Description
Measure code The MI measure code for which the data is deleted.
Note: 
  • You must specify the value only for Measure Code or Tag.
  • If not specified, all MI measures are considered.
Item Hierarchy Node The items that are considered to clear the MI Events.
Note: 
  • All children entities of the passed node at the level to store scenario values are considered.
  • If not specified, all items are considered.
Location Hierarchy Node The locations that are considered to clear the MI Events
Note: 
  • All children entities of the passed node at the base level are considered.
  • If not specified, all locations are considered.
Period Label The cycle periods that are considered to clear the MI Events.
Note: 
  • All children entities of the passed node at the level to store scenario values are considered.
  • If not specified, the horizon for the cycle period including pconst is considered.
  • Rolling period nodes are also supported
Tag If specified, the MI Events of the MI Measure with this tag are deleted.
Note: 
  • You must specify the value only for Measure Code or Tag.
  • If not specified, this parameter is not considered.
Reference If specified, the MI Events with this reference are deleted.
Note: If not specified, this parameter is not considered.
Filter The filter criteria that are applicable for the selected item and location (at period constant (PCONST)) at the specified Item and Location hierarchy level.
Note: 
  • The item@location (at period constant (PCONST)) that pass the criteria are used in the deleting MI process.
  • If not specified, filter criteria are not applied.
See, Filter Parameter syntax.

This table lists examples of the DeleteMIEvent macro:

Requirement Syntax
Deletes all MI Events (including the notes linked to the Events) and clears all MI measures for all items at all locations for all periods of the cycle period horizon. DeleteMIEvent("","","","","","","")
Deletes all MI Events created against the DPLS_MI measure, clears the DPLS_MI of data and deletes any notes created against the MI Events for all items at all locations for all periods of the cycle period horizon. DeleteMIEvent("DPLS_MI","","","","","","")
Deletes all MI Events (including the notes linked to the Events) and clears all MI measures for Events created at GOO items (and the events created at items below GOO) at all locations for the cycle period horizon. DeleteMIEvent("","GOO","","","","","")
Deletes all MI Events (including the notes linked to the Events) and clears all MI measures of the Events created for All Items at location "All DCs" (and the events created at locations below All DCs) for the cycle period horizon. DeleteMIEvent("","","All DCs","","","","")

Deletes all MI Events (including the notes linked to the Events) and clears all MI measures for all items at all locations and for the duration of the calendar period ‘FY 10’ (Events starting and Ending within the calendar period ‘FY 10’).

The Events that begin and end within the calendar period ‘FY 10’ are removed.

 DeleteMIEvent("","","","FY 10","","","")

Deletes all MI Events which have a Reference ‘Easter MI’ and created against the DPLS_MI measure, clears the DPLS_MI of data and deletes the notes created against the Events for GOO items (including the events created at items below GOO) at location ‘US’ (including the events created at locations below US) for the duration of the calendar period ‘Current Year’.

The Events that start and end within the calendar period ‘Current Year’ are considered.

 DeleteMIEvent("DPLS_MI","GOO","US","Current Year","","Easter MI","")

Deletes all MI Events which have a Reference ‘Easter MI’ and created against the Measures that are tagged as DPLS_AdvanceForecasting, clears the measures of data and deletes the notes created against those Events for GOO items (including the events created at items below GOO) at location ‘US’ (including the events created at locations below US) for the duration of the calendar period ‘Current Year’.

The Events that start and end within the calendar period ‘Current Year’ are considered.

 DeleteMIEvent("","GOO","US","Current Year","DPLS_AdvanceForecasting","Easter MI","")
Deletes all MI Events which have a Reference ‘Easter MI’ created against any measures which are tagged as DPLS_AdvanceForecasting, clears the measures of data and deletes the notes created against the Events for all item/location combinations where DPLS_HUNITS > 0. DeleteMIEvent("","","","","DPLS_AdvanceForecasting","Easter MI", "[DPLS_HUNITS] > 0")