KB224157: How to Get the Intelligent Cube Status Using MicroStrategy Web SDK

The intelligent cube status is displayed in the Intelligent Cube Monitor in Strategy Developer as shown in the screenshot below:

Sometimes it could be required to get the status programmatically. This KB article shows sample code to get the intelligent cube status with Web SDK.

1. Create a session
   

   
   serverSession.setServerName("servername");
   serverSession.setServerPort(0);
   serverSession.setProjectName("Strategy Tutorial");
   serverSession.setLogin("administrator");
   serverSession.setPassword("");	     serverSession.setApplicationType(EnumDSSXMLApplicationType.DssXmlApplicationCustomApp)

   
    
   
2. Get the Intelligent Cubes for all projects:
   

   
   MonitorSource monitor = factory.getMonitorSource(EnumWebMonitorType.WebMonitorTypeCubeCache);	           monitor.setLevel(EnumDSSXMLLevelFlags.DssXmlDetailLevel);
   CacheSource cubesMonitor = (CacheSource)monitor;
   CacheResults allCubes = cubesMonitor.getCaches();
   Enumeration<Caches> cubesEnum = allCubes.elements();

   
    
   
3. Iterate through the enumeration to get the cubes per project and the corresponding status. 
   

   
   while(cubesEnum.hasMoreElements())
   {
   
    //Get the intelligent cubes for one project
    Caches cubesPerProject = cubesEnum.nextElement();
    System.out.println("For project: " + cubesPerProject.getProjectName() + " number of cubes:"+cubesPerProject.getCount());
   
    //iterate through the list of intelligent cubes of one project
    for (int j = 0; j < cubesPerProject.getCount(); j++) {
   
    CubeCache cube = (CubeCache) cubesPerProject.get(j);
    
    //Get the name of the cube
    System.out.println("Info for cache: " + cube.getCacheSourceName());
   
    //Get the integer that represents the status of the cube
    int status = cube.getStatus();
   
    //Create an array list to translate the integer to string for the status of each cube.
    ArrayList<String> result = new ArrayList<String>();
    if(status>=EnumDSSCubeStates.DssCubeForeign)
    {
    result.add("Foreign");
    status=status-EnumDSSCubeStates.DssCubeForeign;
    } 
    if(status>=EnumDSSCubeStates.DssCubeImported)
    {
    result.add("Imported");
    status=status-EnumDSSCubeStates.DssCubeImported;
    }
    if(status>=EnumDSSCubeStates.DssCubePendingForEngine)
    {
    result.add("PendingForEngine");
    status=status-EnumDSSCubeStates.DssCubePendingForEngine;
    }
    if(status>=EnumDSSCubeStates.DssCubeUnloadPending)
    {
    result.add("Unload Pending");
    status=status-EnumDSSCubeStates.DssCubeUnloadPending;
    }
    if(status>=EnumDSSCubeStates.DssCubeLoadPending)
    {
    result.add("Load Pending");
    status=status-EnumDSSCubeStates.DssCubeLoadPending;
    }
    if(status>=EnumDSSCubeStates.DssCubeReady)
    {
    result.add("Ready");
    status=status-EnumDSSCubeStates.DssCubeReady;
    }
    if(status>=EnumDSSCubeStates.DssCubeLoaded)
    {
    result.add("Loaded");
    status=status-EnumDSSCubeStates.DssCubeLoaded;
    }
    if(status>=EnumDSSCubeStates.DssCubeDirty)
    {
    result.add("Dirty");
    status=status-EnumDSSCubeStates.DssCubeDirty;
    }
    if(status>=EnumDSSCubeStates.DssCubePersisted)
    {
    result.add("Filed");
    status=status-EnumDSSCubeStates.DssCubePersisted;
    }
    if(status>=EnumDSSCubeStates.DssCubeActive)
    {
    result.add("Active");
    status=status-EnumDSSCubeStates.DssCubeActive;
    }
    if(status>=EnumDSSCubeStates.DssCubeProcessing)
    {
    result.add("Processing");
    status=status-EnumDSSCubeStates.DssCubeProcessing;
    }
   
    //Output the status of each cube
    System.out.println(" Status:");
    for(String n : result)
    {
    System.out.println(" " +n);
    }
   
    
    }
   }

   
   

The output of this sample code would be similar to this: 

For project: Strategy Tutorial number of cubes:21
Info for cache: Actual vs Forecast Performance Cube
  Status:
     Ready
     Loaded
     Filed
     Active
Info for cache: Copy of CrimesInLondon
  Status:
     Imported
     Ready
     Loaded
     Filed
     Active

• Can program, compile (e.g. javac, jikes, etc.), and execute Java programs
• Can configure environment variables (e.g. JAR files, property files, etc.)
• Have all the necessary tools to create Java applications (JDK, IDE, etc.)
• Has access to the Strategy SDK documentation.
• Has read the customization warning at the bottom of this document

PREREQUISITES:
For the sample to work, the Strategy Web JAR files must be accessible by the Java Runtime
Environment. The Strategy Web JAR files can be found under:

• Strategy Web Universal (JSP): {web_root}/WEB-INF/lib directory.
• Strategy Web (.NET): Program Files\Common Files\Strategy directory.

Note:
More elaborate programs will require additional library files and are out of the scope of this document.
 
ADDITIONAL INFORMATION:
The Strategy SDK allows you to customize the standard Strategy Web interface, and extend and integrate the Strategy business intelligence functionality into other applications. However, before changing the way Strategy Web products look or behave, it is helpful to understand how the application is built. For more information regarding the Strategy Web architecture or the process of customizing Strategy Web, please refer to Strategy Developer Zone (https://community.strategy.com/topic/0TO44000000FliLGAS/sdk).
To access the Strategy Developer Zone, you must have access to the Strategy Knowledge Base, you must have purchased the Strategy SDK, and you must be current on your Strategy maintenance agreement. If you are a US-based business and believe that you satisfy all three of these conditions but you do not have access to the Strategy Developer Zone, please contact Strategy Technical Support at support@microstrategy.com or at (703) 848-8700. If you are an international business, please contact Strategy Technical Support at the appropriate email address or phone number found at https://www.microstrategy.com/en/support/contact-support.
 
CUSTOMIZATION WARNING:
This customization is provided as a convenience to Strategy users and is only directly applicable to the version stated. While this code may apply to other releases directly, Strategy Technical Support makes no guarantees that the code provided will apply to any future or previous builds. In the event of a code change in future builds, Strategy Technical Support makes no guarantee that an updated version of this particular customization will be provided. In the event of a code change in future builds, Strategy may not be able to provide additional code on this matter even though this customization is provided at this time for this specific build. For enhancements to this customization or to incorporate similar functionality into other versions, contact your Account Executive to inquire about Strategy Consulting assistance.