Page History
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function is used to set the status of a report comment. The status options include: OPEN, EDITED, RESOLVED and DELETED.
Request ElementsThe following elements will be passed with this request:
These are the mandatory parameters that you need to set in the ReportComment object for this function:
Request ExampleThe following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response will contain the following main parameter:
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 function. To use it for yourself, carry out the following the steps:
|
Dashboard Management
The web services in this section are related to dashboard management.
...
title | LOADPARENTDASHBOARDTAB |
---|
This function retrieves a specific dashboard's parent tab's definition or metadata.
Request Elements
The following elements will be passed with this request:
Request Element | Data Type | Description |
---|---|---|
LoginId | String | Yellowfin web services administrator user Id. This can be the user ID or the email address, depending on the Logon ID method. This Yellowfin account must have the “web services” role enabled, and must belong to the Default (i.e. Primary) Org. |
Password | String | Password of the above account. |
OrgId | Integer | Default (i.e. Primary) organization ID within Yellowfin. Always set this to 1. |
ReportRequest | String | Web services function. Set this to "LOADPARENTDASHBOARDTAB". |
OrgRef | String | Optional parameter to specify an internal reference ID of a Client Org. |
DashboardTabId | Integer | An internal ID to specify the dashboard that is to be loaded. |
SessionId | Integer | (Optional) To specify a previous session by its ID. |
LanguageCode | (Optional) To specify a language. | |
ReportsOption | (Optional) A list of email addresses to send the report to. |
Request Example
The following SOAP example shows the parameters that you can pass to this call:
Code Block | ||
---|---|---|
| ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
<soapenv:Header/>
<soapenv:Body>
<web:remoteReportCall>
<arg0>
<loginId>admin@yellowfin.com.au</loginId>
<password>test</password>
<orgId>1</orgId>
<reportRequest>LOADPARENTDASHBOARDTAB</reportRequest>
<dashboardTabId>61251</dashboardTabId>
</arg0>
</web:remoteReportCall>
</soapenv:Body>
</soapenv:Envelope> |
Response Elements
The response returned will contain these parameters:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
Dashboard | Main Report Services | Object containing metadata of the specified dashboard and its subtabs. |
Response Example
The service will return the below response, according to our SOAP example:
Code Block | ||
---|---|---|
| ||
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:remoteReportCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
<return>
<canDrill>false</canDrill>
<dashboard>
<accessCode>UNSECURE</accessCode>
<categoryCode>TUTORIAL</categoryCode>
<elements>
<columnNumber>1</columnNumber>
<entityId>60947</entityId>
<entityTypeCode>REPORT</entityTypeCode>
<portletHeight>448</portletHeight>
<portletStatus>RESTORED</portletStatus>
<rowNumber>3</rowNumber>
<sequenceNumber>1</sequenceNumber>
<startDate>2017-06-26T00:00:00+10:00</startDate>
<tabId>61251</tabId>
</elements>
<elements>
<columnNumber>1</columnNumber>
<entityId>61001</entityId>
<entityTypeCode>REPORT</entityTypeCode>
<portletHeight>363</portletHeight>
<portletStatus>RESTORED</portletStatus>
<rowNumber>1</rowNumber>
<sequenceNumber>1</sequenceNumber>
<startDate>2017-06-26T00:00:00+10:00</startDate>
<tabId>61251</tabId>
</elements>
<elements>
<columnNumber>1</columnNumber>
<entityId>61097</entityId>
<entityTypeCode>REPORT</entityTypeCode>
<portletHeight>374</portletHeight>
<portletStatus>RESTORED</portletStatus>
<rowNumber>2</rowNumber>
<sequenceNumber>1</sequenceNumber>
<startDate>2017-06-26T00:00:00+10:00</startDate>
<tabId>61251</tabId>
</elements>
<elements>
<columnNumber>1</columnNumber>
<entityId>61046</entityId>
<entityTypeCode>REPORT</entityTypeCode>
<portletHeight>331</portletHeight>
<portletStatus>RESTORED</portletStatus>
<rowNumber>3</rowNumber>
<sequenceNumber>2</sequenceNumber>
<startDate>2017-06-26T00:00:00+10:00</startDate>
<tabId>61251</tabId>
</elements>
<elements>
<columnNumber>1</columnNumber>
<entityId>61067</entityId>
<entityTypeCode>REPORT</entityTypeCode>
<portletHeight>225</portletHeight>
<portletStatus>RESTORED</portletStatus>
<rowNumber>3</rowNumber>
<sequenceNumber>3</sequenceNumber>
<startDate>2017-06-26T00:00:00+10:00</startDate>
<tabId>61251</tabId>
</elements>
<elements>
<columnNumber>2</columnNumber>
<entityId>61035</entityId>
<entityTypeCode>REPORT</entityTypeCode>
<portletHeight>373</portletHeight>
<portletStatus>RESTORED</portletStatus>
<rowNumber>2</rowNumber>
<sequenceNumber>1</sequenceNumber>
<startDate>2017-06-26T00:00:00+10:00</startDate>
<tabId>61251</tabId>
</elements>
<endDate>9999-12-31T00:00:00+11:00</endDate>
<filters>
<componentId>0</componentId>
<componentTypeCode>REPORT</componentTypeCode>
<entityId>0</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>DEFAULTDISPLAY</formatKey>
<formatValue>SUMMARYCHART</formatValue>
<groupId>61250</groupId>
</filters>
<filters>
<componentId>0</componentId>
<componentTypeCode>REPORT</componentTypeCode>
<entityId>0</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>DEFAULTDISPLAY</formatKey>
<formatValue>SUMMARYCHART</formatValue>
<groupId>61250</groupId>
</filters>
<filters>
<componentId>0</componentId>
<componentTypeCode>REPORT</componentTypeCode>
<entityId>0</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>DEFAULTDISPLAY</formatKey>
<formatValue>SUMMARYCHART</formatValue>
<groupId>61250</groupId>
</filters>
<filters>
<componentId>61035</componentId>
<componentTypeCode>REPORT</componentTypeCode>
<entityId>0</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>DEFAULTDISPLAY</formatKey>
<formatValue>CHART</formatValue>
<groupId>61250</groupId>
</filters>
<filters>
<componentId>61067</componentId>
<componentTypeCode>REPORT</componentTypeCode>
<entityId>0</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>DEFAULTDISPLAY</formatKey>
<formatValue>SUMMARYCHART</formatValue>
<groupId>61250</groupId>
</filters>
<filters>
<componentId>61097</componentId>
<componentTypeCode>REPORT</componentTypeCode>
<entityId>0</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>DEFAULTDISPLAY</formatKey>
<formatValue>REPORT</formatValue>
<groupId>61250</groupId>
</filters>
<filters>
<componentId>0</componentId>
<entityId>61250</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>HELPON</formatKey>
<formatValue>true</formatValue>
<groupId>61250</groupId>
</filters>
<filters>
<componentId>0</componentId>
<entityId>61250</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>SUBTABS</formatKey>
<formatValue>OFF</formatValue>
<groupId>61250</groupId>
</filters>
<filters>
<componentId>0</componentId>
<entityId>61250</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>UNITSELECTION</formatKey>
<formatValue>OFF</formatValue>
<groupId>61250</groupId>
</filters>
<groupTypeCode>ANALYTIC</groupTypeCode>
<languageCode>EN</languageCode>
<longDescription/>
<owner>1</owner>
<ownerTypeCode>ORGANISATION</ownerTypeCode>
<parentGroupId>0</parentGroupId>
<shortDescription>Sales Performance</shortDescription>
<startDate>2017-06-26T00:00:00+10:00</startDate>
<statusCode>OPEN</statusCode>
<subCategoryCode>ATHLETES</subCategoryCode>
<subtabs>
<elements>
<columnNumber>1</columnNumber>
<entityId>60947</entityId>
<entityTypeCode>REPORT</entityTypeCode>
<portletHeight>448</portletHeight>
<portletStatus>RESTORED</portletStatus>
<rowNumber>3</rowNumber>
<sequenceNumber>1</sequenceNumber>
<startDate>2017-06-26T00:00:00+10:00</startDate>
<tabId>61251</tabId>
</elements>
<elements>
<columnNumber>1</columnNumber>
<entityId>61001</entityId>
<entityTypeCode>REPORT</entityTypeCode>
<portletHeight>363</portletHeight>
<portletStatus>RESTORED</portletStatus>
<rowNumber>1</rowNumber>
<sequenceNumber>1</sequenceNumber>
<startDate>2017-06-26T00:00:00+10:00</startDate>
<tabId>61251</tabId>
</elements>
<elements>
<columnNumber>1</columnNumber>
<entityId>61097</entityId>
<entityTypeCode>REPORT</entityTypeCode>
<portletHeight>374</portletHeight>
<portletStatus>RESTORED</portletStatus>
<rowNumber>2</rowNumber>
<sequenceNumber>1</sequenceNumber>
<startDate>2017-06-26T00:00:00+10:00</startDate>
<tabId>61251</tabId>
</elements>
<elements>
<columnNumber>1</columnNumber>
<entityId>61046</entityId>
<entityTypeCode>REPORT</entityTypeCode>
<portletHeight>331</portletHeight>
<portletStatus>RESTORED</portletStatus>
<rowNumber>3</rowNumber>
<sequenceNumber>2</sequenceNumber>
<startDate>2017-06-26T00:00:00+10:00</startDate>
<tabId>61251</tabId>
</elements>
<elements>
<columnNumber>1</columnNumber>
<entityId>61067</entityId>
<entityTypeCode>REPORT</entityTypeCode>
<portletHeight>225</portletHeight>
<portletStatus>RESTORED</portletStatus>
<rowNumber>3</rowNumber>
<sequenceNumber>3</sequenceNumber>
<startDate>2017-06-26T00:00:00+10:00</startDate>
<tabId>61251</tabId>
</elements>
<elements>
<columnNumber>2</columnNumber>
<entityId>61035</entityId>
<entityTypeCode>REPORT</entityTypeCode>
<portletHeight>373</portletHeight>
<portletStatus>RESTORED</portletStatus>
<rowNumber>2</rowNumber>
<sequenceNumber>1</sequenceNumber>
<startDate>2017-06-26T00:00:00+10:00</startDate>
<tabId>61251</tabId>
</elements>
<endDate>9999-12-31T00:00:00+11:00</endDate>
<filters>
<componentId>0</componentId>
<componentTypeCode>REPORT</componentTypeCode>
<entityId>0</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>DEFAULTDISPLAY</formatKey>
<formatValue>SUMMARYCHART</formatValue>
<groupId>61250</groupId>
</filters>
<filters>
<componentId>0</componentId>
<componentTypeCode>REPORT</componentTypeCode>
<entityId>0</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>DEFAULTDISPLAY</formatKey>
<formatValue>SUMMARYCHART</formatValue>
<groupId>61250</groupId>
</filters>
<filters>
<componentId>0</componentId>
<componentTypeCode>REPORT</componentTypeCode>
<entityId>0</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>DEFAULTDISPLAY</formatKey>
<formatValue>SUMMARYCHART</formatValue>
<groupId>61250</groupId>
</filters>
<filters>
<componentId>61035</componentId>
<componentTypeCode>REPORT</componentTypeCode>
<entityId>0</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>DEFAULTDISPLAY</formatKey>
<formatValue>CHART</formatValue>
<groupId>61250</groupId>
</filters>
<filters>
<componentId>61067</componentId>
<componentTypeCode>REPORT</componentTypeCode>
<entityId>0</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>DEFAULTDISPLAY</formatKey>
<formatValue>SUMMARYCHART</formatValue>
<groupId>61250</groupId>
</filters>
<filters>
<componentId>61097</componentId>
<componentTypeCode>REPORT</componentTypeCode>
<entityId>0</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>DEFAULTDISPLAY</formatKey>
<formatValue>REPORT</formatValue>
<groupId>61250</groupId>
</filters>
<filters>
<componentId>0</componentId>
<entityId>61250</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>HELPON</formatKey>
<formatValue>true</formatValue>
<groupId>61250</groupId>
</filters>
<filters>
<componentId>0</componentId>
<entityId>61250</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>SUBTABS</formatKey>
<formatValue>OFF</formatValue>
<groupId>61250</groupId>
</filters>
<filters>
<componentId>0</componentId>
<entityId>61250</entityId>
<entityTypeCode>REPORTGROUP</entityTypeCode>
<formatKey>UNITSELECTION</formatKey>
<formatValue>OFF</formatValue>
<groupId>61250</groupId>
</filters>
<groupTypeCode>SUBTAB</groupTypeCode>
<languageCode>EN</languageCode>
<owner>0</owner>
<parentGroupId>0</parentGroupId>
<shortDescription>New Tab</shortDescription>
<startDate>2017-06-26T00:00:00+10:00</startDate>
<statusCode>OPEN</statusCode>
<styleCode>TWO</styleCode>
<tabId>61251</tabId>
</subtabs>
<tabId>61250</tabId>
</dashboard>
<dashboardEnabled>false</dashboardEnabled>
<errorCode>0</errorCode>
<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
<messages>Attempting to Load Dashboard Tab: 61251</messages>
<messages>Web Service Request Complete</messages>
<private>false</private>
<sessionId>af433c1d0f0cffa9d3a7e1ef8c72abf6</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteReportCallResponse>
</S:Body>
</S:Envelope> |
Instructions
See below for step-by-step instructions on how to perform this call, using a Java example:
...
title | Step-by-step instructions |
---|
...
Code Block | ||
---|---|---|
| ||
ReportServiceRequest rsr = new ReportServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("LOADPARENTDASHBOARDTAB"); |
...
Code Block | ||
---|---|---|
| ||
rsr.setOrgRef("org1"); // search for the report in this client org |
...
Code Block | ||
---|---|---|
| ||
rsr.setDashboardTabId(70080); |
...
Code Block | ||
---|---|---|
| ||
ReportServiceResponse rs=rsc.remoteReportCall(rsr); |
Initialize the Report web service. Click here to learn how to do this.
...
Complete Example
Below is a full example of this function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_loadparentdashboardtab.jsp.
- Put the file in the root folder, which is Yellowfin/appserver/webapps/ROOT.
- Adjust host, port, and admin user to add details according to your environment.
- Run http://<host>:<port>/ws_loadparentdashboardtab.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
/* ws_loadparentdashboardtab.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.*" %>
<%@ page import="javax.xml.bind.JAXBContext" %>
<%@ page import="javax.xml.bind.Marshaller" %>
<%@ page import="java.io.StringWriter" %>
<%@ page import="javax.xml.bind.JAXBElement" %>
<%@ page import="javax.xml.namespace.QName" %>
<%
ReportService rsc = new ReportService(); //("localhost", 8080, "admin@yellowfin.com.au", "test", "/services/ReportService");
ReportServiceRequest rsr = new ReportServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("LOADPARENTDASHBOARDTAB");
rsr.setOrgRef("1");
rsr.setReportId(60712);
rsr.setAlterationCommand("drill-down|60712");
rsr.setReportClientReferenceId("1");
rsr.setDashboardTabId(70080);
ReportServiceResponse rs=rsc.remoteReportCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode())) {
JAXBContext context = JAXBContext.newInstance(ReportServiceResponse.class);
Marshaller m = context.createMarshaller();
m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); // To format XML
JAXBElement<ReportServiceResponse> rootElement = new JAXBElement<ReportServiceResponse>(new QName("ReportServiceResponse"), ReportServiceResponse.class, rs);
m.marshal(rootElement,out);
//out.write("Success");
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%>
|
Miscellaneous
Anchor | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function sends a report to a recipient's email address.
Request ElementsThe following elements will be passed with this request:
Request ExampleThe following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response will contain these main parameters:
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 function. To use it for yourself, carry out the following the steps:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Processes an interaction from a report a web service report. This function is used to interact with a report, such as by changing a report page, performing drill-through, drill-down, drill-anywhere, or changing the series selection. The AlterationCommand parameter is a text-code that is embedded in a report that can be passed back to the web service to alter the report. Request ElementsThe following elements will be passed with this request:
Response ElementsThe response returned will contain these parameters:
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 function. To use it for yourself, carry out the following the steps:
|