In service-oriented architecture, discrete chunks of functionality are built as services that can be accessed by many applications in many different ways. In Strategy Web, these services are called tasks. Once an operation has been defined as a task in Strategy Web, it can be called as a service from anywhere using any protocol. What this means is that you need to build a task only once, and it can then be used everywhere. Regardless of whether a task is called from HTTP, URL, Web Services, COM, .NET, or Java, the underlying implementation is the same.
In this case, the OOTB (out-of-the-box) exportReport task in the Strategy Task Admin provides the ability to export a report using a list of specified parameters (i.e. reportID, msgID, etc.). However, it does not provide the ability to overwrite the formatting options, such as margin size, in the report definition. This can be accomplished by creating a custom bean-based task and follow the steps below:
Note: Not all properties can be overwritten using the OptionsHelper class. Properties that are read from the report definition can be overwrriten using the method shown in the sample code below. Properties that are read from the Strategy Web User Preferences will require a different approach to update. Rather than use the OptionsHelper class, the developer would have to programmatically update the user preferences. This method is demonstrated here in KB35710, KB19384, KB17765.
Sample Code
Sample Code/Error
/**
* Strategy SDK Sample
*
* Copyright © 2011 Strategy Incorporated. All Rights Reserved.
*
* Strategy MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE
* SUITABILITY OF THIS SAMPLE CODE, EITHER EXPRESS OR IMPLIED, INCLUDING
* BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. Strategy SHALL NOT
* BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING,
* MODIFYING OR DISTRIBUTING THIS SAMPLE CODE OR ITS DERIVATIVES.
*
*
*/
package com.Strategy.web.app.custom.tasks;
import com.Strategy.utils.HashList;
import com.Strategy.utils.StringUtils;
import com.Strategy.web.app.tasks.ExportReportTask;
import com.Strategy.web.app.utils.OptionsHelper;
import com.Strategy.web.beans.EnumReportBeanEvents;
import com.Strategy.web.beans.ReportBean;
import com.Strategy.web.beans.RequestKeys;
import com.Strategy.web.tasks.TaskException;
import com.Strategy.web.tasks.TaskParameterMetadata;
public class CustomExportReportTask extends ExportReportTask {
// constants
private static final String PARAM_LEFT_MARGIN = "leftMargin";
private static final String commonArgument = String.valueOf(OptionsHelper.ReportObjectType) + EnumReportBeanEvents.REPORT_PROPERTY_LIST_SEPARATOR
+ OptionsHelper.PDFPropertySetName + EnumReportBeanEvents.REPORT_PROPERTY_LIST_SEPARATOR;
// instance variables
private TaskParameterMetadata marginLeftParam;
private HashList<String, String> newPropertyValues;
public CustomExportReportTask() {
super();
newPropertyValues = new HashList<String, String>();
marginLeftParam = addParameterMetadata(PARAM_LEFT_MARGIN, "Left Margin", false, "0");
}
@Override
protected void collectData(com.Strategy.web.app.tasks.BeanTaskRequestContext context) throws TaskException {
System.out.println("Method call: collectData");
// obtain request keys
RequestKeys requestKeys = context.getRequestKeys();
checkForRequiredParameters(requestKeys);
// obtain task parameters from request keys
String marginLeft = marginLeftParam.getValue(requestKeys);
String exportSection = exportSectionParam.getValue(requestKeys);
// get the Report bean
ReportBean rb = (ReportBean)context.getWebBean().getChildByClass(ReportBean.class);
try {
if (rb == null) return;
else {
replacePropertyValue(OptionsHelper.MarginLeft, marginLeft);
OptionsHelper.submitSetPropertyEvent(rb, newPropertyValues);
}
} catch (Exception ex) {
System.out.println("Something broke!");
ex.printStackTrace();
} finally {
super.collectData(context);
}
}
private void replacePropertyValue(String propertyName, String propertyValue) {
System.out.println("Method Call: replacePropertyValue");
String property = (String) newPropertyValues.get(propertyName);
String replacement;
if (!StringUtils.isEmpty(property)) {
replacement = commonArgument + propertyName + EnumReportBeanEvents.REPORT_PROPERTY_LIST_SEPARATOR + propertyValue;
newPropertyValues.replace(propertyName, replacement);
}
else {
replacement = commonArgument + propertyName + EnumReportBeanEvents.REPORT_PROPERTY_LIST_SEPARATOR + propertyValue;
newPropertyValues.add(propertyName, replacement);
}
System.out.println(replacement);
}
}
The example provided in this document is provided “as-is” to the user and assumes that the user:
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:
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.
