KB6381: How to Register a Project in MicroStrategy SDK 9.x

• Strategy

In MicroStrategy Desktop, project can be registered through Project Monitor under 'Administration'. The project can also be registered by using MicroStrategy SDK.

In Strategy Desktop, project can be registered through Project Monitor under 'Administration'.

Project 'Sales Analysis Module' is registered after clicking the checkbox besides project name.

The project can also be registered by using Strategy SDK. The key API call is IDSSProjectReferences.Add().

The following sample code explains how to register 'Sales Analysis Module' project on Strategy Intelligence Server 'MSTRServer'.


'-------------------------------------------------------------------------------- 
' Create a new DataSource connecting to existing IServer 
Dim MyDataSource As New DSSDataSource 
MyDataSource.Type = DssDataSourceTypeServer 
MyDataSource.Location = "MSTRServer" 
MyDataSource.Mode = DssConnectionModeServerAccess 

'-------------------------------------------------------------------------------- 
' Login into data source 
MyDataSource.AuthMode = DssAuthStandard 
MyDataSource.login = gLogin 
MyDataSource.Passwd = gPassword 
MyDataSource.Init 

'-------------------------------------------------------------------------------- 
'Create a session and connect to configuration 
Dim objSession As IDSSSession 
Set objSession = MyDataSource.CreateSession 

Dim mobjObjSource As IDSSSource 
Set mobjObjSource = objSession.Component(DssRoleConfigurationSource) 


Dim MySource As IDSSSource
Set MySource = objSession.Component(DssRoleObjectSource) 

Dim i, j, k as Integer
Dim oConfigRoot, oServDef As IDSSFolder 
Dim oServ As IDSSServerDef 
Dim oProject As IDSSObjectInfo 

Set oConfigRoot = mobjObjSource.Configuration.Root 
Set oServDef = oConfigRoot.Item("Server Definitions").Special 

'Strategy BI Developer Kit refers to the name of the server definition name given in the Configuration Wizard Set oServ = oServDef.Item("Strategy BI Developer Kit") 

'-------------------------------------------------------------------------------- 
'search for 'Sales Analysis Module' project 

Dim myProject As IDSSProject 
Dim mySearch As IDSSSearch 
Set mySearch = MySource.NewObject(DssTypeSearch) 

mySearch.NamePattern = "Sales Analysis Module" 
mySearch.Types.Add DssTypeProject 
mySearch.Domain = DssSearchRepository 

Dim myResult As IDSSFolder 
Set myResult = mySearch.Execute 
Set myProject = myResult.Item(1) 

'-------------------------------------------------------------------------------- 
'register 'Sales Analysis Module' project 

Dim myProjectReference As IDSSProjectReference 
Set myProjectReference = oServ.ProjectReferences.Add 

myProjectReference.ID = myProject.Info.ID 
myProjectReference.Name = myProject.Info.Name 
myProjectReference.LoadFlag = DssProjectLoadActive 
myProjectReference.MetadataVersion = DssMDVersionMD7 

oServ.Info.Save 

'-------------------------------------------------------------------------------- 
'Apply these changes 
Dim objMyserveradmin As IDSSServerAdmin 
Set objMyserveradmin = objSession.ServerAdmin 
Call objMyserveradmin.ApplyRunTimeSettings

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.

Comment

0 comments

Details

Knowledge Article

Published:

April 24, 2017

Last Updated:

April 24, 2017

'-------------------------------------------------------------------------------- ' Create a new DataSource connecting to existing IServer Dim MyDataSource As New DSSDataSource MyDataSource.Type = DssDataSourceTypeServer MyDataSource.Location = "MSTRServer" MyDataSource.Mode = DssConnectionModeServerAccess '-------------------------------------------------------------------------------- ' Login into data source MyDataSource.AuthMode = DssAuthStandard MyDataSource.login = gLogin MyDataSource.Passwd = gPassword MyDataSource.Init '-------------------------------------------------------------------------------- 'Create a session and connect to configuration Dim objSession As IDSSSession Set objSession = MyDataSource.CreateSession Dim mobjObjSource As IDSSSource Set mobjObjSource = objSession.Component(DssRoleConfigurationSource) Dim MySource As IDSSSource Set MySource = objSession.Component(DssRoleObjectSource) Dim i, j, k as Integer Dim oConfigRoot, oServDef As IDSSFolder Dim oServ As IDSSServerDef Dim oProject As IDSSObjectInfo Set oConfigRoot = mobjObjSource.Configuration.Root Set oServDef = oConfigRoot.Item("Server Definitions").Special 'Strategy BI Developer Kit refers to the name of the server definition name given in the Configuration Wizard Set oServ = oServDef.Item("Strategy BI Developer Kit") '-------------------------------------------------------------------------------- 'search for 'Sales Analysis Module' project Dim myProject As IDSSProject Dim mySearch As IDSSSearch Set mySearch = MySource.NewObject(DssTypeSearch) mySearch.NamePattern = "Sales Analysis Module" mySearch.Types.Add DssTypeProject mySearch.Domain = DssSearchRepository Dim myResult As IDSSFolder Set myResult = mySearch.Execute Set myProject = myResult.Item(1) '-------------------------------------------------------------------------------- 'register 'Sales Analysis Module' project Dim myProjectReference As IDSSProjectReference Set myProjectReference = oServ.ProjectReferences.Add myProjectReference.ID = myProject.Info.ID myProjectReference.Name = myProject.Info.Name myProjectReference.LoadFlag = DssProjectLoadActive myProjectReference.MetadataVersion = DssMDVersionMD7 oServ.Info.Save '-------------------------------------------------------------------------------- 'Apply these changes Dim objMyserveradmin As IDSSServerAdmin Set objMyserveradmin = objSession.ServerAdmin Call objMyserveradmin.ApplyRunTimeSettings