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

KB221015: How to Programmatically Retrieve the Edit Links Value of a Text Field in a Report Services document in MicroStrategy Java Web SDK 9.4.1


Community Admin

• Strategy


When designing a Report Services document in Strategy Web, text fields can contain normal static text or they can be converted into a hyperlink via Edit Links.

ka04W000000OfnsQAC_0EM440000002GRr.jpeg

 

ka04W000000OfnsQAC_0EM440000002GRk.jpeg

 
The Edit Links value is saved as the following properties in the definition of the Report Services document:
Category: FormattingNavigation
Name: Hyperlinks
 
It is possible to programmatically retrieve these navigation properties using the Strategy Java Web SDK 9.4.1. To accomplish this, use the code below:
 


package com.Strategy.sdk.standalone;

import com.Strategy.web.beans.FolderBean;
import com.Strategy.web.beans.RWBean;
import com.Strategy.web.beans.WebBeanException;
import com.Strategy.web.beans.WebBeanFactory;
import com.Strategy.web.objects.WebFolder;
import com.Strategy.web.objects.WebIServerSession;
import com.Strategy.web.objects.WebObjectSource;
import com.Strategy.web.objects.WebObjectsException;
import com.Strategy.web.objects.WebObjectsFactory;
import com.Strategy.web.objects.rw.EnumRWUnitTypes;
import com.Strategy.web.objects.rw.RWDefinition;
import com.Strategy.web.objects.rw.RWInstance;
import com.Strategy.web.objects.rw.RWTextDef;
import com.Strategy.web.objects.rw.RWUnitDef;
import com.Strategy.webapi.EnumDSSXMLApplicationType;
import com.Strategy.webapi.EnumDSSXMLObjectFlags;

public class test {

 public static void main(String arg[]) throws WebObjectsException, WebBeanException{

  
  /** Create I-Server Session **/

  WebObjectsFactory factory = WebObjectsFactory.getInstance();
  WebIServerSession serverSession = factory.getIServerSession();
  serverSession.setServerName("localhost");
  serverSession.setServerPort(0);
  serverSession.setProjectName("Strategy Tutorial");
  serverSession.setLogin("administrator");
  serverSession.setPassword("");
  serverSession.setApplicationType(EnumDSSXMLApplicationType.DssXmlApplicationCustomApp);

  
        WebObjectSource wos = factory.getObjectSource();
	wos.setFlags(wos.getFlags()|EnumDSSXMLObjectFlags.DssXmlObjectProperties);
	
	String docID = "DFFA47764D56D66F6F2106A2906CE2DA";
	WebBeanFactory bfactory = WebBeanFactory.getInstance();
	RWBean rwb = (RWBean) bfactory.newBean("RWBean");
	rwb.setSessionInfo(serverSession);
	rwb.setObjectID(docID);
	
	//rwb. collectData();
	RWInstance rwi = rwb.getRWInstance();
	
	// Getting parent folder to use when saving later
	FolderBean fb = rwb.getParentFolderBean("fb"); 
	WebFolder parentFolder = fb.getFolderObject();
	System.out.println("Parent Folder: "+ parentFolder.getName());
	String docName = rwb.getDisplayName();
	out("Document Name: " + docName);
		

	RWDefinition rwdef = rwi.getDefinition();
    	RWUnitDef[] rwUnits = rwdef.findUnitsByType(EnumRWUnitTypes.RWUNIT_TEXT);
    	RWUnitDef rwUnit;
    	System.out.println("Number of text fields: "+ rwUnits.length); 

    	String textFieldKey = null; 
    	
    	for (int i=0;i<rwUnits.length;i++){
    	        rwUnit = rwUnits[i];			
    		RWTextDef txtdef = (RWTextDef)rwUnit; 
    		textFieldKey = txtdef.getKey(); 
			
		String editlink = rwi.getDefinition().findUnit(textFieldKey).getFormat().getValue("FormattingNavigation", "Hyperlinks");

		out(editlink);
    	}
    	
  /** Close I-Server Session **/
  serverSession.closeSession();
 }
 
 public static void out(String s){
  System.out.println(s);
 }

}

 
The value you receive will be in xml form similar to below:
<hls onw="1"><hl idf="1" aopam="2" dtxt="Hyperlink1" url="http://www.google.com" lt="0" so="0"/></hls>
 
 
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.


Comment

0 comments

Details

Knowledge Article

Published:

June 22, 2017

Last Updated:

July 21, 2017