Home > Class Reference > ENSLIB namespace > %DeepSee.CubeManager.RegistryMap


class %DeepSee.CubeManager.RegistryMap extends %Library.RegisteredObject, %XML.Adaptor, %JSON.Adaptor

The class responsible for organizing the information about the registered state of all cubes on the system.

Property Inventory

Method Inventory


property BuildStartHour as %String (VALUELIST = ",00,01,02,03,04,05,06,07,08,09,10,11,12,13,14,15,16,17,18,19,20,21,22,23") [ InitialExpression = "21" ];
The hour of the acceptable build window for the day, used to construct the timestamp that defines the window when builds may be started.
Property methods: BuildStartHourDisplayToLogical(), BuildStartHourGet(), BuildStartHourIsValid(), BuildStartHourLogicalToDisplay(), BuildStartHourLogicalToOdbc(), BuildStartHourNormalize(), BuildStartHourSet()
property BuildStartMinute as %String (VALUELIST = ",00,15,30,45") [ InitialExpression = "00" ];
The quater hour of the acceptable build window for the day, used to construct the timestamp that defines the window when builds may be started.
Property methods: BuildStartMinuteDisplayToLogical(), BuildStartMinuteGet(), BuildStartMinuteIsValid(), BuildStartMinuteLogicalToDisplay(), BuildStartMinuteLogicalToOdbc(), BuildStartMinuteNormalize(), BuildStartMinuteSet()
property Description as %String (MAXLEN = 2500);
Description of this registry definition.
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Disabled as %ZEN.Datatype.boolean;
Disabled = true will suspend the automated Build and Synch tasks for this namespace.
Property methods: DisabledDisplayToLogical(), DisabledGet(), DisabledIsValid(), DisabledLogicalToDisplay(), DisabledLogicalToOdbc(), DisabledLogicalToXSD(), DisabledNormalize(), DisabledSet(), DisabledXSDToLogical()
relationship Groups as array of %DeepSee.CubeManager.RegistryMapGroup [ InitialExpression = $listbuild("%DeepSee.CubeManager.RegistryMapGroup","Map",+$this,"many",0,0) , Transient , Inverse = Map , Cardinality = many ];
The collection of groups that are defined in the overall sysem registry map
Property methods: GroupsGet(), GroupsGetObject(), GroupsGetObjectId(), GroupsGetSwizzled(), GroupsIsEmpty(), GroupsIsValid(), GroupsNewObject(), GroupsRClose(), GroupsRExec(), GroupsRFetch(), GroupsRelate(), GroupsSQLCompute(), GroupsSet(), GroupsUnRelate()
property IndependentSync as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Controls whether cubes within a group are synchronized based on the relationship dependency (the default) or if it synchronizes solely based on schedule.
Property methods: IndependentSyncDisplayToLogical(), IndependentSyncGet(), IndependentSyncIsValid(), IndependentSyncLogicalToDisplay(), IndependentSyncLogicalToOdbc(), IndependentSyncLogicalToXSD(), IndependentSyncNormalize(), IndependentSyncSet(), IndependentSyncXSDToLogical()
property SerialUpdates as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If this property is set to 1, the updater tasks will not job off the group update code and will instead run all updates in a single process.
Property methods: SerialUpdatesDisplayToLogical(), SerialUpdatesGet(), SerialUpdatesIsValid(), SerialUpdatesLogicalToDisplay(), SerialUpdatesLogicalToOdbc(), SerialUpdatesLogicalToXSD(), SerialUpdatesNormalize(), SerialUpdatesSet(), SerialUpdatesXSDToLogical()
property StorageClass as %String (XMLPROJECTION = "NONE");
When this is loaded into memory, this stores the name of the class the map was loaded from.
Property methods: StorageClassDisplayToLogical(), StorageClassGet(), StorageClassIsValid(), StorageClassLogicalToDisplay(), StorageClassLogicalToOdbc(), StorageClassNormalize(), StorageClassSet()


method CreateMapTimeStamp() as %String [ Language = objectscript ]
Return the current build time in hh:mm:ss format.
classmethod LoadFromClass(pClassname As %String, Output pStatus As %Status) as %DeepSee.CubeManager.RegistryMap [ Language = objectscript ]
Deserialize the XML from the Registry XData block into a RegistryMap model.
method Print() [ Language = objectscript ]
Diagnostic method, prints information about the current map.
method SaveToClass(pClassName="") as %Status [ Language = objectscript ]
Serializes the current Registry structure into XML inside the XData block in the relevant Registry class.
method ToArray(ByRef pGroups, ByRef pCubes, ByRef pBuildOrders, ByRef pLookup) as %Status [ Language = objectscript ]
Converts the current map into an array. If this is the full {registered}U{unregistered} map, the first three arrays will match those returned using the call
This method also returns a special lookup index which can be used to quickly reference the group or cube objects contained in the current map object.
  Set CubeName = "HOLEFOODS"
  Set Map = ##class(%DeepSee.CubeManager.Utils).BuildRegistryMap()
  Do Map.ToArray(.Groups,.Cubes,.BuildOrders,.Lookup)
  Set GroupIdx = $LG(Lookup("cubes",CubeName),1)
  Set CubeIdx = $LG(Lookup("cubes",CubeName),2)
  Set Cube = Map.Groups.GetAt(GroupIdx).Cubes.GetAt(CubeIdx)
method Validate() as %Status [ Language = objectscript ]
Perform validation on the Map object to determine if it is ready for save.

Inherited Members

Inherited Methods