Defining DeepSee Models Compiling and Building Cubes [Home] [Back] [Next]

• When to recompile and rebuild
• How to compile a cube
• How to build a cube in the Architect
• How to build a cube programmatically
• How to minimize cube size during development
• How to use parallel processing during a cube build
• Build errors
• DeepSee task log

• Cube synchronization, which updates cubes incrementally (and permits queries to be executed at the same time). See the chapter “Keeping the Cubes Current” in the above listed book.
• The DeepSee Cube Manager utility, which you typically use for production systems. The Cube Manager creates automated tasks that build or synchronize cubes according to your specifications. See the chapter “Keeping the Cubes Current” in the above listed book.
• The cube version feature, which enables you to modify a cube definition, build it, and provide it to users, with only a short disruption of running queries. See the appendix “Using Cube Versions” in the above listed book.

1. Click Compile.
   The system starts to compile the class and displays a dialog box that shows progress.
   If you have made changes that you have not yet saved, the system saves them before compiling the cube.
2. Click OK.

1. Click Build.
   The system displays a dialog box.
2. Optionally specify a value for Maximum Number of Records to Build.
   By default, DeepSee iterates through all records in the source table and builds the same number of records to the fact table. You can override this behavior when you build the cube. If you specify the Maximum Number of Records to Build option, DeepSee iterates through only that number of records. The result is a smaller fact table that DeepSee builds more quickly.
   If the Maximum Number of Records to Build field is initialized with a number, that means that the cube class overrides the default behavior. (For details, see the maxFacts attribute for <cube> in the appendix “Reference Information for Cube Classes.”) In this case, you can either use the value provided by the cube class or enter a smaller value.
3. Click Build.
   DeepSee starts to build the cube and displays progress as it does so.
4. Click Done.

classmethod %BuildCube(pCubeName As %String, pAsync As %Boolean = 1, pVerbose As %Boolean = 1, pIndexOnly As %Boolean = 1, pMaxFacts As %Boolean = 0, pTracking As %Boolean = 0, ByRef pBuildStatistics As %String = "") as %Status

• pCubeName is the logical name of the cube as given in its XData block; this is not case-sensitive.
• pAsync controls whether DeepSee performs the build in multiple background processes. If this argument is true, the system uses multiple processes and does not return until they are all complete. If this argument is false, the system uses a single process and does not return until it is complete.
  Note:

  If you have specified the cube option Initial build order, DeepSee ignores the value of pAsync and uses a single process to build the cube. These options are described in “Specifying Cube Options,” earlier in this book.
• pVerbose controls whether the method writes status information. If this argument is 1, the system writes status updates to the command line. (This argument does not affect whether the method writes build errors or other logging information.)
• pIndexOnly controls whether the method only updates the indices. If this argument is 1, the system only updates the indices of the fact table.
• pMaxFacts specifies the maximum number of rows in the fact table. This determines the number of rows of the base table that the system uses when building the cube.
  If pMaxFacts is 0, the default, all rows of the base table are processed.
• pTracking is for internal use.
• pBuildStatistics returns an array of information about the cube build. This array has the following nodes:

  Node	Value
  pBuildStatistics(“elapsedTime”)	Elapsed build time, in seconds.
  pBuildStatistics(“errors”)	Number of build errors.
  pBuildStatistics(“factCount”)	Number of facts that were built and indexed.
  pBuildStatistics(“missingReferences”)	Number of missing references.
  pBuildStatistics(“expressionTime”)	Time spent processing sourceExpressions to build the cube elements.
  pBuildStatistics(“iKnowTime”)	Time spent building iKnow indices.

 set status = ##class(%DeepSee.Utils).%BuildCube("patients")

• Number of processors used.
• Total elapsed time taken by the build process
• Total amount of time spent evaluating source expressions, summed across all processors.

 
Building cube [patients]
Existing cube deleted.
Fact table built:        1,000 fact(s) (2 core(s) used)
Fact indices built:      1,000 fact(s) (2 core(s) used)
Complete
Elapsed time:                  1.791514s
Source expression time:        0.798949s

• If you build the cube in the Architect, specify a value for Maximum Number of Records to Build.
• Edit the cube class in Studio and add the maxFacts attribute to the <cube> element. See the appendix “Reference Information for Cube Classes.”
  If you do so, be sure to remove this attribute before deployment.
• Build the cube in the Terminal and specify the pMaxFacts argument. See “Building a Cube in the Terminal” earlier in this chapter.

• You specify pAsync as 1 when you build the cube (see “Building the Cube Programmatically”).
• The source for a cube is a persistent class (rather than a data connector). Data connectors are described in the DeepSee Implementation Guide.
• The persistent class is bitmap-friendly.
• The Initial build order option of the cube has not been set. These options are described in “Specifying Cube Options,” earlier in this book.

• The desired number of high priority agents — that is, half of the desired total agent count.
• Null — to restore the default behavior.

 d ##class(%DeepSee.Utils).%SetAgentCount(5)

• Where you can see build errors
• Fact count, which is a useful indicator of build problems in all scenarios
• Possible causes of build errors
• How to recover from build errors

• Look for the log file install-dir/mgr/DeepSeeUpdate_cube_name_NAMESPACE.log, where cube_name is the name of the cube, and NAMESPACE is the namespace in which this cube is defined.
  The time stamp in this file uses $NOW to write the local date and time, ignoring daylight saving time.
• Use the %PrintBuildErrors() method of %DeepSee.Utils, as follows:

  do ##class(%DeepSee.Utils).%PrintBuildErrors(cubename)

  Where cubename is the logical name of the cube, in quotes.
  This method displays information about all build errors. For example (with added line breaks):

  SAMPLES>do ##class(%DeepSee.Utils).%PrintBuildErrors("patients")
      1   Source ID: 13
          ERROR #5001: Error inserting/updating fact: (Source ID:'13') 
  Field 'DeepSee_Model_PatientsCube.Fact.Dx3295243289' (value 'abc') failed validation
   
      2   Source ID: 22
          ERROR #5001: Error inserting/updating fact: (Source ID:'22') 
  Field 'DeepSee_Model_PatientsCube.Fact.Dx3295243289' (value 'abc') failed validation
   
      3   Source ID: 37
          ERROR #5001: Error inserting/updating fact: (Source ID:'37') 
  Field 'DeepSee_Model_PatientsCube.Fact.Dx3295243289' (value 'abc') failed validation
  ...
  81 build error(s) for 'patients'

• You limit the fact count as discussed earlier in this chapter.
• The cube class also defines the %OnProcessFact() callback, which you can use to exclude records from the cube. See “Using Advanced Features of Cubes and Subject Areas” in the Advanced DeepSee Modeling Guide.

1. Examine any levels that use range expressions, and verify that these levels do not drop records. See “Validating Your Levels,” later in this book.
   An error of this kind affects the index count but not the fact count.
2. Try disabling selected dimensions or measures. Then recompile and rebuild to isolate the dimension or measure that is causing the problem.

ERROR #5002: Cache error: <STORE>%ConstructIndices+44^Cube.cube_name.Fact.1

• Build the cube with a single process. To do so, use %BuildCube() in the Terminal, and use 0 for its second argument.
• In the <cube> element, specify bitmapChunkInMemory="false" (this is the default). When this cube is built using background processes, the system will use process-private globals instead of local variables (and will not be limited by local memory).

ERROR #5001: Missing relationship reference in RelatedCubes/Patients: source ID 1 missing reference to RxHomeCity 4

1. Correct the issues that cause these errors.
2. Use the %FixBuildErrors() methods of %DeepSee.Utils, as follows:

   set sc=##class(%DeepSee.Utils).%FixBuildErrors(cubename)

   Where cubename is the logical name of the cube, in quotes. This method accepts a second argument, which specifies whether to display progress messages; for this argument, the default is true.
   For example:

   Fact '100' corrected
   Fact '500' corrected
   Fact '700' corrected
    
    
   3 fact(s) corrected for 'patients'
   0 error(s) remaining for 'patients'

   Or rebuild the entire cube.

2009-11-04 16:53:35.648       2312 TaskMaster Background agents killed
2009-11-04 16:53:35.663       2312 TaskMaster Create background agents..
2009-11-04 16:53:35.739       6900 TaskMaster Agent started:1
...
2009-11-04 16:54:19.561       2312 TaskMaster Background agents killed