KB47728: How to Display Project Status on the Projects Page Using the MicroStrategy Web SDK 9.4.x

Before Customization:

 
 
After Customization:

1. Launch the WCE and click on Strategy Web Configuration inside the 'Application Settings' view to expand the hierarchical tree.
2. Right-mouse click 'Styles' and select 'Create Transform' to launch the Transform Creation Wizard.

• Click 'Browse...' next to the Source folder text field to select the 'src' folder and click OK.
• Enter the following information for the rest of the text fields.
  Package: com.Strategy.sdk.samples.transforms
  Name: ProjectsTransformCustomStatus
  Transform description: This transform displays project status on the Projects page.
  
• Click on 'Browse..'. for Superclass and search for 'ProjectsTransform'.

1. Click Next and Finish.
   
2. ProjectsTransformCustomStatus.java opens in the editor.
   
3. Add the following to the code: 
   

   
   public void renderProjectStatus(MarkupOutput markupoutput, ProjectInformation projectinformation)  {  
   	ProjectInformation p = projectinformation;    
   	if (p != null)   {   
   		int status = projectinformation.getProjectStatus();   
   		String strStatus = "";   
   		String label = "Project Status";  
   		 
   		switch (status){   
   			case EnumDSSXMLProjectStatus.DssXmlProjectStatusActive:
   				strStatus = "Loaded";
   				break;   
   			case EnumDSSXMLProjectStatus.DssXmlProjectStatusErrorState:
   				strStatus = "Error State";
   				break;   
   			case EnumDSSXMLProjectStatus.DssXmlProjectStatusExecIdle:
   				strStatus = "Execution Idle";
   				break;   
   			case EnumDSSXMLProjectStatus.DssXmlProjectStatusFullIdle:
   				strStatus = "Full Idle";
   				break;   
   			case EnumDSSXMLProjectStatus.DssXmlProjectStatusOffline:
   				strStatus = "Offline";
   				break;   
   			case EnumDSSXMLProjectStatus.DssXmlProjectStatusRequestIdle:
   				strStatus = "Request Idle";
   				break;   
   			case EnumDSSXMLProjectStatus.DssXmlProjectStatusWHExecIdle:
   				strStatus = "Warehouse Execution Idle";
   				break;   
   			default:
   				strStatus = "Loaded";
   				break;   
   		}      
   		Tag tag = getTagsFactory().newTag("label");   
   		tag.addTextChild(label);   
   		tag.render(markupoutput);   
   	
   		Tag tag1 = getTagsFactory().newTag("span");   
   		tag1.addTextChild(strStatus);   
   		tag1.render(markupoutput);  
   	} 
   }

   
    
   
4. Navigate to Styles > ProjectsStyle.
   
5. Double-click 'ProjectsStyle' to launch the 'Style Properties' editor in the right frame.
   
6. Click 'Change' to select a new transform.
   
7. Enter the name of the customer transform created in the text field and click OK.
   
8. Save your changes.
   
9. Go to the 'Style Layouts' tab and select 'Edit Layout'.
   
10. Add the following code after the other render links "Server Name": (Note that there are two places to to add it.)
    

    
    <div class="server">
    	<mstrlayout:render name="ProjectStatus">
    		<mstrlayout:argument list="project" type="com.Strategy.web.app.ProjectInformation"/>
    	</mstrlayout:render>
    </div>

    
     
    
11. Save your changes and restart the Web Server.
    

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