This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %DeepSee.CubeManager.CubeEvent


persistent class %DeepSee.CubeManager.CubeEvent extends %Library.Persistent

SQL Table Name: %DeepSee_CubeManager.CubeEvent

Records a single history event for a given cube for analysis of cube management.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property AgentCount as %Integer;
Number of agents active on the system. This is the value returned by ##class(%DeepSee.Utils).%GetAgentCount()
Property methods: AgentCountDisplayToLogical(), AgentCountGet(), AgentCountGetStored(), AgentCountIsValid(), AgentCountLogicalToDisplay(), AgentCountNormalize(), AgentCountSet()
property AsynchUpdate as %Boolean;
Record of whether or not the build was called in asynchronous mode
Property methods: AsynchUpdateDisplayToLogical(), AsynchUpdateGet(), AsynchUpdateGetStored(), AsynchUpdateIsValid(), AsynchUpdateLogicalToDisplay(), AsynchUpdateNormalize(), AsynchUpdateSet()
property BuildFrequency as %Integer;
Indicates how often the cube is scheduled to be built, in units of BuidTimeUnit
Property methods: BuildFrequencyDisplayToLogical(), BuildFrequencyGet(), BuildFrequencyGetStored(), BuildFrequencyIsValid(), BuildFrequencyLogicalToDisplay(), BuildFrequencyNormalize(), BuildFrequencySet()
property BuildTimeUnit as %DeepSee.Datatype.entityName;
Base unit of time for cube builds.
Property methods: BuildTimeUnitDisplayToLogical(), BuildTimeUnitGet(), BuildTimeUnitGetStored(), BuildTimeUnitIsValid(), BuildTimeUnitLogicalToDisplay(), BuildTimeUnitLogicalToOdbc(), BuildTimeUnitNormalize(), BuildTimeUnitSet()
property CubeEvent as %DeepSee.Datatype.entityName (DISPLAYLIST = ",PreSynchCode,PostSynchCode,PostBuildCode,Build,Synch,Register,Unregister,Update,Repair", VALUELIST = ",presynch,postsynch,postbuild,build,synch,register,unregister,update,repair");
The event being recorded.
Property methods: CubeEventDisplayToLogical(), CubeEventGet(), CubeEventGetStored(), CubeEventIsValid(), CubeEventLogicalToDisplay(), CubeEventLogicalToOdbc(), CubeEventNormalize(), CubeEventSet()
property CubeKey as %DeepSee.Datatype.entityName [ Required ];
The cube that is the subject of this event.
Property methods: CubeKeyDisplayToLogical(), CubeKeyGet(), CubeKeyGetStored(), CubeKeyIsValid(), CubeKeyLogicalToDisplay(), CubeKeyLogicalToOdbc(), CubeKeyNormalize(), CubeKeySet()
property CubeSize as %Integer;
Stores the current cube size of the cube. If the event is constructive (eg Build, Synch), this will be recorded after the event completes. If the event is destructive (eg Unregister) this is recorded prior to execution.
Property methods: CubeSizeDisplayToLogical(), CubeSizeGet(), CubeSizeGetStored(), CubeSizeIsValid(), CubeSizeLogicalToDisplay(), CubeSizeNormalize(), CubeSizeSet()
property DependencyExempt as %Boolean [ InitialExpression = 0 ];
Log if the synchronize was exempt from the dependency and only updated due to schedule.
Property methods: DependencyExemptDisplayToLogical(), DependencyExemptGet(), DependencyExemptGetStored(), DependencyExemptIsValid(), DependencyExemptLogicalToDisplay(), DependencyExemptNormalize(), DependencyExemptSet()
property ErrorCount as %Integer;
For build and synchronize, the count of errors while processing facts during this update.
Property methods: ErrorCountDisplayToLogical(), ErrorCountGet(), ErrorCountGetStored(), ErrorCountIsValid(), ErrorCountLogicalToDisplay(), ErrorCountNormalize(), ErrorCountSet()
property EventStatus as %Status;
Records the status message, if it exists, of the event after completion.
Property methods: EventStatusGet(), EventStatusGetStored(), EventStatusIsValid(), EventStatusLogicalToOdbc(), EventStatusSet()
property ExprTime as %Numeric;
For builds, the build time spent processing expressions
Property methods: ExprTimeDisplayToLogical(), ExprTimeGet(), ExprTimeGetStored(), ExprTimeIsValid(), ExprTimeLogicalToDisplay(), ExprTimeNormalize(), ExprTimeSet()
property FactsUpdated as %Integer;
The number of facts updated in this event. This will only be set in Build or Synch operations. For builds, it is equal to the final cube size.
Property methods: FactsUpdatedDisplayToLogical(), FactsUpdatedGet(), FactsUpdatedGetStored(), FactsUpdatedIsValid(), FactsUpdatedLogicalToDisplay(), FactsUpdatedNormalize(), FactsUpdatedSet()
property FinishTime as %TimeStamp;
Timestamp recorded at the completion of the cube event.
Property methods: FinishTimeDisplayToLogical(), FinishTimeGet(), FinishTimeGetStored(), FinishTimeIsValid(), FinishTimeLogicalToDisplay(), FinishTimeNormalize(), FinishTimeOdbcToLogical(), FinishTimeSet()
property MgmtGroup as %DeepSee.Datatype.entityName;
Management group the cube belongs to.
Property methods: MgmtGroupDisplayToLogical(), MgmtGroupGet(), MgmtGroupGetStored(), MgmtGroupIsValid(), MgmtGroupLogicalToDisplay(), MgmtGroupLogicalToOdbc(), MgmtGroupNormalize(), MgmtGroupSet()
property MissingRefs as %Integer;
For build and synchronize, the count of missing relationship references encountered while processing facts.
Property methods: MissingRefsDisplayToLogical(), MissingRefsGet(), MissingRefsGetStored(), MissingRefsIsValid(), MissingRefsLogicalToDisplay(), MissingRefsNormalize(), MissingRefsSet()
property NCores as %Integer;
Number of CPU cores
Property methods: NCoresDisplayToLogical(), NCoresGet(), NCoresGetStored(), NCoresIsValid(), NCoresLogicalToDisplay(), NCoresNormalize(), NCoresSet()
property StartTime as %TimeStamp;
Timestamp recorded prior to event execution
Property methods: StartTimeDisplayToLogical(), StartTimeGet(), StartTimeGetStored(), StartTimeIsValid(), StartTimeLogicalToDisplay(), StartTimeNormalize(), StartTimeOdbcToLogical(), StartTimeSet()
property SynchFrequency as %Integer;
Indicates how often the cube is scheduled to be synched, in units of SynchTimeUnit
Property methods: SynchFrequencyDisplayToLogical(), SynchFrequencyGet(), SynchFrequencyGetStored(), SynchFrequencyIsValid(), SynchFrequencyLogicalToDisplay(), SynchFrequencyNormalize(), SynchFrequencySet()
property SynchTimeUnit as %DeepSee.Datatype.entityName;
Base unit of time for cube synchs.
Property methods: SynchTimeUnitDisplayToLogical(), SynchTimeUnitGet(), SynchTimeUnitGetStored(), SynchTimeUnitIsValid(), SynchTimeUnitLogicalToDisplay(), SynchTimeUnitLogicalToOdbc(), SynchTimeUnitNormalize(), SynchTimeUnitSet()
property TotalTime as %Numeric;
Total amount of time this event took;
Property methods: TotalTimeDisplayToLogical(), TotalTimeGet(), TotalTimeGetStored(), TotalTimeIsValid(), TotalTimeLogicalToDisplay(), TotalTimeNormalize(), TotalTimeSet()
property UpdatePlan as %DeepSee.Datatype.entityName;
Plan for how the cube is to be managed by the build/synch tasks.
Property methods: UpdatePlanDisplayToLogical(), UpdatePlanGet(), UpdatePlanGetStored(), UpdatePlanIsValid(), UpdatePlanLogicalToDisplay(), UpdatePlanLogicalToOdbc(), UpdatePlanNormalize(), UpdatePlanSet()
property UserName as %DeepSee.Datatype.entityName;
Name of the user that initiated the event.
Property methods: UserNameDisplayToLogical(), UserNameGet(), UserNameGetStored(), UserNameIsValid(), UserNameLogicalToDisplay(), UserNameLogicalToOdbc(), UserNameNormalize(), UserNameSet()
property iKnowTime as %Numeric;
For builds, the build time spent processing iKnow indices
Property methods: iKnowTimeDisplayToLogical(), iKnowTimeGet(), iKnowTimeGetStored(), iKnowTimeIsValid(), iKnowTimeLogicalToDisplay(), iKnowTimeNormalize(), iKnowTimeSet()

Methods (Including Private)

private method %OnBeforeSave(pInsert As %Boolean) as %Status
This callback method is invoked by the %Save() method to provide notification that the object is being saved. It is called before any data is written to disk.

insert will be set to 1 if this object is being saved for the first time.

If this method returns an error then the call to %Save() will fail.

method TransferRegistryInfo(pCube As %String = "", pAction="", pMapCube As %DeepSee.CubeManager.RegistryMapCube = "", pMapGroup As %DeepSee.CubeManager.RegistryMapGroup = "") as %Status
Retrieves the current cube management settings from the cube registry and writes them to the event.


index (LastUpdateIndex on CubeKey,CubeEvent,FinishTime);
Index methods: LastUpdateIndexExists()

Inherited Members

Inherited Methods (Including Private)


Storage Model: CacheStorage (%DeepSee.CubeManager.CubeEvent)

FeedbackOpens in a new window