KB8496: How to Set an Object to be Hidden Using the Microstrategy Intelligence Server SDK 9.x

SUMMARY:
In Microstrategy Desktop 9.x, an Administrator can hide an object by right-clicking on an object, selecting Properties and checking/unchecking the "Hidden" option.

ACTION:

This process can be automated through the MicroStrategy Software Development Kit (SDK) 9.x. To hide an object, Administrators must use the Microstrategy Intelligence Server API method:IDSSObjectInfo::HiddenBelow is sample code on how to hide an object in Microstrategy SDK 9.x in Visual Basic is shown below:Dim MyDataSource As New DSSDataSource
Dim MySource As IDSSSource


' Login to IServer
MyDataSource.Name = "YOUR_SERVER_NAME"
MyDataSource.Type = DssDataSourceTypeProjectMD7
MyDataSource.Location = "YOUR_SERVER_NAME"
MyDataSource.Mode = DssConnectionModeServerAccess
MyDataSource.Port = 0
MyDataSource.AuthMode = DssAuthStandard
MyDataSource.login = "Administrator"
MyDataSource.Passwd = ""
MyDataSource.ProjectName = "Tutorial"
MyDataSource.Init

Dim oSession As IDSSSession
Set oSession = MyDataSource.CreateSession
Set MySource = oSession.Component(DssRoleObjectSource)


' Find an Object (Report)
Dim oObject As IDSSObjectInfo
Dim object_search As IDSSSearch
MySource.NewObject (DssTypeSearch)
Set object_search = MySource.NewObject(DssTypeSearch)
object_search.NamePattern = "Yearly Revenue Report - Prompt" 'Report Name
object_search.Domain = DssSearchRepository
Set oObject = object_search.Execute.Item(1)


' Make the object hidden
oObject.Hidden = True ' Hides the object
oObject.Hidden = False ' Makes a hidden object visible


' Save the Report
Call oObject.Save


' Close Session
MyDataSource.Reset 

The example provided in this document is provided “as-is” and user has read the following customization warning:

ADDITIONAL INFORMATION:

The MicroStrategy SDK allows you to customize several MicroStrategy products and extend and integrate the MicroStrategy business intelligence functionality into other applications. However, before changing the way MicroStrategy products look or behave, it is helpful to understand how the application is built. For more information regarding the MicroStrategy products or the process of customizing MicroStrategy products, please refer to MicroStrategy Developer Zone (https://developer.microstrategy.com).

To access the MicroStrategy Developer Zone, you must have access to the MicroStrategy Knowledge Base, you must have purchased the MicroStrategy SDK, and you must be current on your MicroStrategy 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 MicroStrategy Developer Zone, please contact MicroStrategy Technical Support at support@microstrategy.com or at (703) 848-8700. If you are an international business, please contact MicroStrategy 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 MicroStrategy users and is only directly applicable to the version stated. While this code may apply to other releases directly, MicroStrategy 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, MicroStrategy 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, MicroStrategy 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 MicroStrategy Consulting assistance.