Page History
This section covers the overall administrative report web services.
Basic Functions
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function is used to test whether or not the report web services service is working.
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 returned will contain these 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web services retrieves details of a specified report.
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 returned will contain these 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service retrieves the result data returns schematic information of a specified report, as well as the report's metadata. The report's result will be in a raw, preformatted format. This result will be stored in an array of ReportRow objects, which each such object representing a result row. Therefore, for each of the rows, an array of strings containing the data in each column of the result data will be present. Note: It is up to the web services client to convert this data from the string representation into the data type for each particular column. The data types for each column can be obtained with the SCHEMA function. For example, here is a Role Population report that contains two columns and specifies the number of users assigned to each user role:
This web service will return a ReportRow object for each of the user role, which every object containing two data strings: one containing the name of the role, and the other displaying its user population.
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: which includes metadata for report columns and filters. A report needs to be specified by either providing its ID or by its web service name.
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 returned will contain the following these main parameters: (For a more detailed list of response parameters, refer to the ReportServiceResponse object.)
Response ExampleThe service will return the below response, according to our SOAP example:
The ReportSchema object will return the following parameters containing information on the report column.
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 | ||
---|---|---|
| ||
ReportServiceRequest rsr = new ReportServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("RESULTSET"); |
Code Block | ||
---|---|---|
| ||
rsr.setReportId(60712); |
Code Block | ||
---|---|---|
| ||
rsr.setReportClientReferenceId("1"); |
Code Block | ||
---|---|---|
| ||
ReportServiceResponse rs=rsc.remoteReportCall(rsr); |
Initialize the Report web service. Click here to learn how to do this.
The response returned will contain the StatusCode and Results parameters, along with other report specific parameters. Refer to the Response Parameter table above for details.
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_resultset.jsp.
- Put the file in the root folder, which is Yellowfin/appserver/webapps/ROOT.
- Adjust host, port, and admin user, and report details according to your environment.
- Run http://<host>:<port>/ws_resultset.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<%<category>Tutorial</category> <columns> <columnName>Region</columnName> <dataType>TEXT</dataType> <displayName>Athlete Region</displayName> <fieldId>1</fieldId> <hidden>false</hidden> <numberOfDecimals>0</numberOfDecimals> <outputLocation>COLUMN</outputLocation> <prompt>false</prompt> <sortOrder>0</sortOrder> </columns> <columns> /* ws_resultset.jsp<allowPrompt>false</allowPrompt> *<cachedValues>true</cachedValues> %> <%@ 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("RESULTSET"); rsr.setReportId(60712); rsr.setReportClientReferenceId("1"); ReportServiceResponse rs=rsc.remoteReportCall(rsr); if ("SUCCESS".equals(rs.getStatusCode())) { JAXBContext context = JAXBContext.newInstance(ReportServiceResponse.class); <columnName>Region</columnName> <dataType>TEXT</dataType> <displayName>Athlete Region</displayName> <filterDisplayType>DROPDOWN</filterDisplayType> <filterId>74908</filterId> <filterOmittable>true</filterOmittable> <filterType>INLIST</filterType> <filterTypeCode>FILTER</filterTypeCode> <filterUUID>d4ea61ab-247e-403a-b51b-8243aeea63db</filterUUID> <numberOfDecimals>0</numberOfDecimals> Marshaller m = context.createMarshaller(); <prompt>true</prompt> m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE); <sortOrder>0</sortOrder> </ To format XML columns> <dashboardEnabled>true</dashboardEnabled> JAXBElement<ReportServiceResponse> rootElement = new JAXBElement<ReportServiceResponse>(new QName("ReportServiceResponse"), ReportServiceResponse.class, rs); <dataOutput>COLUMN</dataOutput> <datasource>Ski Team !!!</datasource> m.marshal(rootElement,out); //out.write("Success"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %> |
title | FORMATTEDRESULTSET |
---|
This web service is similar to the RESULTSET one, however it returns the raw result set using the formatters from the report.
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 "FORMATTEDRESULTSET". |
OrgRef | String | Client Org internal reference ID (optional). |
ReportId | Integer | ID of the report whose result data is to be viewed. |
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><drillCode>DRILLDOWN</drillCode> <errorCode>0</errorCode> <formatCode>REPORTANDCHART</formatCode> <hitCount>3</hitCount> <lastModifiedDate>2018-06-07</lastModifiedDate> <lastRunDuration>0</lastRunDuration> <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> <messages>Loaded Report: 74907 Successfully</messages> <messages>Collating Schema Information</messages> <messages>Web Service Request Complete</messages> <preRunFilterString><![CDATA[<div class="rptFilterLogicText"> <span class="rptFilterLogicIdentifier">Athlete Region</span> In List <span class="rptFilterLogicIdentifier">[User Prompt]</span> </div>]]></preRunFilterString> <private>false</private> <reportDescription>Ski Team, 8/6/2018 9:36 AM</reportDescription> <reportId>74907</reportId> <reportName>cached <arg0>filters</reportName> <loginId>admin@yellowfin.com.au</loginId> <reportTemplate>REPORTANDCHART</reportTemplate> <reportUUID>982500e8-7b33-476b-be47-6a1aab611349</reportUUID> <password>test< <reportUsage>100</password>reportUsage> <orgId>1<<sessionId>7e9971ea99fff609387ac1c504abcc63</orgId>sessionId> <reportRequest>FORMATTEDRESULTSET<<statusCode>SUCCESS</reportRequest>statusCode> <reportId>58511<<subCategory>Training</reportId>subCategory> <tags>No tags</tags> </arg0> <viewName>Ski Team</viewName> </web:remoteReportCall>return> </ns2:remoteReportCallResponse> </soapenvS:Body> </soapenvS:Envelope> |
Response Elements
The response will contain the following main parameters: (For a more detailed list of response parameters, refer to the ReportServiceResponse object.)
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
Results | ReportRow[] | An array of object containing the result of the report's data set. |
Response Example
The service will return the below response, according to our SOAP exampleInstructions
See below for step-by-step instructions on how to perform this call, using a Java example:
Expand | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||
| xml |
|
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_reportschema.jsp.
- Put the file in the root folder, which is Yellowfin/appserver/webapps/ROOT.
- Adjust host, port, and admin user details according to your environment.
- Run http://<host>:<port>/ws_reportschema.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% <author>System Administrator</author> <authoringMode>JAVA</authoringMode> <averageRunTime>0</averageRunTime> <canDrill>false</canDrill> <category>Audit Reports</category> /* <dashboardEnabled>true</dashboardEnabled> ws_reportschema.jsp <dataOutput>COLUMN</dataOutput> <datasource>Yellowfin Configuration Database< */datasource> %> <%@ page <errorCode>0</errorCode> <formatCode>REPORTANDCHART</formatCode> <hitCount>5</hitCount> <lastModifiedDate>2016-04-13</lastModifiedDate> 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.*" %> <% ReportServiceResponse rs = null; ReportServiceRequest rsr = new ReportServiceRequest(); ReportServiceService ts = new ReportServiceServiceLocator("localhost", 8080, "/services/ReportService", false); ReportServiceSoapBindingStub rssbs = (ReportServiceSoapBindingStub) ts.getReportService(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setReportRequest("SCHEMA"); rsr.setReportId(70045); rs = rssbs.remoteReportCall(rsr); if ("SUCCESS".equals(rs.getStatusCode())) { out.write("Success </br>"); <lastRunDuration>0</lastRunDuration> <lastRunStatus>RUN_NOERROR</lastRunStatus> <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> ReportSchema[] schema = rs.getColumns(); <messages>Loaded Report: 58511 Successfully</messages> <messages>Returning RAW Resultset</messages> for (ReportSchema s: schema) <messages>Request Contains No ReportFilter Records.</messages> <messages>Report Run Successfully</messages> <messages>Web Service Request Complete</messages> <private>false</private> //display filters: <reportDescription/> <reportId>58511</reportId> <reportName>Role Population</reportName> <reportTemplate>REPORTANDCHART</reportTemplate> if (s.getFilterType() != null && s.getFilterTypeCode().equals("FILTER")){ <reportUUID>00c65743-15f8-4f93-ace1-e3d4d2b956eb</reportUUID> <reportUsage>9</reportUsage> <results> <dataValue>System Administrator</dataValue> <dataValue>1</dataValue> out.write("<br>Display Name: " </results>+ s.getDisplayName()); <results> <dataValue>Consumer & Collaborator</dataValue> <dataValue>5</dataValue> </results> out.write("<br>Filter UUID:" <sessionId>1e4f0c8ee07d24a5500f952a459b1652</sessionId>+ s.getFilterUUID()); <statusCode>SUCCESS</statusCode> <subCategory>User Access</subCategory> <tags>No tags</tags> <viewName>NEW VIEW</viewName> </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("FORMATTEDRESULTSET"); |
Code Block | ||
---|---|---|
| ||
rsr.setReportId(60712); |
Code Block | ||
---|---|---|
| ||
rsr.setReportClientReferenceId("1"); |
Code Block | ||
---|---|---|
| ||
ReportServiceResponse rs=rsc.remoteReportCall(rsr); |
Initialize the Report web service. Click here to learn how to do this.
The response returned will contain the StatusCode and Results parameters, along with other report specific parameters. Refer to the Response Parameter table above for details.
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_resultset.jsp.
- Put the file in the root folder, which is Yellowfin/appserver/webapps/ROOT.
- Adjust host, port, and admin user, and report details according to your environment.
- Run http://<host>:<port>/ws_resultset.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<%
/* ws_resultset.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("FORMATTEDRESULTSET");
rsr.setOrgRef("1");
rsr.setReportId(60712);
rsr.setReportClientReferenceId("1");
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());
}
%>
|
Report Comment Management
The web services in this section are related to user comments on Yellowfin reports.
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service returns the filter values for a specified report. Note: There is currently no way to pass user information into this request. So if a report has access filters assigned to it that restrict certain values, then only the filter values that the logged in user (that is the user calling this web service) has access to, will be returned.
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 returned will contain these main parameters:
The ReportRow object will return the following parameter.
Response ExampleThe service will return the below response, according to our SOAP example:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function retrieves all comments of a particular report, provided it has any.
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 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: Expand | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block | ||
---|---|---|
| ||
ReportServiceRequest rsr = new ReportServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("GETCOMMENTS"); |
Code Block | ||
---|---|---|
| ||
rsr.setOrgRef("org1"); // search for the report in this client org |
Code Block | ||
---|---|---|
| ||
rc.setReportId(60712); |
Pass the 'rc' object to the request:
Code Block | ||
---|---|---|
| ||
rsr.setReportComment(rc); |
Code Block | ||
---|---|---|
| ||
ReportServiceResponse rs=rsc.remoteReportCall(rsr); |
Initialize the Report web service. Click here to learn how to do this.
The response returned will contain the StatusCode parameter. Refer to the Response Parameter table above for details.
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_getcomments.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_getcomments.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% <dashboardEnabled>true</dashboardEnabled> /* <dataOutput>COLUMN</dataOutput> ws_getcomments.jsp <datasource>Ski Team</datasource> */ %> <%@ 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" %> <% /* Create Group Using Java generated stubs rather that using the Yellowfin webservices API.. */ 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("GETCOMMENTS"); rsr.setReportId(56401); ReportServiceResponse rs=rsc.remoteReportCall(rsr); %> |
title | COMMENTSTATUS |
---|
<errorCode>0</errorCode>
<formatCode>REPORTANDCHART</formatCode>
<hitCount>2</hitCount>
<lastModifiedDate>2018-06-18</lastModifiedDate>
<lastRunDuration>0</lastRunDuration>
<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
<messages>Loaded Report: 70080 Successfully</messages>
<messages>Retrieving Options</messages>
<messages>Request Contains No ReportFilter Records.</messages>
<messages>Region (FilterId: 70082 ) Requires User Prompt</messages>
<messages>Ignoring Prompt Filter On Field: 70082</messages>
<messages>DEMOGRAPHIC (FilterId: 70081 ) Requires User Prompt</messages>
<messages>Web Service Request Complete</messages>
<preRunFilterString><![CDATA[<div class="rptFilterLogicText">
<span class="rptFilterLogicIdentifier">Athlete Region</span>
In List
<span class="rptFilterLogicIdentifier">[User Prompt]</span>
</div>
<div class="rptFilterLogicText">
AND
<span class="rptFilterLogicIdentifier">Demographic</span>
In List
<span class="rptFilterLogicIdentifier">(Adventure, Relaxation, Family, Culture)</span>
</div>]]></preRunFilterString>
<private>false</private>
<reportDescription>Ski Team, 18/6/2018 2:49 PM</reportDescription>
<reportId>70066</reportId>
<reportName>qwerty</reportName>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>c105ab26-9744-434d-9c8c-9fb9e48d80c0</reportUUID>
<reportUsage>100</reportUsage>
<results>
<dataValue>Asia</dataValue>
<dataValue>Asia</dataValue>
</results>
<sessionId>eb31d9392a25c8c40995237650837cd5</sessionId>
<statusCode>SUCCESS</statusCode>
<subCategory>Training</subCategory>
<tags>No tags</tags>
<viewName>New View</viewName>
</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:
Expand | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||
|
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_filteroptions.jsp.
- Put the file in the root folder, which is Yellowfin/appserver/webapps/ROOT.
- Adjust host, port, and admin user details according to your environment.
- Run http://<host>:<port>/ws_filteroptions.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<%
/* ws_filteroptions.jsp |
This function is used to set the status of a report comment. The status options include: OPEN, EDITED, RESOLVED and DELETED.
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 "COMMENTSTATUS". |
ReportComment | Object containing details of the report comment whose status is to be set. See table below. | |
OrgRef | String | Client Org Internal Reference Id (optional). Use this to search for the report in the referenced Client Org. If this is not set, then the report will be searched in the default (primary) org. |
ReportId | Integer | You can provide a report ID to search for a particular report. |
These are the mandatory parameters that you need to set in the ReportComment object for this function:
ReportComment Element | Data Type | Description | Retrieval Code |
---|---|---|---|
CommentId | Integer | ID of comment |
|
StatusCode | String | Provide the new status. The status option include: OPEN, EDITED, RESOLVED and DELETED. |
|
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>COMMENTSTATUS</reportRequest> <reportId>60712</reportId> <reportComment> */ %> <% ReportServiceResponse rs = null; ReportServiceRequest rsr = new ReportServiceRequest(); ReportServiceService ts = new ReportServiceServiceLocator("localhost", 8080, "/services/ReportService", false); ReportServiceSoapBindingStub rssbs = (ReportServiceSoapBindingStub) ts.getReportService(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setReportRequest("FILTEROPTIONS"); rsr.setReportId(70066); rsr.setObjectName("70081"); <commentId>12345</commentId> rs = rssbs.remoteReportCall(rsr); if ("SUCCESS".equals(rs.getStatusCode())) { <statusCode>OPEN</statusCode> out.write("Success </br>"); </reportComment> </arg0> ReportRow[] rows </web:remoteReportCall> </soapenv:Body> </soapenv:Envelope> |
Response Elements
The response will contain the following main parameter:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
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> = rs.getResults(); <ns2:remoteReportCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/"> <return> for (ReportRow r: rows) <canDrill>false</canDrill>{ <dashboardEnabled>false</dashboardEnabled> <errorCode>0</errorCode> <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> //display filter values: <messages>Web Service Request Complete</messages> <private>false</private> <sessionId>6dc344c3e5dee88864998f4acc17d676</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:
Expand | ||
---|---|---|
| ||
Here's a basic request to perform this call, which includes logging in as the admin user and specifying the web service call to perform: Code Block | | |
| ||
Code Block | ||
|
Code Block | ||
---|---|---|
| ||
ReportComment rc=new ReportComment(); |
Code Block | ||
---|---|---|
| ||
rc.setReportId(60712); |
Code Block | ||
---|---|---|
| ||
rc.setCommentId(12345);
rc.setStatusCode("OPEN"); |
Code Block | ||
---|---|---|
| ||
rsr.setReportComment(rc); |
Code Block | ||
---|---|---|
| ||
ReportServiceResponse rs=rsc.remoteReportCall(rsr); |
Initialize the Report web service. Click here to learn how to do this.
The response returned will contain the StatusCode parameter. Refer to the Response Parameter table above for details.
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_commentstatus.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_commentstatus.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<%
/* ws_commentstatus.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" %>
<%
/*
Create Group
Using Java generated stubs rather that using the Yellowfin webservices API..
*/
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("COMMENTSTATUS");
ReportComment rc=new ReportComment();
rc.setReportId(60712);
rc.setCommentId(12345);
rc.setStatusCode("OPEN");
rsr.setReportComment(rc);
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());
}
%>
|
Dashboard Management
The web services in this section related to dashboard management.
|
Report Result Set Functions
These web services are specific to the result generated by a report.
Anchor | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service retrieves the result data of a specified report, as well as the report's metadata. The report's result will be in a raw, preformatted format. This result will be stored in an array of ReportRow objects, which each such object representing a result row. Therefore, for each of the rows, an array of strings containing the data in each column of the result data will be present. Note: It is up to the web services client to convert this data from the string representation into the data type for each particular column. The data types for each column can be obtained with the SCHEMA function. For example, here is a Role Population report that contains two columns and specifies the number of users assigned to each user role:
This web service will return a ReportRow object for each of the user role, which every object containing two data strings: one containing the name of the role, and the other displaying its user population.
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 the following main parameters: (For a more detailed list of response parameters, refer to the ReportServiceResponse object.)
Response ExampleThe service will return the below response, according to our SOAP example:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function retrieves a specified dashboard tab's definition or metadata.
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 returned will contain these 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service is similar to the RESULTSET function call, however it returns the raw result set using the formatters from the report.
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 the following main parameters: (For a more detailed list of response parameters, refer to the ReportServiceResponse object.)
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:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Code Block |
1"); rsr.setReportId(60712); rsr.setReportClientReferenceId("1"); ReportServiceResponse rs=rsc.remoteReportCall(rsr); Initialize the Report web service. Click here to learn how to do this. The response returned will contain the following parameters: StatusCode, Dashboard, Subtabs. (See the Response Parameters table above for more details.) Complete ExampleBelow is a full example of this function. To use it for yourself, carry out the following the steps:
|
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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function retrieves a specific dashboard's parent tab's definition or metadata.
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 returned will contain these 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:
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|