IRISLIB database
CubeEvent Class Reference

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

Inheritance diagram for CubeEvent:
Collaboration diagram for CubeEvent:

Public Member Functions

_.Library.Status OnBeforeSave (_.Library.Boolean pInsert)
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status TransferRegistryInfo (_.Library.String pCube, pAction, _.DeepSee.CubeManager.RegistryMapCube pMapCube, _.DeepSee.CubeManager.RegistryMapGroup pMapGroup)
 Retrieves the current cube management settings from the cube registry. More...
 
- Public Member Functions inherited from Persistent
_.Library.Status AcquireLock (_.Library.String locktype)
 Acquires a lock for the current instance. More...
 
_.Library.Status LoadData (_.Library.String id)
 LoadData() - loads an object from storage. More...
 
_.Library.Status OnAfterSave (_.Library.Boolean insert)
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status OnBeforeSave (_.Library.Boolean insert)
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status OnOpen ()
 This callback method is invoked by the <METHOD>Open</METHOD> method to. More...
 
_.Library.Status OnReload ()
 This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...
 
_.Library.Status OnRollBack ()
 This callback method is invoked by the <METHOD>Save</METHOD> method to. More...
 
_.Library.Status ReleaseLock (_.Library.String locktype)
 Releases a lock for the current instance. More...
 
_.Library.Status SaveData (_.Library.String id)
 SaveData() - saves an object to disk, checks uniqueness and referential More...
 
- Public Member Functions inherited from SwizzleObject
_.Library.Status OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
 This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Public Attributes

 AgentCount
 Number of agents active on the system. More...
 
 AsynchUpdate
 Record of whether or not the build was called in asynchronous mode. More...
 
 BuildFrequency
 Indicates how often the cube is scheduled to be built, in units of. More...
 
 BuildTimeUnit
 Base unit of time for cube builds. More...
 
 CubeEvent
 The event being recorded. More...
 
 CubeKey
 The cube that is the subject of this event. More...
 
 CubeSize
 Stores the current cube size of the cube. More...
 
 DependencyExempt
 Log if the synchronize was exempt from the dependency and only updated due to schedule. More...
 
 ErrorCount
 For build and synchronize, the count of errors while processing facts during this update. More...
 
 EventStatus
 Records the status message, if it exists, of the event after completion. More...
 
 ExprTime
 For builds, the build time spent processing expressions. More...
 
 FactsUpdated
 The number of facts updated in this event. More...
 
 FinishTime
 Timestamp recorded at the completion of the cube event. More...
 
 MgmtGroup
 Management group the cube belongs to. More...
 
 MissingRefs
 For build and synchronize, the count of missing relationship references encountered while. More...
 
 NCores
 Number of CPU cores. More...
 
 StartTime
 Timestamp recorded prior to event execution. More...
 
 SynchFrequency
 Indicates how often the cube is scheduled to be synched, in units of. More...
 
 SynchTimeUnit
 Base unit of time for cube synchs. More...
 
 TotalTime
 Total amount of time this event took;. More...
 
 UpdatePlan
 Plan for how the cube is to be managed by the build/synch tasks. More...
 
 UserName
 Name of the user that initiated the event. More...
 
 iKnowTime
 For builds, the build time spent processing iKnow indices. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Persistent
_.Library.Status DeleteData (_.Library.String id, _.Library.Integer concurrency)
 This method is normally generated by the storage class for persistent classes using. More...
 
_.Library.Status KillExtentData (_.Library.Boolean killstreams)
 KillExtentData() - kills extent data in storage. More...
 
_.Library.Status OnAfterBuildIndices (_.Library.String indexlist)
 This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...
 
_.Library.Status OnAfterDelete (_.Library.ObjectIdentity oid)
 This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
 
_.Library.Status OnAfterPurgeIndices (_.Library.String indexlist)
 This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...
 
_.Library.Status OnBeforeBuildIndices (_.Library.String indexlist)
 
_.Library.Status OnBeforePurgeIndices (_.Library.String indexlist)
 
_.Library.Status OnDelete (_.Library.ObjectIdentity oid)
 This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...
 
- Static Public Attributes inherited from Persistent
 XCOMPACTANCESTRY
 XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...
 
 DATALOCATIONGLOBAL = None
 Global name containing master map data for this class. More...
 
 DEFAULTGLOBAL = None
 
 DSCONDITION = None
 DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...
 
 DSINTERVAL = None
 DSINTERVAL is the number of seconds between one DSTIME value and the next. More...
 
 DSTIME = None
 If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...
 
 EXTENTQUERYSPEC = None
 The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...
 
 EXTENTSIZE = None
 The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...
 
 GUIDENABLED = None
 If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...
 
 IDENTIFIEDBY = None
 The IDENTIFIEDBY parameter can optionally be set to the name. More...
 
 MANAGEDEXTENT = None
 The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...
 
 READONLY = None
 READONLY = 1 means that objects can be created, opened but not saved or deleted. More...
 
 ROWLEVELSECURITY = None
 ROWLEVELSECURITY = 1 | <property> means that row level security is active and the list More...
 
 SQLPREVENTFULLSCAN = None
 SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...
 
 STORAGEDEFAULT = None
 STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...
 
 USEEXTENTSET = None
 
 VERSIONCLIENTNAME = None
 VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...
 
 VERSIONPROPERTY = None
 VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...
 
- Static Public Attributes inherited from SwizzleObject
 DEFAULTCONCURRENCY = None
 DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...
 
 JOURNALSTREAM = None
 If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...
 
 OBJJOURNAL = None
 if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

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

Member Function Documentation

◆ OnBeforeSave()

_.Library.Status OnBeforeSave ( _.Library.Boolean  pInsert)

This callback method is invoked by the <METHOD>Save</METHOD> 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 <METHOD>Save</METHOD> will fail.

◆ TransferRegistryInfo()

_.Library.Status TransferRegistryInfo ( _.Library.String  pCube,
  pAction,
_.DeepSee.CubeManager.RegistryMapCube  pMapCube,
_.DeepSee.CubeManager.RegistryMapGroup  pMapGroup 
)

Retrieves the current cube management settings from the cube registry.

and writes them to the event.

Member Data Documentation

◆ AgentCount

AgentCount

Number of agents active on the system.

This is the value returned by

<method>##class(DeepSee.Utils).GetAgentCount()</method>  

◆ AsynchUpdate

AsynchUpdate

Record of whether or not the build was called in asynchronous mode.

 

◆ BuildFrequency

BuildFrequency

Indicates how often the cube is scheduled to be built, in units of.

BuidTimeUnit  

◆ BuildTimeUnit

BuildTimeUnit

Base unit of time for cube builds.

 

◆ CubeEvent

The event being recorded.

 

◆ CubeKey

CubeKey

The cube that is the subject of this event.

 

◆ CubeSize

CubeSize

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.  

◆ DependencyExempt

DependencyExempt

Log if the synchronize was exempt from the dependency and only updated due to schedule.

 

◆ ErrorCount

ErrorCount

For build and synchronize, the count of errors while processing facts during this update.

 

◆ EventStatus

EventStatus

Records the status message, if it exists, of the event after completion.

 

◆ ExprTime

ExprTime

For builds, the build time spent processing expressions.

 

◆ FactsUpdated

FactsUpdated

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.  

◆ FinishTime

FinishTime

Timestamp recorded at the completion of the cube event.

 

◆ MgmtGroup

MgmtGroup

Management group the cube belongs to.


 

◆ MissingRefs

MissingRefs

For build and synchronize, the count of missing relationship references encountered while.

processing facts.  

◆ NCores

NCores

Number of CPU cores.

 

◆ StartTime

StartTime

Timestamp recorded prior to event execution.

 

◆ SynchFrequency

SynchFrequency

Indicates how often the cube is scheduled to be synched, in units of.

SynchTimeUnit  

◆ SynchTimeUnit

SynchTimeUnit

Base unit of time for cube synchs.

 

◆ TotalTime

TotalTime

Total amount of time this event took;.

 

◆ UpdatePlan

UpdatePlan

Plan for how the cube is to be managed by the build/synch tasks.

 

◆ UserName

UserName

Name of the user that initiated the event.

 

◆ iKnowTime

iKnowTime

For builds, the build time spent processing iKnow indices.