KB47618: How to Get the Content of a Subscription Using MicroStrategy Web SDK 9.4.1

The following code shows how to get the report or document that is being delivered by a subscription.
 

package customclasses.standalone;


import com.Strategy.web.objects.SimpleList;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebSubscriptionContentDocument;
import com.Strategy.web.objects.WebSubscriptionContentReport;
import com.Strategy.web.objects.WebObjectsException;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.web.objects.WebSubscription;
import com.Strategy.web.objects.WebSubscriptionsSource;
import com.Strategy.webapi.EnumDSSXMLApplicationType;
import com.Strategy.webapi.EnumDSSXMLSubscriptionDeliveryType;

public class subscriptionContent {
 private static WebObjectsFactory factory = null;
    private static WebIServerSession serverSession = null;

 

 public static void main(String[] args) throws WebObjectsException {
	 
	 	factory = WebObjectsFactory.getInstance();
	 	
        serverSession = factory.getIServerSession();
        
        serverSession.setServerName("SERVERNAME"); //IServer name
        
        serverSession.setServerPort(0);
        
        serverSession.setProjectName("Strategy Tutorial"); //Project to create the session

        serverSession.setLogin("Administrator"); //UserID

        serverSession.setPassword(""); //Password

        serverSession.setApplicationType(EnumDSSXMLApplicationType.DssXmlApplicationCustomApp);
                

        WebSubscriptionsSource subSource = factory.getSubscriptionsSource();

        WebSubscription sub = null;

       
        //return all subscriptions
        SimpleList list = subSource.getSubscriptions();
        
    
        //alternatively, use the following method to return subscriptions by delivery mode, for example:
        SimpleList list2 = subSource.getSubscriptionsByDeliveryMode(EnumDSSXMLSubscriptionDeliveryType.DssXmlDeliveryTypeFile);
        
        

        for (int i=0; i<list.size(); i++){    
        	sub = (WebSubscription)list.item(i);          
        	System.out.println(sub.getName());                    
        	String content = sub.getContent().getName();          
        	System.out.println(content);                    
        	String id = sub.getContent().getID();
        	System.out.println(id); 
         
			//for documents:           
			WebSubscriptionContentDocument wscd=(WebSubscriptionContentDocument)sub.getContent();          
			//for reports:            
			WebSubscriptionContentReport wscr = (WebSubscriptionContentReport)sub.getContent();        
			
        }     
     }  
 }

 
 
  See the Strategy Java API documentation for more information on the following classes: 
 
 
WebSubscriptionContentReport 
WebSubscriptionContentDocument
 
 
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.
 
 
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 MicroStrategy Developer Hub.
 
To access the Strategy Developer Hub, 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 Hub, please contact Strategy Technical Support atsupport@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.