abstract class SYS.History.UserAbstract
Abstract class used as the parent of all collection classes for user-defined metrics. The
SYS.History.User* classes are generated by inheriting from this class and then adding the
user-defined classes as embedded objects. This includes User, UserPerf, UserSys, UserHourly
See SYS.History.Adaptor for details about how to create user-defined metrics for SYS.History
- The 'Property' argument allows you to select a single user-defined class, including ones which are defined as %ArrayOfObjects, by specifying the string used as the embedded property name.
- The default FileName is HistoryUser_config_date_time.csv in the MGR directory.
- 'Start' and 'End' times (if necessary) are in YYYY-MM-DD HH:MM:SS format.
- 'Function' can be a comma-delimited list one or more of these summary functions: "Avg", "Max", "Min", StDev", Med" or "Tot". The default is to include all summary functions. Only used for Hourly/Daily summary classes, otherwise ignored.
The 'Keep' argument allows you to over ride the system default (a value of "0" or "" uses the system default)
Returns the number of entries purged.
The 'Day' argument sets the end date of the collection, with the default of "0" being the start of today (i.e. $H+Day), which would collect everything for yesterday. A "-1" would collect the day before yesterday; a "1" would collect today (as much as there is).