Users can rename a metric present on a grid template by right clicking on the metric and selecting the Rename/Edit option as shown below,
The sample code below shows how to achieve the above fucntionality through SDK.
Before Customization :
After Customization :
Code :
package com.Strategy.sdk.samples.misc;
import com.Strategy.web.objects.WebFolder;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.web.objects.WebReportData;
import com.Strategy.web.objects.WebReportInstance;
import com.Strategy.web.objects.WebReportManipulation;
import com.Strategy.web.objects.WebReportSource;
import com.Strategy.web.objects.WebTemplate;
import com.Strategy.web.objects.WebTemplateMetric;
import com.Strategy.web.objects.WebTemplateMetrics;
import com.Strategy.webapi.EnumDSSXMLReportSaveAsFlags;
public class RenameGridObjects {
public static void main(String[] args) {
try {
// Connect to Strategy IntelligenceServer
WebObjectsFactory factory = WebObjectsFactory.getInstance();
WebIServerSession session = factory.getIServerSession();
session.setServerName("was-halaoui");
session.setLogin("Administrator");
session.setPassword("");
session.setProjectName("Strategy Tutorial");
//Get the report source and create a new instance with the reportID
WebReportSource reportSource = factory.getReportSource();
WebReportInstance reportInstance = reportSource.getNewInstance("A843AA004C9E827C6E96A68944714295");
WebTemplate template = reportInstance.getTemplate();
//Get the metrics on the template
WebTemplateMetrics metrics = template.getTemplateMetrics();
WebTemplateMetric metric = null;
//Loop through the metrics on the template to get the individual metric values
for(int i=0; i< metrics.size(); i++){
metric = metrics.get(i);
System.out.println("Name :" + metric.getName() + " Key :" + metric.getKey());
//Rename each metric present on the template. If only one metric needs to be modified capture the metric and //set the alias outside of the for loop.
metric.setAlias("CustomRevenue");
}
//Get the report manipulator and apply the changes made
WebReportManipulation rptManip = reportInstance.getReportManipulator();
WebReportInstance newInst = null;
rptManip.setResultFlags(1268388256);
newInst = rptManip.applyChanges();
newInst.setAsync(false);
newInst.pollStatus();
//Get the new data from the newReportInstance got after applying the changes
WebReportData reportData = newInst.getResults();
newInst.pollStatus();
//Get the Web Folder from the reportData
WebFolder wFolder = reportData.getFolder();
//Set the flags to overwrite the existing report - this flag is not required if the result is saved as a new report.
newInst.setSaveAsFlags(EnumDSSXMLReportSaveAsFlags.DssXmlReportSaveAsOverWrite);
//Save the report instance
newInst.saveAs(wFolder, "MyReport");
//Close the session
session.closeSession();
} catch (Exception e) {
System.out.println(e.getMessage());
e.printStackTrace(System.out);
}
}
}
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.
