KB45002: How to Poll for an Intelligent Cube Cache Status Using the MicroStrategy Intelligence Server SDK 9.3.1-10.x

The interface IDSSCubeAdmin is used to manage cubes cache in Strategy SDK 9.3.1 - 10.x. The following code can be used to obtain this interface from the IDSSServerAdmin11 object then poll the cache for its status:

Private Sub Form_Load()   
    Dim oServerAdmin As IDSSServerAdmin11
    Dim oProjectList As IDSSProjectInstances
    Dim oProject As IDSSProjectInstance
    Dim nProjID As Integer
    Dim oReportCacheAdmin As IDSSReportCacheAdmin2
'Obtain Server Admin from the Session object
    Set oServerAdmin = MySession.ServerAdmin
'Obtain the list of projects.
    Set oProjectList = oServerAdmin.ProjectInstances(DssServerRefreshNo)
'From the project list, obtain the desired project. An iteration could be used to locate the project by name
    Set oProject = oProjectList.ItemByIndex(1)
'Extract the internal project ID, which is diferent to the DSSID of the Project object
    nProjID = oProject.ID
'Get the Cube Admin
    Dim oCubeAdmin As IDSSCubeAdmin
    Dim oCubeInfos As IDSSCubeInfos
    Dim oCubeInfo As IDSSCubeInfo
    Const CUBE_ID As String = "FBEB802D4BF97F94AC2137911E5B3E09"
   
    Set oCubeAdmin = oServerAdmin.CubeAdministrator(nProjID)
    Set oCubeInfos = oCubeAdmin.GetCubeInfos(CUBE_ID, DssCubeInfoDetail)
    strOut ("Cache Count: " & oCubeInfos.Count)
   
    Set oCubeInfo = oCubeInfos.Item(1)
    strOut ("Cube Name: " & oCubeInfo.CubeName)
   
   Dim status As Integer
          status = oCubeInfo.status
          If ((status And DssCubeActive) = DssCubeActive ) Then
            strOut ("Cube Status: Active")
            End If
          If ((status And DssCubeDirty) = DssCubeDirty) Then
            strOut ("Cube Status: Dirty")
            End If
          If ((status And DssCubeLoaded) = DssCubeLoaded) Then
            strOut ("Cube Status: Loaded")
            End If
          If ((status And DssCubeProcessing) = DssCubeProcessing) Then
            strOut ("Cube Status: Processing")
            End If
          If ((status And DssCubeReady) = DssCubeReady) Then
            strOut ("Cube Status: Ready")
            End If
          If ((status And DssCubeImported) = DssCubeImported) Then
            strOut ("Cube Status: Imported")
            End If
          If ((status And DssCubeForeign) = DssCubeForeign) Then
            strOut ("Cube Status: Foreign")
            End If
          If ((status And DssCubeInfoDirty) = DssCubeInfoDirty) Then
            strOut ("Cube Status: Info Dirty")
            End If
          If ((status And DssCubeLoadPending) = DssCubeLoadPending) Then
            strOut ("Cube Status: Load Pending")
            End If
          If ((status And DssCubePersisted) = DssCubePersisted) Then
            strOut ("Cube Status: Persisted")
            End If
          If ((status And DssCubeReserved) = DssCubeReserved) Then
            strOut ("Cube Status: Reserved")
            End If
          If ((status And DssCubeUnloadPending) = DssCubeUnloadPending) Then
            strOut ("Cube Status: Unload Pending")
            End If
End Sub
Private Sub strOut(str As String)
    strMessage = strMessage & vbCrLf & str
    txtXML.Text = strMessage
End Sub

 
 
Note:
The status in Desktop will be different than that retrieved through the COMSDK.  The following are the translations between Desktop and the status retrieved via code above:
Desktop 'A' = DssCubeActive
Desktop 'D' = DssCubeDirty
Desktop 'M' = DssCubeInfoDirty
Desktop 'L' = DssCubeLoaded
Desktop 'F' = DssCubePersisted
Desktop 'P' = DssCubeProcessing
 
The example provided in this document is provided “as-is” and user has read the following customization warning:
ADDITIONAL INFORMATION:
The Strategy SDK allows you to customize several Strategy products and extend and integrate the Strategy business intelligence functionality into other applications. However, before changing the way Strategy products look or behave, it is helpful to understand how the application is built. For more information regarding the Strategy products or the process of customizing Strategy products, please refer to Strategy Developer Zone (https://developer.microstrategy.com).
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/us/services/support/contact.
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.

000020513