KB5173: How to Purge the Element and Object Caches Using the MicroStrategy Intelligence Server SDK?

Element and object caches can be purged on the Strategy 10.x Intelligence Server. This can be accomplished from the 'Caches' tab under the 'Project Configuration' per each project.
 
However, administrators may request that this process be automated, especially if they need to purge these caches routinely.
 
This task can be accomplished via Strategy Administrator - Command Manager scripts. Additionally, Strategy Server Application Programming Interface (API) provides interfaces to accomplish this programmatically.

• For purging the element cache use the IDSSElementSource interface. The method IDSSElementSource::Purge clears all the objects in the element cache. In a 3-tier mode environment, the method clears the server side cache.
   
  To get to the IDSSElementSource interface, users need to get first a handle to the IDSSSession interface.
   
  Declare IDSSDataSource object and assign it to the project data source. After initializing the project data source, create a session using this project data source.
   
  For example, the Microsoft Visual Basic 6 code to read the session and getting a handle to the element source is similar to the following:
   
  

  
  Public objSession As IDSSSession
  Public ElementSource As IDSSElementSource
  Set objsession = mobjProjDS.CreateSession
  
  `mobjProjDS above points to your project IDSSDataSource
  Set ElementSource = objSession.Component(DssRoleElementSource)
  ElementSource.Purge

  
   
  
• For purging the object cache use the IDSSSource interface. The method IDSSSource::ExecuteCommand - with the command DssSrcCmdPurge purges all objects from an object cache.
   
  For example, the Visual Basic 6 code is similar to the following:
   
  

  
  Public ObjSource as IDSSSource
  Set ObjSource = objSession.Component(DssRoleObjectSource)
  ObjSource.ExecuteCommand(DssSrcCmdPurge, ,Flags)
  
  'Flags: - DssSourcePurgeClient purges client side cache
  'DssSourcePurgeServer purges server side cache

  
   
  

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@Strategy.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.