EducationSoftwareStrategy.com
StrategyCommunity

Knowledge Base

Product

Community

Knowledge Base

TopicsBrowse ArticlesDeveloper Zone

Product

Download SoftwareProduct DocumentationSecurity Hub

Education

Tutorial VideosSolution GalleryEducation courses

Community

GuidelinesGrandmastersEvents
x_social-icon_white.svglinkedin_social-icon_white.svg
Strategy logoCommunity

© Strategy Inc. All Rights Reserved.

LegalTerms of UsePrivacy Policy
  1. Home
  2. Topics

KB5682: How to Programmatically Load a Project in MicroStrategy SDK 9.x


Community Admin

• Strategy


MicroStrategy SDK 9.x can be used to change the project status programmatically. One example is registering and loading a project at startup. The MicroStrategy Intelligence Server API call related is IDSSProjectInstance::Load.

Strategy SDK 9.x can be used to change the project status programmatically. One example is registering and loading a project at startup. The Strategy Intelligence Server API call related is IDSSProjectInstance::Load.
 
Loading all projects:


'create a ServerAdmin Session 

Dim objMyserveradmin As IDSSServerAdmin 
Dim bfound As Boolean 
Set objMyserveradmin = objsession.ServerAdmin 

'create a collection of ProjectInstances 
Dim objMyprojectinstances As IDSSProjectInstances 

Set objMyprojectinstances = objMyserveradmin.ProjectInstances(DssServerRefreshSynch) 

'create a ProjectInstance 
Dim objMyInstance As IDSSProjectInstance 

'search for project instances 
bfound = False 

For Each objMyInstance In objMyprojectinstances 
	
	bfound = True 
	
	If bfound Then 
'LOAD the project instance 
		If objMyInstance.Status = DssProjectStatusOffline Then 
			objMyInstance.Load (DssProjectStatusOffline) 
		End If 
	End If 
Next

 
IDSSProjectInstance::Load needs the current project status as the input parameter. IDSSProjectInstance::Unload is the opposite API call to unload the project.
Similar usage also applies to IDSSProjectInstance::Idle and IDSSProjectInstance::Resume.
 
Resuming a project that is fully idled:

If objMyInstance.Status = DssProjectStatusFullIdle Then 
    objMyInstance.Resume (DssProjectStatusFullIdle) 
End If

 
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 4, 2017

Last Updated:

April 4, 2017