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

KB20323: How to Access the Server Definition and Project Configuration Settings Using the MicroStrategy Web SDK 9.x


Community Admin

• Strategy


The server definition is stored in a special folder that is used for storing the collection of server definitions. This folder can be identified using the EnumDSSXMLFolderNames.DssXmlFolderNameConfigureServerDefs constant.

The server definition is stored in a special folder that is used for storing the collection of server definitions. This folder can be identified using the EnumDSSXMLFolderNames.DssXmlFolderNameConfigureServerDefs constant. A reference to this folder may be obtained in the following manner:


WebObjectSource objectSource = WebObjectsFactory.getInstance().getObjectSource();
String ServerDefFolderID = objectSource.getFolderID(EnumDSSXMLFolderNames.DssXmlFolderNameConfigureServerDefs);
WebFolder ServerDefFolder = (WebFolder) objectSource.getObject(ServerDefFolderID, EnumDSSXMLObjectTypes.DssXmlTypeFolder, true);

 
Any server definition in the collection can be obtained from the server definition folder by casting it to an object of type WebServerDef as shown below. Users should use the WebObjectinfo.Populate() method to obtain the server definition settings from the Intelligence Server:

WebObjectInfo woi = ServerDefFolder.get(i); 
if(woi.getType() == EnumDSSXMLObjectTypes.DssXmlTypeServerDef){ 
    WebServerDef currSrvrDef = (WebServerDef) woi; 
    currSrvrDef.populate(); 
}

 
Users can obtain the collection of project references in the server definition using the WebServerDef.getProjectReferences() method. Each item of the collection is a Strategy project reference:

WebProjectReferences wpr = currSrvrDef.getProjectReferences(); 
WebProjectReference wprf = wpr.get(i);

 
The current server definition settings can be obtained as a collection of type WebServerSettings as shown below:

WebServerSettings wsss = currSrvrDef.getServerSettings();

 
The server definition settings have an ID identified as EnumDSSXMLServerSettingID and are associated with a data type and a value.
The collection of individual project settings can be obtained from the project reference using the getProjectSettings() method as shown below. The settings have IDs defined by EnumDSSXMLServerProjectSettingID:

WebProjectSettings wprs = wprf.getProjectSettings();

 
Once the settings have been changed, they can be saved back to the Intelligence Server by using the WebObjectInfo.Save() method. Users should also be aware that not all server definition or project setting changes can take effect at run time. Some settings would require a restart of the Intelligence Server, or a project unload and reload to take effect.
 
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:

March 31, 2017

Last Updated:

March 31, 2017