KB19384: How to obtain information regarding a user's preferences in MicroStrategy Web SDK

The example provided in this document is provided “as-is” to the user and assumes that the user:

• Can program, compile (e.g. javac, jikes, etc.), and execute Java programs
• Can configure environment variables (e.g. JAR files, property files, etc.)
• Have all the necessary tools to create Java applications (JDK, IDE, etc.)
• Has access to the Strategy SDK documentation.
• Has read the customization warning at the bottom of this document

 
PREREQUISITES:
 
For the sample to work, the Strategy Web JAR files must be accessible by the Java Runtime
Environment. The Strategy Web JAR files can be found under:

• Strategy Web Universal (JSP): {web_root}/WEB-INF/lib directory.
• Strategy Web (.NET): Program Files\Common Files\Strategy directory.

Note:
 
More elaborate programs will require additional library files and are out of the scope of this document.
Preferences in Strategy Web 9.0.x. are cascaded from multiple levels to give the final value for a user's preference. Each level ranges from system to user/project, with the more granular level having precedence over the higher levels.
 
The following is the order of precedence for preferences:
 

• User/Project - Prefences that have been set for one user and one project.
• User - Preferences that have been set for one user and for all projects.
• Project - Preferences that have been applied to only one project.
• Server - Preferences that are the global defaults for all the projects on a given Strategy Intelligence Server.
• System - Preferences that are the global defaults for Strategy Intelligence Servers connected to a given web server.

The following is a standalone Java example to check the different preferences level for a given user's session. This example checks the preference WebPreferenceDpiConversion. A list of Web Preferences can be found in the Strategy Enumeration EnumWebPreferences in the Strategy Developers Library Java API Reference.
 
 

package com.tom.standalone;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.webapi.EnumDSSXMLApplicationType;
import com.Strategy.web.objects.*;
import com.Strategy.web.preferences.*;
public class PreferencesLevelStandAlone {
	
	private static boolean LogToConsole = true;
	
	private static WebObjectsFactory factory = null;
	private static  WebIServerSession serverSession= null;
	private static Preferences prefs;
	
	public static void main(String[] args) {	
	  
	  //Create factory object and object source.
	  factory=WebObjectsFactory.getInstance();
	  serverSession=factory.getIServerSession();
	  
	  //Setting up Session information
	  serverSession.setServerName("IServer");
	  serverSession.setServerPort(0);
	  serverSession.setProjectName("Strategy Tutorial");
	  serverSession.setLogin("user");
	  serverSession.setPassword("");
	  serverSession.setApplicationType(EnumDSSXMLApplicationType.DssXmlApplicationCustomApp); 	  
	  
	  try {	
		  
		  String SessionID = serverSession.getSessionID();
		  
		  prefs = PreferencesMgr.getInstance().getUserPreferences(serverSession);
		  
		  String prefToCheck = EnumWebPreferences.WebPreferenceDpiConversion;
		  
		  out("Preference Levels for", prefToCheck + "\n");
		  out("User/Project", getPrefAtLevel(prefToCheck, EnumPreferenceLevels.USER_PROJECT));
		  out("User", getPrefAtLevel(prefToCheck, EnumPreferenceLevels.USER));
		  out("Project", getPrefAtLevel(prefToCheck, EnumPreferenceLevels.PROJECT));
		  out("Server", getPrefAtLevel(prefToCheck, EnumPreferenceLevels.SERVER));
		  out("System", getPrefAtLevel(prefToCheck, EnumPreferenceLevels.SYSTEM));
		  
		  
		  /********************
		   * If you need to output all preferences
		   * 
		  Enumeration enums = prefs.listNames();
		  
		  while (enums.hasMoreElements()){
			 String preferenceString = (String)enums.nextElement();
			 out(preferenceString, prefs.getValue(preferenceString));
			 
		  } 
		  **********************/
	  }catch (PreferencesException e){
		  out("PreferenceException", e.toString());
	  }catch (Exception e){
		  out(e.toString());
	  }
	}
	private static String getPrefAtLevel(String s, PreferenceLevel p){
		return prefs.getValueAt(s, p);
	}
	private static void out(String t, String m){
		if (LogToConsole) System.out.println(t + ": "+ m);
	}
	
	private static void out(String m){
		if (LogToConsole) System.out.println(m);
	}
}

 
 
 
Other important files regarding preferences:

1. sys_definitions.xml: Contains the definitions for Strategy Web preference values. It provides a complete list of all preference parameter names which enable you to use preference values in defining styles.
2. sys_defaults.xml: Contains the default values for Strategy Web preference values.

 
 
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://community.strategy.com/topic/0TO44000000FliLGAS/sdk).
 
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/en/support/contact-support.
 
 
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.