Page History
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Returns the metadata of user's dashboard tabs with their sub tab's IDs. You may provide the ID of a particular tab or sub tab to retrieve its details. Specify the user by using the AdministrationPerson object.
Request ParametersThe following parameters should be passed with this request:
These are the main parameters that you must set in the AdministrationPerson object for this web service call:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Each element of the ParentDashboard will contain the following elements:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This call is used to load metadata of dashboard tab reports for a specific user. The user is to be specified through the AdministrationPerson object. You can provide a dashboard tab ID via the AdministrationReportGroup object to get report details of a specific tab.Returns the metadata of all published dashboards’ parent tabs, along with details of the dashboard reports. In case of multiple sub tabs within the dashboard, only the details of the parent tab are retrieved, however this call will return metadata of the entire dashboard's reports, including those in the sub tabs. Use the AdministrationPerson object to specify the user for this call.
Request ParametersThe following parameters should be passed with this request:
These are the main parameters that you must set in the AdministrationPerson the AdministrationPerson object for this web service call:
These are the main parameters that you must set in the AdministrationReportGroup object for this web service call:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response will contain these parameters:
Each element of the ReportGroups ParentReportGroup will contain the following elements:
Response Example
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example: Expand | | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block | ||
---|---|---|
| ||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("GETUSERTABSWITHREPORTS"); |
You may even identify a specific client organization:
Code Block | ||
---|---|---|
| ||
rsr.setOrgRef("org1"); |
Specify the user for whom to retrieve the report:
Code Block | ||
---|---|---|
| ||
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("admin@yellowfin.com.au");
rsr.setPerson(ap); |
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:
The returned response will contain these parameters:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
ReportGroups | An array object containing the dashaboard metadata along with the elements listed in the table below. |
Each element of the ReportGroups will contain the following elements:
Response Element | Data Type | Description |
---|---|---|
GroupReports | AdministrationReport[] | An array object containing the metadata of all of the dashboard's reports. |
<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>
<parentReportGroups>
<reportGroup>
<publishUUID>e7409ff2-f846-44e1-a603-b78ec51b20b9</publishUUID>
<reportGroupId>61250</reportGroupId>
<reportGroupName>Sales Performance</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>ANALYTIC</reportGroupType>
</reportGroup>
<reportGroupId>61250</reportGroupId>
<reportGroupSubTabs>
<publishUUID>02fec2d8-6b09-48a1-8c6a-54adbb2eb9b6</publishUUID>
<reportGroupId>61251</reportGroupId>
<reportGroupName>New Tab</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>SUBTAB</reportGroupType>
</reportGroupSubTabs>
</parentReportGroups>
<parentReportGroups>
<reportGroup>
<publishUUID>1e68d9cc-fa5a-44e2-816d-782aa40ceeae</publishUUID>
<reportGroupId>61209</reportGroupId>
<reportGroupName>Campaign Analysis</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>ANALYTIC</reportGroupType>
</reportGroup>
<reportGroupId>61209</reportGroupId>
<reportGroupSubTabs>
<publishUUID>2e2fb9f6-d43e-4de2-977e-a646b01abc4b</publishUUID>
<reportGroupId>61210</reportGroupId>
<reportGroupName>Campaigns</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>SUBTAB</reportGroupType>
</reportGroupSubTabs>
<reportGroupSubTabs>
<publishUUID>1a387957-564b-40ad-9fc1-4167ddd61f33</publishUUID>
<reportGroupId>61243</reportGroupId>
<reportGroupName>Marketing</reportGroupName>
<reportGroupStatus>OPEN</reportGroupStatus>
<reportGroupType>SUBTAB</reportGroupType>
</reportGroupSubTabs>
</parentReportGroups>
<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>
</person>
<sessionId>59ff828c9f26cbe0fdfd281a951d3ec9</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
Instructions
See below for step-by-step instructions on how to perform this call, using a Java example:
Expand | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||
|
Complete Example
Below is a full example of this web service call. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_ getuserparentreportgroups.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, and admin user according to your environment.
- Run http://<host>:<port>/ws_ getuserparentreportgroups.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% |
Code Block | ||
---|---|---|
| ||
AdministrationReport[] rpts = response.getReportGroups()[0].getGroupReports(); |
Complete Example
Below is a full example of this web service call. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_ getusertabswithreports.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, and admin user according to your environment.
- Run http://<host>:<port>/ws_ getusertabswithreports.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_getusertabswithreports.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("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_getuserparentreportgroups.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("GETUSERPARENTREPORTGROUPS"); rsr.setOrgRef("org1"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("admin@yellowfin.com.au"); rsr.setPerson(ap); rsr.setDashboardTabId(61210); // provide this dashboard sub tab id to get its parent dashboard tab details (optional) AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { ParentReportGroups[] tabs = rs.getParentReportGroups(); if (tabs != null) for (AdministrationReportGroup tab: tabs){ out.write("<br><br>Tab Name: " + tab.getReportGroupName()); out.write("<br>Number of subtabs: " + tab.getReportGroup().length)); AdministrationReportGroup[] groups = tab.getReportGroup(); for (AdministrationReportGroup gr: groups){ out.write("<br>Subtab Name: " + gr.getReportGroupName()); } } } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %> |