KB8576: How to Obtain the Security Roles and User Groups Existing in a Metadata by Using the MicroStrategy Intelligence Server API in MicroStrategy SDK 9.4.1

Existing Security Roles and User Groups can be obtained from the Configuration Object within the Server Definition object. A Server Definition Object contains all of the configuration information needed by a Strategy Intelligence Server. Upon start up, the Strategy Intelligence Server will load a Server Definition Object from the Metadata. The Configuration Object contains folders for different types of administration objects.
 
The following sample code explains the necessary steps to retrieve all User Groups and Security Roles exsting in a Metadata by using the Strategy Intelligence Server API in Strategy SDK 9.4.1:
 

1. Create and initialize an IDSSDataSource Object as follows
   

   
   MyDataSource.Mode = DssConnectionModeServerAccess
   MyDataSource.Type = DssDataSourceTypeServer
   MyDataSource.Location = "MY_SERVER" 'Here goes your Server name
   MyDataSource.Port = 0
   MyDataSource.AuthMode = DssAuthStandard
   MyDataSource.login = "Administrator" 'Here goes your Administrator login
   MyDataSource.Passwd = "MY_PWD" 'Here goes your Administrator password
   MyDataSource.ProjectName = "VMall" 'Here goes your Project name
   MyDataSource.Init

   
   
2. Initialize an IDSSSession from this DssDataSource
   

   
   Set oSession = MyDataSource.CreateSession

   
   
3. Initialize an IDSSSource from type DssRoleObjectSource
   

   
   Set MySource = oSession.Component(DssRoleObjectSource)

   
   
4. Retrieve the Configuration Root Folder. This folder contains the administration objects as IDSSFolder Objects
   

   
   Set RootFolder = MySource.Configuration.Root

   
   
5. Retrieve the IDSSFolder Objects containing Security Roles and User Groups. Item(6) in RootFolder contains the user groups, while Item (5) contains the Security Roles.
   

   
   Set MyFolder = MySource.Configuration.Root.Item(4)
   For i = 1 To MyFolder.Count
   Call MsgBox(i & " " & MyFolder.Item(i).Name)
   Next i
   
   Set MyFolder = MySource.Configuration.Root.Item(5)
   For i = 1 To MyFolder.Count
   Call MsgBox(i & " " & MyFolder.Item(i).Name)
   Next i

   
   

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.