Page History

 <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Getting user information...</messages>
            <messages>Getting user information...</messages>
            <messages>Web Service Request Complete</messages>
            <parentDashboards>
               <dashboardGroupId>61250</dashboardGroupId>
               <dashboardName>Sales Performance</dashboardName>
               <statusCodes>OPEN</statusCodes>
               <tabIds>61251</tabIds>
               <tabNames>New Tab</tabNames>
            </parentDashboards>
            <parentDashboards>
               <dashboardGroupId>61209</dashboardGroupId>
               <dashboardName>Campaign Analysis</dashboardName>
               <statusCodes>OPEN</statusCodes>
               <statusCodes>OPEN</statusCodes>
               <tabIds>61210</tabIds>
               <tabIds>61243</tabIds>
               <tabNames>Campaigns</tabNames>
               <tabNames>Marketing</tabNames>
            </parentDashboards>
            <person>
               <emailAddress>admin@yellowfin.com.au</emailAddress>
               <firstName>System</firstName>
               <initial/>
               <ipId>5</ipId>
               <languageCode>EN</languageCode>
               <lastName>Administrator</lastName>
               <roleCode>YFADMIN</roleCode>
               <salutationCode/>
               <status>ACTIVE</status>
               <timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
               <userId>admin@yellowfin.com.au</userId>

• Start with a basic request for this function, which includes logging in as the admin user and specifying the web service call to perform:
  
  

  Code Block
  language java
  AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("TABSFROMPARENTGROUPID");

• You may even identify a specific client organization:

  Code Block
  language java
  rsr.setOrgRef("org1");

  
  
  

• Specify the user for whom to retrieve the dashboard:

  Code Block
  language java
  AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("admin@yellowfin.com.au"); rsr.setPerson(ap);

• Provide a dashboard ID to view only that dashboard's details:

  Code Block
  language java
  rsr.setDashboardTabId(61209); // dashboard Id (ReportGroup.GroupId field of Yellowfin's database)

  
  
  

• Once the request is configured, perform the call:

  Code Block
  language java
  AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

  Initialize the Administration web service. Click here to learn how to do this. 

• The response returned will contain these parameters: StatusCode and ParentDashboard array. See the response parameter chart above for details on these.
  
  

<%   // provide your Yellowfin web services admin account
rsr.setPassword("test");                           // set to the password of the above account
rsr.setOrgId(1);

rsr.setFunction("GETUSERTABSWITHREPORTS");
rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");  			
rsr.setPerson(ap);

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode()) ) {
	out.write("Success<br>" + rs.getReportGroups().length + " tabs retrieved");
	
	// get the tabs details:
	AdministrationReportGroup[] tabs = rs.getReportGroups();
	for (AdministrationReportGroup tab: tabs){
		out.write("<br><br><h1>Dashboard Name: " + tab.getReportGroupName() + "</h1>");
		AdministrationReport[] rpts = tab.getGroupReports();
		if (rpts != null)
			for (AdministrationReport r: rpts){ 
				out.write("Report Name: " + r.getReportName());
				out.write("<br>Description: " + r.getReportDescription());
				out.write("<br>ReportId: " + r.getReportId());
				out.write("<br>ReportUUID: " + r.getReportUUID());
				out.write("<br>ExecutionObject: " + r.getExecutionObject());
				out.write("<br>ReportCategory: " + r.getReportCategory());
				out.write("<br>SubCategory: " + r.getReportSubCategory());
				out.write("<br>BirtData: " + r.getBirtData());
				out.write("<br>SourceName: " + r.getSourceName());
				out.write("<br>SourceId: " + r.getSourceId());
				out.write("<br>AuthoringMode: " + r.getAuthoringMode());
				out.write("<br>ReportTemplate: " + r.getReportTemplate());
				out.write("<br>DataOutput: " + r.getDataOutput());
				out.write("<br>DashboardEnabled: " + r.isDashboardEnabled());
				out.write("<br>ViewId: " + r.getViewId());
				out.write("<br>ViewName: " + r.getViewName());
				out.write("<br>ViewDescription: " + r.getViewDescription());
				out.write("<br>LastModifierName: " + r.getLastModifierName());
				out.write("<br>LastModifierId: " + r.getLastModifierId());
				out.write("<br>LastModifiedDate: " + r.getLastModifiedDate());
				out.write("<br>PublishDate: " + r.getPublishDate());
				out.write("<br>DeliveryMode: " + r.getDeliveryMode());
				out.write("<br>LastRunTime: " + r.getLastRunTime());
				out.write("<br>AverageRunTime: " + r.getAverageRunTime());
				out.write("<br>RoleCode: " + r.getRoleCode());
				out.write("<br>ChartTypeCode: " + r.getChartTypeCode());
				out.write("<br>Usage: " + r.getUsage());
				out.write("<br><br>");
			}
/*              ws_tabsfromparentgroupid.jsp              */
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %> 
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);        // adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();

rsr.setLoginId("admin@yellowfin.com.au");          // provide your Yellowfin web services admin account
rsr.setPassword("test");                           // set to the password of the above account
rsr.setOrgId(1);

rsr.setFunction("TABSFROMPARENTGROUPID");

//rsr.setDashboardTabId(61209);  					// add this to get subtabs for a particular dashboard tab.

 
rsr.setOrgRef("org1");
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");  			
rsr.setPerson(ap);

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode()) ) {
	
	//out.write("Success<br>" + rs.getReportGroups().length + " tabs retrieved");
	// get the tabs details:
	ParentDashboard[] tabs = rs.getParentDashboards();
	if (tabs != null) 
	for (ParentDashboard tab: tabs){
		out.write("<br><br>Dashboard Name: " + tab.getDashboardName());
		out.write("<br>DashboardId: " + tab.getDashboardGroupId());
		out.write("<br>tabIds (N): " + tab.getTabIds().length);
	}
} else {
		out.write("Failure");
		out.write(" Code: " + rs.getErrorCode());
}
%>