KB41044: How to Edit User Preferences using MicroStrategy Web SDK 9.2.x

The following sample code demonstrates how to programmatically change the user's preferences using the Strategy Web SDK 9.2.x.
 

import com.Strategy.web.app.beans.EnumAppWebFeatures;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.EnumWebPreferences;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.web.preferences.Preferences;
import com.Strategy.web.preferences.PreferencesMgr;
import com.Strategy.webapi.EnumDSSXMLAuthModes;
 
public class ModifyUserPreferences {
 
public static void main(String[] args) {
//Create IServer session
WebIServerSession isess = WebObjectsFactory.getInstance().getIServerSession();
isess.setServerName("IServer");
isess.setLogin("user");
isess.setPassword("pwd");
isess.setServerPort(0);
isess.setAuthMode(EnumDSSXMLAuthModes.DssXmlAuthStandard);
try{
String SessionID = isess.getSessionID();
 
//Get the preferences saved for the user
Preferences prefs = PreferencesMgr.getInstance().getUserPreferences(isess);
 
//Set the preference
prefs.setValue(EnumWebPreferences.WebPreferenceGridMaxRows, EnumAppWebFeatures.WebFeature);
prefs.save();
 
}catch (Exception e){
System.out.println("Error: " + e.getMessage());
}
}
}

 

 
Note:

• The Preferences.setValue function needs strings as inputs, so make sure to change the integer value given by the user into a string. 
• Either the session object or the user name and password need to be provided to change any preference. Because of this, it may be best to make this logic part of an ESM and have a custom login form where this value can be selected.

 
ADDITIONAL INFORMATION:
The Strategy SDK allows you to customize the standard Strategy Web interface, and extend and integrate the Strategy business intelligence functionality into other applications. However, before changing the way Strategy Web products look or behave, it is helpful to understand how the application is built. For more information regarding the Strategy Web architecture or the process of customizing Strategy Web, please refer to Strategy Developer Zone (https://resource.microstrategy.com/msdz/).
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 http://www.microstrategy.com/Support/ContactUs.asp.
 
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.