KB37278: How to Retrieve the Format Type for a Subscription Using MicroStrategy Web SDK

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.

To iterate through a user's subscriptions and output details of each subscription using the Web API 9.x including the format type, please modify and compile the class below accordingly:
 
 

package com.Strategy.sdk.sample.Subscriptions;  
import com.Strategy.web.objects.SimpleList;
import com.Strategy.web.objects.WebIServerSession;   
import com.Strategy.web.objects.WebObjectsException;
import com.Strategy.web.objects.WebObjectsFactory;  
import com.Strategy.web.objects.WebSubscription;
import com.Strategy.web.objects.WebSubscriptionContentFormat;
import com.Strategy.web.objects.WebSubscriptionContentProperties;
import com.Strategy.web.objects.WebSubscriptionsSource;
import com.Strategy.webapi.EnumDSSXMLApplicationType;  
import com.Strategy.webapi.EnumDSSXMLSubscriptionDeliveryType
import com.Strategy.web.objects.WebObjectSource;

public class SubscriptionType {  

  // Create factory object.  
  static WebObjectsFactory factory=WebObjectsFactory.getInstance();  
  static WebIServerSession serverSession=factory.getIServerSession(); 
  static WebObjectSource objectSource=factory.getObjectSource(); 

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

   serverSession.setServerName("ServerName");  
   serverSession.setServerPort(0);  
   serverSession.setProjectName("Strategy Tutorial");  
   serverSession.setLogin("administrator");  
   serverSession.setPassword("");  
serverSession.setApplicationType(EnumDSSXMLApplicationType.DssXmlApplicationCustomApp);     

   WebSubscriptionsSource subSource = factory.getSubscriptionsSource();
   WebSubscription sub = null;

   // Retrieve all File Subscriptions
   SimpleList list = subSource.getSubscriptionsByDeliveryMode(EnumDSSXMLSubscriptionDeliveryType.DssXmlDeliveryTypeFile);

   System.out.println("Total number of File subscriptions are:" + Integer.toString(list.size()) + "\n");

   // Output details for each subscription

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

    sub = (com.Strategy.web.objects.WebSubscription) list.item(i);

    System.out.println("Subscription name: " + sub.getName());
    System.out.println("Subscription ID is: " + sub.getID());
       System.out.println("Trigger is: " + (com.Strategy.web.objects.WebSubscriptionTrigger) sub.getSubscriptionTrigger());

             // Output Format Type of the subscription

       WebSubscriptionContentProperties contentProperties = sub.getContentProperties();

       WebSubscriptionContentFormat contentFormat = contentProperties.getFormat();

       int formatType = contentFormat.getType();

       System.out.println("Format Type = " + formatType + "\n");

   }
 }
}

 
 
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.