KB35228: How to Create a Custom Task that Returns a List of Projects a User has Access to Using the MicroStrategy Java Web SDK

SUMMARY:
At times it may be necessary to determine which projects a specific user has access to and return a list of only those projects. It is possible to achieve this by creating a custom java task. Once the custom task is created, it will appear in the list of tasks on the Task Processor Administrator builder page as shown below:
 

 
To perform this customization, perform the following steps using the Web Customization Editor:

1. Go to the 'Application Settings' tab, scroll down to the 'Tasks', Right-click, and select the 'New Task' option.
2. In the wizard,  select the option to 'Create a task by writing a Java class only'. Click Next.
3. In the next screen, specify the Source folder and package. For the Superclass, click Browse and search for 'AbstractBaseTask'. For the 'Name' and 'TaskID' field specify getAccessibleProjects and give the custom task a simple description. Click Next.
4. Select the following method to override:

processRequest(TaskRequestContext context, MarkupOutput out)

1. Click Finish. This will display the java file with a simple shell that can be built upon.
2. Modify the content using the following java code:

import com.Strategy.web.beans.MarkupOutput;
import com.Strategy.web.beans.RequestKeys;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.web.objects.WebProjectInstance;
import com.Strategy.web.objects.WebProjectInstances;
import com.Strategy.web.objects.WebProjectSource;
import com.Strategy.web.tasks.AbstractBaseTask;
import com.Strategy.web.tasks.TaskRequestContext; 
import com.Strategy.web.tasks.TaskParameterMetadata;  
import com.Strategy.webapi.EnumDSSXMLProjectStatus;

public class getAccessibleProjects extends AbstractBaseTask  {

 private TaskParameterMetadata iServer;
 private TaskParameterMetadata port;
 private TaskParameterMetadata username;
 private TaskParameterMetadata passwd;
    public getAccessibleProjects() {
        super("get projects user has access to");
        iServer = addParameterMetadata("ServerName","Enter the Intelligence Server.",true, "SERVERNAME");
        port = addParameterMetadata("Port","Enter the Intelligence Server Port.",true, "0");
        username = addParameterMetadata("UserName","Enter the user ID.",true, "webuser");
        passwd = addParameterMetadata("Password","Enter the user password.",true, "");
    }

    public void processRequest(TaskRequestContext context, MarkupOutput out) {

     //get Values from the request keys:
     RequestKeys keys = context.getRequestKeys();
     String uid = keys.getValue(username.getName());
     String pwd = keys.getValue(passwd.getName());
     String svr = keys.getValue(iServer.getName());
     String p = keys.getValue(port.getName());

     //add further checking when populating these values.
     out.append("Accessible Projects: "); 

     try{
      WebObjectsFactory factory=WebObjectsFactory.getInstance();
      WebProjectSource oProjectSource = factory.getProjectSource();
      WebIServerSession serverSession=factory.getIServerSession();
      serverSession.setServerName(svr);
      serverSession.setServerPort(Integer.parseInt(p));
      serverSession.setLogin(uid);
      serverSession.setPassword(pwd);
      WebProjectInstances oPInstanceList = oProjectSource.getAccessibleProjectsInCluster();

      WebProjectInstance oPInstance = null;
      int _pindex = 0;
      for(int i=0;i<oPInstanceList.size();i++){
      oPInstance = oPInstanceList.get(i);
      if (oPInstance.getStatus() == EnumDSSXMLProjectStatus.DssXmlProjectStatusActive){
      _pindex = i+1;      
      out.append(oPInstance.getProjectName()+",");    
      //return other information about the project such as Project ID, description, etc
      //oPInstance.getProjectDescription();
      //oPInstance.getID();
      }
      }
      }catch(Exception e){
      System.out.println("Error: "+ e.getMessage());
      }      
    }
}

1. After modifying the code, save the changes. Restart the Application Server and test the new custom task using the Task Processor Administrator page.

 
 
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.