EducationSoftwareStrategy.com
StrategyCommunity

Knowledge Base

Product

Community

Knowledge Base

TopicsBrowse ArticlesDeveloper Zone

Product

Download SoftwareProduct DocumentationSecurity Hub

Education

Tutorial VideosSolution GalleryEducation courses

Community

GuidelinesGrandmastersEvents
x_social-icon_white.svglinkedin_social-icon_white.svg
Strategy logoCommunity

© Strategy Inc. All Rights Reserved.

LegalTerms of UsePrivacy Policy
  1. Home
  2. Topics

KB16936: How to programmatically set a selector in a dashboard using MicroStrategy SDK 9.4.x


Community Admin

• Strategy


This article explains how to programmatically set a selector in a dashboard using MicroStrategy SDK 9.4.x

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 following code demonstrates how to access and set the value of a selector on a Report Services dashboard in Strategy 9.4.x using a custom event handler.


try {
	RWBean rwb = (RWBean) event.getSource();
	RWInstance inst = rwb.getRWInstance();
	RWDefinition def = inst.getDefinition();
	String key = null;
	String control = "mySelector"; //enter the name of the selector to be accessed here

	//code to retrieve Key value of selector
	RWUnitDef[] units = def.findUnitsByType(EnumRWUnitTypes.RWUNIT_CONTROL);

	for (int i = 0; i < units.length; i++) {
		if (units[i].getName().equals(control)) {
			key = units[i].getKey();
		}
	}

	RWManipulation rwManip = inst.getRWManipulator();
	Vector test = new Vector();
	//The element ID is hardcoded here, but can be set to a dynamically obtained value.
	test.add("BB:8D679D3711D3E4981000E787EC6DE8A4:1:2:0:2:1:3:3:Movies");

	boolean applyChangesImmediately = false;

	// collect each selection change, but don't immediately apply the selection
	// this allows multiple changes to be queued before submitting the whole collection of changes
	rwManip.setCurrentControlElements(key, test, applyChangesImmediately);

	// when finished, apply the change on the dataset
	rwManip.applyChanges();

}

If the selector to be accessed is a grid as selector, the key must be obtained as seen below:

RWUnitDef[] units = def.findUnitsByType(EnumRWUnitTypes.RWUNIT_GRIDGRAPH);

for (int i = 0; i < units.length; i++) {

	RWGridGraphDef gridDef = (RWGridGraphDef) units;

	//This try block is necessary since there may be multiple grids on the document. 
	//The ID of the attribute that is the selector is hardcoded in this example.
	try {
		key = gridDef.getControl("8D679D3711D3E4981000E787EC6DE8A4", EnumDSSXMLObjectTypes.DssXmlTypeAttribute).getKey();

	} catch (Exception e) {
		continue;
	}

}

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.


Comment

0 comments

Details

Knowledge Article

Published:

June 9, 2017

Last Updated:

August 9, 2019