This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions pageOpens in a new window (login required).

Caché & Ensemble 2018.1.5Opens in a new window > Class Reference > %SYS namespace > %DeepSee.CubeManager.RegistryMapCube


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

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

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

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 methods: BuildAsynchDisplayToLogical(), BuildAsynchGet(), BuildAsynchIsValid(), BuildAsynchLogicalToDisplay(), BuildAsynchLogicalToOdbc(), BuildAsynchLogicalToXSD(), BuildAsynchNormalize(), BuildAsynchSet(), BuildAsynchXSDToLogical()
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 methods: BuildDayOfMonthDisplayToLogical(), BuildDayOfMonthGet(), BuildDayOfMonthIsValid(), BuildDayOfMonthLogicalToDisplay(), BuildDayOfMonthNormalize(), BuildDayOfMonthSet(), BuildDayOfMonthXSDToLogical()
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 methods: BuildDayOfWeekDisplayToLogical(), BuildDayOfWeekGet(), BuildDayOfWeekIsValid(), BuildDayOfWeekLogicalToDisplay(), BuildDayOfWeekLogicalToOdbc(), BuildDayOfWeekNormalize(), BuildDayOfWeekSet()
property BuildFrequency as %Integer [ InitialExpression = 1 ];
Indicates how often the cube is to be built, in units of BuidTimeUnit
Property methods: BuildFrequencyDisplayToLogical(), BuildFrequencyGet(), BuildFrequencyIsValid(), BuildFrequencyLogicalToDisplay(), BuildFrequencyNormalize(), BuildFrequencySet(), BuildFrequencyXSDToLogical()
property BuildTimeUnit as %String (DISPLAYLIST = ",Day,Week,Month", VALUELIST = ",Day,Week,Month") [ InitialExpression = "Week" ];
Base unit of time for cube builds.
Property methods: BuildTimeUnitDisplayToLogical(), BuildTimeUnitGet(), BuildTimeUnitIsValid(), BuildTimeUnitLogicalToDisplay(), BuildTimeUnitLogicalToOdbc(), BuildTimeUnitNormalize(), BuildTimeUnitSet()
property CubeDisplayName as %ZEN.Datatype.string;
Current display name of the cube
Property methods: CubeDisplayNameDisplayToLogical(), CubeDisplayNameGet(), CubeDisplayNameIsValid(), CubeDisplayNameLogicalToDisplay(), CubeDisplayNameLogicalToOdbc(), CubeDisplayNameNormalize(), CubeDisplayNameSet()
property CubeKey as %ZEN.Datatype.string;
Normalized Key of the cube
Property methods: CubeKeyDisplayToLogical(), CubeKeyGet(), CubeKeyIsValid(), CubeKeyLogicalToDisplay(), CubeKeyLogicalToOdbc(), CubeKeyNormalize(), CubeKeySet()
property CustomBuildOrder as %Integer;
This is the cube's position within the determined build order for the group as a whole.
Property methods: CustomBuildOrderDisplayToLogical(), CustomBuildOrderGet(), CustomBuildOrderIsValid(), CustomBuildOrderLogicalToDisplay(), CustomBuildOrderNormalize(), CustomBuildOrderSet(), CustomBuildOrderXSDToLogical()
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 methods: DSTimeEnabledDisplayToLogical(), DSTimeEnabledGet(), DSTimeEnabledIsValid(), DSTimeEnabledLogicalToDisplay(), DSTimeEnabledLogicalToOdbc(), DSTimeEnabledLogicalToXSD(), DSTimeEnabledNormalize(), DSTimeEnabledXSDToLogical()
property DependentCubes as %ZEN.Datatype.string);
A comma-delimited list of cubes that have relationship dependencies on this one
Property methods: DependentCubesDisplayToLogical(), DependentCubesGet(), DependentCubesIsValid(), DependentCubesLogicalToDisplay(), DependentCubesLogicalToOdbc(), DependentCubesNormalize(), DependentCubesSet()
property Disabled as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Disabled = 1 will block all automatic updates while leaving the cube visible in the registry.
Property methods: DisabledDisplayToLogical(), DisabledGet(), DisabledIsValid(), DisabledLogicalToDisplay(), DisabledLogicalToOdbc(), DisabledLogicalToXSD(), DisabledNormalize(), DisabledSet(), DisabledXSDToLogical()
relationship Group as %DeepSee.CubeManager.RegistryMapGroup [ Inverse = Cubes , Cardinality = one ];
The group this cube currently belongs to
Property methods: GroupGet(), GroupGetObject(), GroupGetObjectId(), GroupGetSwizzled(), GroupIsValid(), GroupNewObject(), GroupRClose(), GroupRExec(), GroupRFetch(), GroupRelate(), GroupSQLCompute(), GroupSet(), GroupUnRelate()
property LastModDate as %String (XMLPROJECTION = "NONE") [ Calculated ];
Last modification date of this cube definition
Property methods: LastModDateDisplayToLogical(), LastModDateGet(), LastModDateIsValid(), LastModDateLogicalToDisplay(), LastModDateLogicalToOdbc(), LastModDateNormalize()
property LastUpdate as %String (XMLPROJECTION = "NONE") [ Calculated ];
Last data update of this cube
Property methods: LastUpdateDisplayToLogical(), LastUpdateGet(), LastUpdateIsValid(), LastUpdateLogicalToDisplay(), LastUpdateLogicalToOdbc(), LastUpdateNormalize()
property NaturalBuildOrder as %Integer;
The build order that must be maintained within a cub'es natural group.
Property methods: NaturalBuildOrderDisplayToLogical(), NaturalBuildOrderGet(), NaturalBuildOrderIsValid(), NaturalBuildOrderLogicalToDisplay(), NaturalBuildOrderNormalize(), NaturalBuildOrderSet(), NaturalBuildOrderXSDToLogical()
property NaturalGroup as %String;
Store the information about this cube's minimal natural group
Property methods: NaturalGroupDisplayToLogical(), NaturalGroupGet(), NaturalGroupIsValid(), NaturalGroupLogicalToDisplay(), NaturalGroupLogicalToOdbc(), NaturalGroupNormalize(), NaturalGroupSet()
property PostBuildCode as %ZEN.Datatype.string;
A COS executable line of code that will be run immediately after the build of this cube.
Property methods: PostBuildCodeDisplayToLogical(), PostBuildCodeGet(), PostBuildCodeIsValid(), PostBuildCodeLogicalToDisplay(), PostBuildCodeLogicalToOdbc(), PostBuildCodeNormalize(), PostBuildCodeSet()
property PostSynchCode as %ZEN.Datatype.string;
A COS executable line of code that will be run immediately after the synchronization of this cube.
Property methods: PostSynchCodeDisplayToLogical(), PostSynchCodeGet(), PostSynchCodeIsValid(), PostSynchCodeLogicalToDisplay(), PostSynchCodeLogicalToOdbc(), PostSynchCodeNormalize(), PostSynchCodeSet()
property PreSynchCode as %ZEN.Datatype.string;
A COS executable line of code that will be run prior to the synchronization of this cube.
Property methods: PreSynchCodeDisplayToLogical(), PreSynchCodeGet(), PreSynchCodeIsValid(), PreSynchCodeLogicalToDisplay(), PreSynchCodeLogicalToOdbc(), PreSynchCodeNormalize(), PreSynchCodeSet()
relationship SubjectAreas as array of %DeepSee.CubeManager.RegistryMapSubjectArea [ InitialExpression = $listbuild("%DeepSee.CubeManager.RegistryMapSubjectArea","BaseCube",+$this,"children",0,0) , Transient , Inverse = BaseCube , Cardinality = children ];
Group of subject areas that use this cube
Property methods: SubjectAreasGet(), SubjectAreasGetObject(), SubjectAreasGetObjectId(), SubjectAreasGetSwizzled(), SubjectAreasIsEmpty(), SubjectAreasIsValid(), SubjectAreasNewObject(), SubjectAreasRClose(), SubjectAreasRExec(), SubjectAreasRFetch(), SubjectAreasRelate(), SubjectAreasSQLCompute(), SubjectAreasSet(), SubjectAreasUnRelate()
property SynchFrequency as %Integer [ InitialExpression = 1 ];
Indicates how often the cube is to be synched, in units of SynchTimeUnit
Property methods: SynchFrequencyDisplayToLogical(), SynchFrequencyGet(), SynchFrequencyIsValid(), SynchFrequencyLogicalToDisplay(), SynchFrequencyNormalize(), SynchFrequencySet(), SynchFrequencyXSDToLogical()
property SynchTimeUnit as %String (DISPLAYLIST = ",Minute,Hour,Day", VALUELIST = ",Minute,Hour,Day") [ InitialExpression = "Day" ];
Base unit of time for cube synchs.
Property methods: SynchTimeUnitDisplayToLogical(), SynchTimeUnitGet(), SynchTimeUnitIsValid(), SynchTimeUnitLogicalToDisplay(), SynchTimeUnitLogicalToOdbc(), SynchTimeUnitNormalize(), SynchTimeUnitSet()
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.
Property methods: UpdatePlanDisplayToLogical(), UpdatePlanGet(), UpdatePlanIsValid(), UpdatePlanLogicalToDisplay(), UpdatePlanLogicalToOdbc(), UpdatePlanNormalize(), UpdatePlanSet()

Methods (Including Private)

method %OnNew(pCubeName="") as %Status
Inherited description: 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
method DSTimeEnabledGet() as %Boolean
method LastModDateGet() as %String
method LastUpdateGet() as %String
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.

Inherited Members

Inherited Methods (Including Private)

FeedbackOpens in a new window