Class Reference
%DeepSee.CubeManager.RegistryMapGroup
Server:irisdocs1
Instance:IRISLATEST
User:UnknownUser
 
-
  [ENSLIB] >  [%DeepSee] >  [CubeManager] >  [RegistryMapGroup]
Private  Storage

class %DeepSee.CubeManager.RegistryMapGroup extends %RegisteredObject, %XML.Adaptor

A node representing the named cube groupings within the registry

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
15 5


Summary

Properties
BuildAsynch BuildDayOfMonth BuildDayOfWeek BuildFrequency
BuildTimeUnit Cubes Disabled GroupName
IsRegistered IsValid Map SynchFrequency
SynchTimeUnit UpdatePlan UserUpdatesLocked

Methods
%%OIDGet %AddToSaveSet %BindExport %BuildObjectGraph
%ClassIsLatestVersion %ClassName %Close %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IncrementCount %IsA %IsModified
%New %NormalizeObject %ObjectModified %OnNew
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %ValidateObject %XMLGenerate BuildGroup
CheckGroupLocks SynchronizeGroup ToArray XMLAfterExport
XMLBeforeExport XMLDTD XMLExport XMLExportInternal
XMLExportToStream XMLExportToString XMLGetSchemaImports XMLImport
XMLImportInternal XMLIsObjectEmpty XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType


Properties

• property BuildAsynch as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
GROUP DEFAULT - Flag which allows the user to select whether the build executes synchronously or asynchronously. Asynchronous build is the default.
• property BuildDayOfMonth as %Integer(MAXVAL=31,MINVAL=1) [ InitialExpression = 1 ];
If Month is selected as the BuildTimeUnit, this will allow the user to pick which day of the month this build should take place.
• property BuildDayOfWeek as %String(DISPLAYLIST=",Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday",VALUELIST=",1,2,3,4,5,6,7") [ InitialExpression = "1" ];
If week is selected for the BuildTimeUnit, this will allow the user to pick which day of the week the build should take place.
• property BuildFrequency as %Integer [ InitialExpression = 1 ];
GROUP DEFAULT - Indicates how often the cube is to be built, in units of BuidTimeUnit
• property BuildTimeUnit as %String(DISPLAYLIST=",Day,Week,Month",VALUELIST=",Day,Week,Month") [ InitialExpression = "Week" ];
GROUP DEFAULT - Base unit of time for cube builds.
• relationship Cubes as %DeepSee.CubeManager.RegistryMapCube [ Inverse = Group,Cardinality = many ];
The collection of cubes that are a part of this group
• property Disabled as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
GROUP DEFAULT - Disabled = 1 will block all automatic updates while leaving the cube visible in the registry.
• property GroupName as %ZEN.Datatype.string;
Display Name for the group.
• property IsRegistered as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
• property IsValid as %ZEN.Datatype.boolean;
This group is checked for validity and the result is stored in this property.
• relationship Map as %DeepSee.CubeManager.RegistryMap [ Inverse = Groups,Cardinality = one ];
Reference to the parent map
• property SynchFrequency as %Integer [ InitialExpression = 1 ];
GROUP DEFAULT - Indicates how often the cube is to be synched, in units of SynchTimeUnit
• property SynchTimeUnit as %String(DISPLAYLIST=",Minute,Hour,Day",VALUELIST=",Minute,Hour,Day") [ InitialExpression = "Day" ];
GROUP DEFAULT - Base unit of time for cube synchs.
• property UpdatePlan as %String(DISPLAYLIST=",Manual,Build Only,Build and Synch,Synch Only",VALUELIST=",Manual,Build,BuildSynch,Synch") [ InitialExpression = "BuildSynch" ];
GROUP DEFAULT - Plan for how the cube is to be managed by the build/synch tasks.
• property UserUpdatesLocked as %ZEN.Datatype.boolean;
This is a flag that can be set in the stored registry to prevent users from being able to adjust the Disabled setting and prevents builds from this item in the registry.

Methods

• method %OnNew(pRegGroupName="") as %Status
This callback automatically performs some of the property settings as it is created for the RegistryMap
• classmethod BuildGroup(pGroupIndex="", pAsync As %Boolean = 1, pVerbose As %Boolean = 1, pIndexOnly As %Boolean = 0, pMaxFacts As %Integer = 0, pTracking As %Boolean = 0, pUpdateAll=0, ByRef pBuildStats) as %Status
This method walks through all cubes contained in the group and checks to see if it should be updated. Prior to running the synchronize, this method will run the cube's Pre-Synch Code if present.
The cube will be built if any of these conditions are met:
- The cube has not been built within the scheduled time period
- It is the day of the week/month scheduled for the cube build
- A cube is dependent on another cube that has been built in this cycle

- The pUpdateAll flag is set to 1
• classmethod CheckGroupLocks(pGroup As %DeepSee.CubeManager.RegistryMapGroup, pLocked As %String = "") as %Status
• classmethod SynchronizeGroup(pGroupIndex="", pVerbose As %Boolean = 1, Output pFactsUpdated As %Integer, pUpdateAll=0, ByRef pSynchronizeStats, pReadCommitted As %Boolean = 1, pCheckReferences As %Boolean = 1, pAsync As %Boolean = 0) as %Status
This method walks through all cubes contained in the group and checks to see if it should be updated.
The cube will be synchronized if either of these conditions are met:
- the cube has not been synchronized within the scheduled time period
- a cube is dependent on another cube that has been synchronized in this cycle
- The pUpdateAll flag is set to 1
and the Pre-Synchronization Code has not set the $$$AbortSynch token to 1
• method ToArray(ByRef pGroup, ByRef pCubes, ByRef pBuildOrders) as %Status
Convert this group object to array form. This will match the index arrays returned using the call
%DeepSee.CubeManager.Utils.GetCubeGroups(.pGroups,.pCubes,.pBuildOrders)
trimmed to the subset of only the cubes in this group


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.