KB235377: How to Maintain Server Information and Configuration Files Outside of the Microstrategy Web Application Using Microstrategy Web SDK

Starting with the release of Strategy ONE (March 2024), dossiers are also known as dashboards.
In some cases, developers may want to maintain all server information and properties files in locations outside of the Strategy Web application. The server files include sys_defaults.xml, sys_definitions.xml, AdminServers.xml and .properties files. These are the files that contain the Intelligence Server information for your Web Server to connect to. It is possible to have these files in locations outside of the Strategy web app.
Note: It is not recommended to have multiple Strategy Web app instances reading from the same xml config files.
 
The following customization allows developers to maintain all of the server config files for each Strategy instances in a shared location outside of each of the web apps.

1. Create a new plugin in the WCE.
2. Go to Application Settings > Strategy Configuration Settings > Global Settings.
3. In the System Server Defaults, System Preferences and Admin Servers, enter your absolute location path where you want the configuration files to be saved.

     For example:
     ABSOLUTE:/C:/mstrtemp/sys_defaults.xml
     ABSOLUTE:/C:/mstrtemp/AdminServers.xml
     ABSOLUTE:/C:/mstrtemp/sys_definitions.xml
     Note: These files don't need to exist in the location yet as they will be created when you restart Tomcat.
 

1. Save your changes and restart the Web Server. This will create a new plugin with a delta Strategy.xml file that will point to the locations you specified.

Initially, no I-Server will be connected. However, once you connect them and change the server properties, you will see the AdminServers.xml in your location updated and a new sys_defaults_<ServerName>.properties created.
For the Default Server Properties, these will appear in the sys_defaults.properties. If you make any changes, a new .properties file will be created in the new location.  Same goes for the Security properties.
For the Server Diagnostics Configuration properties, you will need to go back to Strategy Configuration Settings and change the location to the Server Log Properties. Once you save your changes and restart your Web Server, it will read and update from the logger.properties file in your new location as well.
 
 
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://developer.microstrategy.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@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.
 
NOTE ABOUT Strategy WEB AND LIBRARY:
Strategy Library is our modern app that allows business users to view dossiers and documents all in one location. It's where we focus a lot of our strategic energy and current development resources and due to these reasons, it would be recommended the usage of our new Application.
For more information about the Library's SDK, please refer to the following link attached below:
https://www2.Strategy.com/producthelp/Current/LibrarySDK/Content/topics/Intro_to_the_LibrarySDK.htm