However, if users still want the refresh the document automatically for other modes such as interactive mode, the below SDK modifications will still be needed.
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.
The customization scenario below in the MSDL shows how to automatically refresh a document by specifying the ID for a document and the time interval for refreshing.
https://www2.microstrategy.com/producthelp/Current/WebSDK/Content/topics/scenarios/WEBSDK121.htm
This scenario sets the same refresh time for every document specified. However, there may be a requirement to have different documents have different refresh intervals.
The code example below shows how to automatically refresh documents with specific refresh time intervals through a transform.
Extend the RWLayoutTransform on the RWDocumentViewStyle to contain the code sample below.
public class RWLayoutTransformRefresh extends RWLayoutTransform implements LayoutTransform{
public String getDescription() {
return "set different refresh time for different documents";
}
@Override
public void transformForRequestSuccessful(MarkupOutput out) {
// TODO Auto-generated method stub
StringBuilder sb = new StringBuilder();
sb.append("if(typeof(Strategy.getViewerBone()) != 'undefined')setTimeout('Strategy.getViewerBone().commands.exec(\\'refresh\\');',3000);");
ClientSideHelper.addInlineScript(out, getAppContext(), sb);
super.transformForRequestSuccessful(out);
}
}
Change the timeout interval accordingly. This will set the timeout to all documents. To set the timeout for specific documents, add custom logic or follow the example in the MSDL article to use ResourceBundles.
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://community.strategy.com/topic/0TO44000000FliLGAS/sdk).
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
https://www.microstrategy.com/en/support/contact-support.
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.
