Skip to main content

%DeepSee.CubeManager.RegistryMapCube

Class %DeepSee.CubeManager.RegistryMapCube Extends (%RegisteredObject, %XML.Adaptor, %JSON.Adaptor) [ System = 4 ]

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

Properties​

Group​

Relationship Group As %DeepSee.CubeManager.RegistryMapGroup [ Cardinality = one, Inverse = Cubes ];

The group this cube currently belongs to

SubjectAreas​

Relationship SubjectAreas As %DeepSee.CubeManager.RegistryMapSubjectArea [ Cardinality = children, Inverse = BaseCube ];

Group of subject areas that use this cube

CubeKey​

Property CubeKey As %ZEN.Datatype.string;

Normalized Key of the cube

CubeDisplayName​

Property CubeDisplayName As %ZEN.Datatype.string;

Current display name of the cube

NaturalGroup​

Property NaturalGroup As %String;

Store the information about this cube's minimal natural group

CustomBuildOrder​

Property CustomBuildOrder As %Integer;

This is the cube's position within the determined build order for the group as a whole.

NaturalBuildOrder​

Property NaturalBuildOrder As %Integer;

The build order that must be maintained within a cub'es natural group.

LastModDate​

Property LastModDate As %String(%JSONINCLUDE = "OUTPUTONLY", XMLPROJECTION = "NONE") [ Calculated ];

Last modification date of this cube definition

LastUpdate​

Property LastUpdate As %String(%JSONINCLUDE = "OUTPUTONLY", XMLPROJECTION = "NONE") [ Calculated ];

Last data update of this cube

UpdatePlan​

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.

Disabled​

Property Disabled As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

Disabled = 1 will block all automatic updates while leaving the cube visible in the registry.

BuildFrequency​

Property BuildFrequency As %Integer [ InitialExpression = 1 ];

Indicates how often the cube is to be built, in units of BuidTimeUnit

BuildTimeUnit​

Property BuildTimeUnit As %String(DISPLAYLIST = ",Day,Week,Month", VALUELIST = ",Day,Week,Month") [ InitialExpression = "Week" ];

Base unit of time for cube builds.

BuildDayOfWeek​

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.

BuildDayOfMonth​

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.

SynchFrequency​

Property SynchFrequency As %Integer [ InitialExpression = 1 ];

Indicates how often the cube is to be synched, in units of SynchTimeUnit

SynchTimeUnit​

Property SynchTimeUnit As %String(DISPLAYLIST = ",Minute,Hour,Day", VALUELIST = ",Minute,Hour,Day") [ InitialExpression = "Day" ];

Base unit of time for cube synchs.

DSTimeEnabled​

Property DSTimeEnabled As %ZEN.Datatype.boolean(%JSONINCLUDE = "OUTPUTONLY") [ Calculated ];

Indicates whether or not the source class for this cube is DSTIME enabled, and so whether or not this cube can be synched.

BuildAsynch​

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.

PreSynchCode​

Property PreSynchCode As %ZEN.Datatype.string(MAXLEN = "");

A COS executable line of code that will be run prior to the synchronization of this cube.

PostSynchCode​

Property PostSynchCode As %ZEN.Datatype.string(MAXLEN = "");

A COS executable line of code that will be run immediately after the synchronization of this cube.

PostBuildCode​

Property PostBuildCode As %ZEN.Datatype.string(MAXLEN = "");

A COS executable line of code that will be run immediately after the build of this cube.

DependentCubes​

Property DependentCubes As %ZEN.Datatype.string(MAXLEN = "");

A comma-delimited list of cubes that have relationship dependencies on this one

IndependentSync​

Property IndependentSync As %ZEN.Datatype.boolean(XMLPROJECTION = "none") [ InitialExpression = 0, Internal ];

Transient property to indicate whether the cube should ignore dependencies when synchronized. This is not stored as part of the registry definition and is controlled by the RegistryMap setting and environmental settings.

Methods​

%OnNew​

Method %OnNew(pCubeName = "") As %Status

UpdateSubjectAreas​

Method UpdateSubjectAreas() As %Status [ Internal ]

Repair​

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.

DSTimeEnabledGet​

Method DSTimeEnabledGet() As %Boolean

CubeDisplayNameGet​

Method CubeDisplayNameGet() As %String

LastModDateGet​

Method LastModDateGet() As %String

LastUpdateGet​

Method LastUpdateGet() As %String