KB44548: How to Delete a User and User Profile using the MicroStrategy Web SDK 10.x

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.
 
When a user is deleted in Strategy Web, the user profile remains. The user profile must be deleted separately. The same is applied when deleting a user programmatically via Strategy Web SDK. The following SDK sample code demonstrates how to delete a user and its profile using Strategy Java Web SDK.
 

package com.Strategy.sdk.standalone;

import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebObjectSource;
import com.Strategy.web.objects.WebObjectsException;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.web.objects.admin.users.WebUser;
import com.Strategy.webapi.EnumDSSXMLObjectTypes;

public class test {

	public static void main(String[] args) throws IllegalArgumentException, WebObjectsException {
		deleteUser();
	}
	
	public static void deleteUser() throws IllegalArgumentException, WebObjectsException {
		// Set up session properties
		WebObjectsFactory factory = WebObjectsFactory.getInstance();
		WebIServerSession serverSession = factory.getIServerSession();
		serverSession.setServerName("was-slin7"); // Should be replaced with the name of an Intelligence Server
		serverSession.setServerPort(0);
		serverSession.setProjectName("Strategy Tutorial"); // Project where the session should be created
		serverSession.setLogin("administrator"); // User ID
		serverSession.setPassword(""); // Password
		
		WebObjectsFactory woFact = serverSession.getFactory();
		WebObjectSource wos = woFact.getObjectSource();
		WebUser wu = (WebUser) wos.getObject("D22786D14F5C356C6C2F2E9ACFF46B8E", EnumDSSXMLObjectTypes.DssXmlTypeUser);
		
		System.out.println(wu.getDisplayName());
		
		wu.deleteProfile(); //deletes user profile
		
		wos.save(wu); //profile folder deleted only when user is saved
		wos.deleteObject(wu); //deletes user only (but not profile)
	}
}

  
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.