%DeepSee.CubeManager.CubeRegistry
persistent class %DeepSee.CubeManager.CubeRegistry extends %Library.Persistent, %ZEN.DataModel.Adaptor
SQL Table Name: %DeepSee_CubeManager.CubeRegistry
This class keeps track of how each cube is to be used in production. Properties of this class are accessed by various tasks to determine when a given cube should be built or synched.Property Inventory
- BuildFrequency
- BuildTimeUnit
- CubeKey
- CustomBuildOrder
- Disabled
- MgmtGroup
- NaturalBuildOrder
- SynchFrequency
- SynchTimeUnit
- UpdatePlan
Properties
property BuildFrequency as %Integer;
Indicates how often the cube is to be built, in units of
BuidTimeUnit
Property methods: BuildFrequencyDisplayToLogical(), BuildFrequencyGet(), BuildFrequencyGetStored(), BuildFrequencyIsValid(), BuildFrequencyLogicalToDisplay(), BuildFrequencyNormalize(), BuildFrequencySet()
property BuildTimeUnit as %DeepSee.Datatype.entityName (DISPLAYLIST = ",Day,Week,Month", VALUELIST = ",Day,Week,Month");
Base unit of time for cube builds.
Property methods: BuildTimeUnitDisplayToLogical(), BuildTimeUnitGet(), BuildTimeUnitGetStored(), BuildTimeUnitIsValid(), BuildTimeUnitLogicalToDisplay(), BuildTimeUnitLogicalToOdbc(), BuildTimeUnitNormalize(), BuildTimeUnitSet()
property CubeKey as %DeepSee.Datatype.entityName [ Required ];
This is the ALL CAPS cube name, to match DeepSee metadata.
Property methods: CubeKeyDisplayToLogical(), CubeKeyGet(), CubeKeyGetStored(), CubeKeyIsValid(), CubeKeyLogicalToDisplay(), CubeKeyLogicalToOdbc(), CubeKeyNormalize(), CubeKeySet()
property CustomBuildOrder as %Integer;
This determines when the current MgmtGroup will be built in
relation to other defined groups. This is entirely configurable by the user.
Property methods: CustomBuildOrderDisplayToLogical(), CustomBuildOrderGet(), CustomBuildOrderGetStored(), CustomBuildOrderIsValid(), CustomBuildOrderLogicalToDisplay(), CustomBuildOrderNormalize(), CustomBuildOrderSet()
property Disabled as %Boolean;
Disabled = 1 will block all automatic updates while leaving the
cube visible in the registry.
Property methods: DisabledDisplayToLogical(), DisabledGet(), DisabledGetStored(), DisabledIsValid(), DisabledLogicalToDisplay(), DisabledNormalize(), DisabledSet()
property MgmtGroup as %DeepSee.Datatype.entityName;
Cubes can be grouped together in user-defined management groups.
By default each cube belongs to its own group.
Property methods: MgmtGroupDisplayToLogical(), MgmtGroupGet(), MgmtGroupGetStored(), MgmtGroupIsValid(), MgmtGroupLogicalToDisplay(), MgmtGroupLogicalToOdbc(), MgmtGroupNormalize(), MgmtGroupSet()
property NaturalBuildOrder as %Integer;
This is the build order for this cube within the group. For cube
relationship networks this is calculated automatically. This can be set for
independent cubes within a group.
Property methods: NaturalBuildOrderDisplayToLogical(), NaturalBuildOrderGet(), NaturalBuildOrderGetStored(), NaturalBuildOrderIsValid(), NaturalBuildOrderLogicalToDisplay(), NaturalBuildOrderNormalize(), NaturalBuildOrderSet()
property SynchFrequency as %Integer;
Indicates how often the cube is to be synched, in units of
SynchTimeUnit
Property methods: SynchFrequencyDisplayToLogical(), SynchFrequencyGet(), SynchFrequencyGetStored(), SynchFrequencyIsValid(), SynchFrequencyLogicalToDisplay(), SynchFrequencyNormalize(), SynchFrequencySet()
property SynchTimeUnit as %DeepSee.Datatype.entityName (DISPLAYLIST = ",Minute,Hour,Day", VALUELIST = ",Minute,Hour,Day");
Base unit of time for cube synchs.
Property methods: SynchTimeUnitDisplayToLogical(), SynchTimeUnitGet(), SynchTimeUnitGetStored(), SynchTimeUnitIsValid(), SynchTimeUnitLogicalToDisplay(), SynchTimeUnitLogicalToOdbc(), SynchTimeUnitNormalize(), SynchTimeUnitSet()
property UpdatePlan as %DeepSee.Datatype.entityName (DISPLAYLIST = ",Manual,Build Only,Build and Synch,Synch Only", VALUELIST = ",Manual,Build,BuildSynch,Synch");
Plan for how the cube is to be managed by the build/synch tasks.
Property methods: UpdatePlanDisplayToLogical(), UpdatePlanGet(), UpdatePlanGetStored(), UpdatePlanIsValid(), UpdatePlanLogicalToDisplay(), UpdatePlanLogicalToOdbc(), UpdatePlanNormalize(), UpdatePlanSet()
Indexes
index (CubeKeyIndex on CubeKey) [IdKey, Type = key, Unique];
The cube key must be unique within DeepSee, so we will reinforce that here.
Index methods: CubeKeyIndexCheck(), CubeKeyIndexDelete(), CubeKeyIndexExists(), CubeKeyIndexOpen(), CubeKeyIndexSQLCheckUnique(), CubeKeyIndexSQLExists(), CubeKeyIndexSQLFindPKeyByConstraint(), CubeKeyIndexSQLFindRowIDByConstraint()
Inherited Members
Inherited Properties
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %CreateModelInstance()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DeleteModel()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetJSValidationCode()
- %GetLock()
- %GetParameter()
- %GetPropertyInfo()
- %GetSwizzleObject()
- %Id()
- %InsertBatch()
- %InvokeAction()
- %IsA()
- %IsModified()
- %IsNull()
- %IsReadOnly()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnCopyDataFromModel()
- %OnCopyDataToModel()
- %OnDeleteFinally()
- %OnDeleteModel()
- %OnDeleteSource()
- %OnDetermineClass()
- %OnGetPropertyInfo()
- %OnInvokeAction()
- %OnLoadModel()
- %OnNewSource()
- %OnOpenFinally()
- %OnOpenSource()
- %OnSaveFinally()
- %OnSaveSource()
- %OnStoreModel()
- %OnSubmit()
- %Open()
- %OpenId()
- %OpenModel()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SaveModel()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SubmitHandler()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
Storage
Storage Model: Storage (%DeepSee.CubeManager.CubeRegistry)
^DeepSee.CubeManager.CubeRegistr(ID) |
= | %%CLASSNAME
MgmtGroup
NaturalBuildOrder
CustomBuildOrder
UpdatePlan
Disabled
BuildTime
BuildDays
BuildFrequency
BuildTimeUnit
SynchFrequency
SynchTimeUnit
|