KB32600: How to create Report or Report Services Document Email Subscription using the MicroStrategy Web SDK 9.4.x

It is possible to create an email subscription using Strategy Web SDK. This document gives an example of how to accomplish this for a non prompted report or document.

package com.Strategy.sdk.standalone;

import java.util.Date;

import com.Strategy.web.beans.WebBeanException;
import com.Strategy.web.objects.EnumWebSubscriptionObjectTypes;
import com.Strategy.web.objects.SimpleList;
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.WebSubscription;
import com.Strategy.web.objects.WebSubscriptionAddress;
import com.Strategy.web.objects.WebSubscriptionTrigger;
import com.Strategy.web.objects.WebSubscriptionsSource;
import com.Strategy.webapi.EnumDSSXMLApplicationType;
import com.Strategy.webapi.EnumDSSXMLObjectTypes;
import com.Strategy.webapi.EnumDSSXMLSubscriptionDeliveryType;

public class CreateEmailSubscription {
	static WebObjectsFactory factory = WebObjectsFactory.getInstance();
	static WebIServerSession serverSession = factory.getIServerSession();

	public static void main(String[] args) throws WebBeanException, WebObjectsException {
		String SessionID = "";

		serverSession.setServerName("INTELLIGENCE_SERVER");
                serverSession.setServerPort(0);
                serverSession.setProjectName("PROJECT_NAME");
                serverSession.setLogin("USERNAME");
                serverSession.setPassword("PASSWORD");
             serverSession.setApplicationType(EnumDSSXMLApplicationType.DssXmlApplicationCustomApp);serverSession.setApplicationType(EnumDSSXMLApplicationType.DssXmlApplicationCustomApp);

		try {
			SessionID = serverSession.getSessionID();      
		}
		catch (WebObjectsException ex) { }
		
                WebSubscriptionsSource subSource =serverSession.getFactory().getSubscriptionsSource(); 

		WebSubscription _subscription = (WebSubscription) subSource.getNewObject(EnumWebSubscriptionObjectTypes.WEB_SUBSCRIPTION);
		
		Date dt = new Date();
		_subscription.setName("programmatic email sub: " + dt); 
		_subscription.setDeliveryMode(EnumDSSXMLSubscriptionDeliveryType.DssXmlDeliveryTypeEmail);

		//Reference to document (no prompts) 
		WebObjectSource mysource = factory.getObjectSource(); 
		String docID = "DOCID";
		WebObjectInfo mydoc = mysource.getObject(docID, EnumDSSXMLObjectTypes.DssXmlTypeDocumentDefinition, true);
		_subscription.setContent(mydoc); 
		
		//System.out.println("Document: " +mydoc.getDisplayName());

		//Reference to existing SCHEDULE 
		WebSubscriptionTrigger mytrigger = (WebSubscriptionTrigger) mysource.getObject("SCHEDULEID", EnumDSSXMLObjectTypes.DssXmlTypeScheduleTrigger, true);
		_subscription.setTrigger(mytrigger); 

		//reference existing recipient address
		SimpleList myadd = subSource.getAddressesByDeliveryMode(EnumDSSXMLSubscriptionDeliveryType.DssXmlDeliveryTypeEmail);
		WebSubscriptionAddress myonlyadd = (WebSubscriptionAddress) myadd.item(0); 
		System.out.println("My address name: " +myonlyadd.getName());
		
		_subscription.setAddress(myonlyadd); 

		//to test you can send it now 
		//_subscription.setSendNow(true); 

		//  Save it 
		_subscription.save();
		
        System.out.println("Successfully created subscription "+ _subscription.getName());
	}
}

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 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.Strategy.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@Strategy.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.Strategy.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.