KB13809: How to Search for a MicroStrategy User Object and Access Its Properties Using MicroStrategy Web SDK 10.x

Using the Strategy Java Web SDK, it is possible to search for Strategy User objects and access their properties. The following example shows how to search the metadata for a specific user, then output some of its properties such as the user's full name and if it is enabled:
 

package customclasses.misc;

import com.Strategy.webapi.*;
import com.Strategy.web.objects.*;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.web.objects.admin.users.WebUser;
import com.Strategy.web.objects.WebFolder;
import com.Strategy.web.objects.WebObjectSource;

public class FindUser {

	public FindUser() {
		super();
	}

	public static void main(String[] args) {
		// create factory object
		WebObjectsFactory factory = WebObjectsFactory.getInstance();
		WebIServerSession serverSession = factory.getIServerSession();
		
		// set up session properties
		serverSession.setServerName("Server");
		serverSession.setServerPort(0);
		serverSession.setProjectName("Project");
		serverSession.setLogin("uid");
		serverSession.setPassword("pwd");
		
		WebObjectSource wos = factory.getObjectSource();
		WebUser user = null;
		WebSearch search = wos.getNewSearchObject();
		String strUserName = "testuser";

		try {
			search.setAbbreviationPattern(strUserName);
			search.setSearchFlags(search.getSearchFlags() | EnumDSSXMLSearchFlags.DssXmlSearchAbbreviationWildCard);

			//asynchronized search
			search.setAsync(false);

			//search for user
			search.types().add(new Integer(EnumDSSXMLObjectSubTypes.DssXmlSubTypeUser));

			//search on repository
			search.setDomain(EnumDSSXMLSearchDomain.DssXmlSearchDomainRepository);
			search.submit();
			
			WebFolder f = search.getResults();

			//since login id is unique identity, if found, the first one is the user
			if (f.size() > 0) {
				user = (WebUser) f.get(0);
				user.populate();
				System.out.println(user.getLoginName());
				System.out.println(user.getFullName());
				System.out.println("Is user enabled? " + user.isEnabled());
			}
		} catch (Exception e) {
		}
	}
}

 
 
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.