KB34522: How to find all attributes and Metrics in a project using the MicroStrategy Web API 9.4.1

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.
 
 
 
 
The following standalone java class will connect to a Project in Strategy 9.4.1 and create a search object that will return all attributes and metrics.
 

import com.Strategy.web.objects.WebFolder;

import com.Strategy.web.objects.WebIServerSession;

import com.Strategy.web.objects.WebObjectInfo;

import com.Strategy.web.objects.WebObjectSource;

import com.Strategy.web.objects.WebObjectsException;

import com.Strategy.web.objects.WebObjectsFactory;

import com.Strategy.web.objects.WebSearch;

import com.Strategy.webapi.EnumDSSXMLAuthModes;

import com.Strategy.webapi.EnumDSSXMLObjectTypes;

import com.Strategy.webapi.EnumDSSXMLSearchDomain;

import com.Strategy.webapi.EnumDSSXMLSearchFlags;

 

public class SearchComponents {

 

 public static void main(String[] args) throws WebObjectsException  {

  //Create IS session

  WebObjectsFactory objectFactory = WebObjectsFactory.getInstance();

 

  //Session parameters

  WebIServerSession serverSession = objectFactory.getIServerSession();

  serverSession.setServerPort(0);

  serverSession.setAuthMode(EnumDSSXMLAuthModes.DssXmlAuthStandard);

  serverSession.setProjectName("XXXXXXXX"); 

  serverSession.setLogin("administrator");

  serverSession.setPassword("");

  serverSession.setServerName("XXXXXXXXXX");

  

  WebObjectsFactory woFact = serverSession.getFactory();

  WebObjectSource wos = woFact.getObjectSource();

  

  WebSearch search = wos.getNewSearchObject();

  

  System.out.println("Session created");

  

  //Set search parameters

  //Using wildcard * to return all

  search.setDisplayName("*");

  search.setSearchFlags(search.getSearchFlags() 

 +   EnumDSSXMLSearchFlags.DssXmlSearchNameWildCard);

  

  search.setAsync(false);

  //Set type of objects we want returned, here att and metrics only

  search.types().add(new Integer(EnumDSSXMLObjectTypes.DssXmlTypeAttribute));

  search.types().add(new Integer(EnumDSSXMLObjectTypes.DssXmlTypeMetric));

  search.setDomain(EnumDSSXMLSearchDomain.DssXmlSearchDomainProject);

  search.submit();

   

  WebFolder f = search.getResults();

  

  System.out.println("After search: " + f.size());

  

  WebObjectInfo objectInfo = null; 

  

  if(f.size()>0){

 for(int i=0;i<f.size();i++){

 objectInfo = f.get(i);

 System.out.println(objectInfo.getDisplayName());

 }

  }

 

 }//End main

 

}//end class

 
 
 
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.