Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%DeepSee] >  [CubeManager] >  [RegistryMapCube]
Private  Storage   

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

Contains the information about a specific cube within the registry map.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
24 7


Summary

Properties
BuildAsynch BuildDayOfMonth BuildDayOfWeek BuildFrequency
BuildTimeUnit CubeDisplayName CubeKey CustomBuildOrder
DSTimeEnabled DependentCubes Disabled Group
LastModDate LastUpdate NaturalBuildOrder NaturalGroup
PostBuildCode PostSynchCode PreSynchCode SubjectAreas
SynchFrequency SynchTimeUnit UpdatePlan

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OnNew %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject CubeDisplayNameGet DSTimeEnabledGet LastModDateGet
LastUpdateGet Repair XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType


Properties

• property BuildAsynch as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
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 ];
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" ];
Base unit of time for cube builds.
• property CubeDisplayName as %ZEN.Datatype.string;
Current display name of the cube
• property CubeKey as %ZEN.Datatype.string;
Normalized Key of the cube
• property CustomBuildOrder as %Integer;
This is the cube's position within the determined build order for the group as a whole.
• property DSTimeEnabled as %ZEN.Datatype.boolean [ Calculated ];
Indicates whether or not the source class for this cube is DSTIME enabled, and so whether or not this cube can be synched.
• property DependentCubes as %ZEN.Datatype.string(MAXLEN="");
A comma-delimited list of cubes that have relationship dependencies on this one
• property Disabled as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Disabled = 1 will block all automatic updates while leaving the cube visible in the registry.
• relationship Group as %DeepSee.CubeManager.RegistryMapGroup [ Inverse = Cubes,Cardinality = one ];
The group this cube currently belongs to
• property LastModDate as %String(XMLPROJECTION="NONE") [ Calculated ];
Last modification date of this cube definition
• property LastUpdate as %String(XMLPROJECTION="NONE") [ Calculated ];
Last data update of this cube
• property NaturalBuildOrder as %Integer;
The build order that must be maintained within a cub'es natural group.
• property NaturalGroup as %String;
Store the information about this cube's minimal natural group
• property PostBuildCode as %ZEN.Datatype.string(MAXLEN="");
A COS executable line of code that will be run immediately after the build of this cube.
• property PostSynchCode as %ZEN.Datatype.string(MAXLEN="");
A COS executable line of code that will be run immediately after the synchronization of this cube.
• property PreSynchCode as %ZEN.Datatype.string(MAXLEN="");
A COS executable line of code that will be run prior to the synchronization of this cube.
• relationship SubjectAreas as %DeepSee.CubeManager.RegistryMapSubjectArea [ Inverse = BaseCube,Cardinality = children ];
Group of subject areas that use this cube
• property SynchFrequency as %Integer [ InitialExpression = 1 ];
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" ];
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" ];
Plan for how the cube is to be managed by the build/synch tasks.

Methods

• method %OnNew(pCubeName="") as %Status
This callback method is invoked by the %New method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

• method CubeDisplayNameGet() as %String
This is a Get accessor method for the CubeDisplayName property.
• method DSTimeEnabledGet() as %Boolean
This is a Get accessor method for the DSTimeEnabled property.
• method LastModDateGet() as %String
This is a Get accessor method for the LastModDate property.
• method LastUpdateGet() as %String
This is a Get accessor method for the LastUpdate property.
• method Repair(pMap As %DeepSee.CubeManager.RegistryMap = "") as %Status
Convenience method for the UI interface to perform a repair build of this cube's entire dependency chain.


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