KB39675: How to Modify the Body Header Layout Property "Height Can Grow" from Unchecked to Checked Using the MicroStrategy Web SDK 9.2.1

The following sample will modify the "Height Can Grow" property for the Body Header from unchecked to checked, as seen below:
 

 
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.
 
 
 
package com.Strategy.sdk.samples;
import com.Strategy.web.beans.BeanFactory;
import com.Strategy.web.beans.FolderBean;
import com.Strategy.web.beans.RWBean;
import com.Strategy.web.beans.WebBeanException;
import com.Strategy.web.objects.WebFolder;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebObjectsException;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.web.objects.rw.EnumRWUnitTypes;
import com.Strategy.web.objects.rw.RWDefinition;
import com.Strategy.web.objects.rw.RWInstance;
import com.Strategy.web.objects.rw.RWUnitDef;
import com.Strategy.webapi.EnumDSSXMLApplicationType;
public class EditDocumentHeightCanGrow {
public static void main(String[] args) throws WebBeanException{
String SessionID = "";
// Create factory object.
WebObjectsFactory factory=WebObjectsFactory.getInstance();
WebIServerSession serverSession=factory.getIServerSession();
// Set up session properties by reading from the portlet properties/credentials vault.
serverSession.setServerName("SERVER_NAME");
serverSession.setServerPort(0);
serverSession.setProjectName("PROJECT_NAME");
serverSession.setLogin("UID");
serverSession.setPassword("PWD");
serverSession.setApplicationType(EnumDSSXMLApplicationType.DssXmlApplicationCustomApp);
// Output to ensure session was created
try {
SessionID = serverSession.getSessionID();
System.out.println("Welcome " + serverSession.getLogin());
System.out.println("SessionID: " + SessionID + "\n");
} catch (WebObjectsException ex) {}
// Get Document Bean (RWBean)
RWBean rwb = (RWBean)BeanFactory.getInstance().newBean("RWBean");
rwb.setSessionInfo(serverSession);
rwb.setObjectID("7697A6354DEC58CB40334593CDAC034D");
 
// Create an instance of the Document Bean
RWInstance rwInst;
try {
rwInst = rwb.getRWInstance();
rwInst.setAsync(false);
 
// Get the Document Definition
RWDefinition rwdef = rwInst.getDefinition();
 
// Getting parent folder to use when saving later
FolderBean fb = rwb.getParentFolderBean("fb");
WebFolder parentFolder = fb.getFolderObject();
System.out.println("Parent Folder: "+ parentFolder.getName() + "\n");
 
// Modifying Type Subsection. Type can be found in the Properties of the object in Web.
RWUnitDef[] subSect = rwdef.findUnitsByType(EnumRWUnitTypes.RWUNIT_SUBSECTION);
RWUnitDef subSectUnit;
 
for (int y=0; y<subSect.length; y++){
subSectUnit = subSect;
 
// Output the Subsection name
System.out.println("Subsection Name: " + subSectUnit.getName());
 
// If the section is the Body Header then make modifications
if(subSectUnit.getName().equalsIgnoreCase("Body Header")){
// Output the value of the Properties > Layout > Size > Height Can Grow Value
// If the value is 0, then the check box is UNCHECKED
// If the value is -1, then the check box is CHECKED
System.out.println(" Can Grow = " + subSectUnit.getFormat().getValue("FormattingSize", "CanGrow"));
 
// If the check box is UNCHECKED, then change the value to -1 (CHECKED)
if(subSectUnit.getFormat().getIntValue("FormattingSize", "CanGrow")==0){
subSectUnit.getFormat().setValue("FormattingSize", "CanGrow", -1);
}
}
}
 
// Apply the changes
RWInstance newInst = rwInst.getRWManipulator().applyChanges();
 
// Get status of the Document
int status = newInst.getStatus();
 
// Poll the status of the Document until it is ready
while (status!=1){
status = newInst.pollStatus();
}
 
// Outputting the current status, should be set to 1, READY
System.out.println("Current status: "+ status);
 
// Saving the document as a NEW document
// This is recommended in the case the save is interrupted, then the original file is retained.
String docNameVersion2 = rwb.getDisplayName() + "2";
newInst.saveAs(parentFolder,docNameVersion2);
 
}catch (WebObjectsException e) {
 
e.printStackTrace();
}
}
}
 
 
 
 
There are couple of things to keep in mind with the code provided:
 
1. The Height Can Grow property is ONLY changed for the Body Header where that property is UNCHECKED.
 
2. The document in the code above has NO prompts.  If the document is prompted, then the prompts will need to be resolved.  KB31222 "How to Execute a Document, Answer Prompts and Create a New File Subscription Using the MicroStrategy Java Web SDK 9.0" can be used as a guide to help in resolving prompts for documents.
 
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.