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:
|
Report Comment Management
The web services in this section are related to user comments on Yellowfin reports.
Anchor | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function is used to set the status web service returns schematic information of a report comment. The status options include: OPEN, EDITED, RESOLVED and DELETEDspecified report, 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:
Anchor | | commentstatusrc |
The report ID changes every time a report is modified. Tip: you can use the GETIDFROMUUID function to get the relevant report ID. | ||
ObjectName | String | (Optional) The web service name of the report. This is not needed if the report ID is provided. |
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>SCHEMA</reportRequest> <reportId>60712</reportId> <reportComment> <commentId>12345</commentId></arg0> <statusCode>OPEN</statusCode> </web:remoteReportCall> </reportComment> </arg0> </web:remoteReportCall> </soapenv</soapenv:Body> </soapenv:Envelope> |
Response Elements
The response returned will contain these main parameters:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service callrequest. Possible values include:
|
Columns |
Response Example
The service will return the below response, according to our SOAP example:
language | xml |
---|
Array of ReportSchema objects that contain information (metadata) on each column in the report result set, and whether the report requires user prompt filter data to be passed to it. See the below table for more details. | ||
Author | String | Name of the user to wrote the report. |
AuthoringMode | String | |
AverageRunTime | Integer | |
CanDrill | Boolean | Whether or not the report has any drill functionality enabled. |
Category | String | Name of the folder the report is saved in. |
SubCategory | String | Name of the sub-folder the report is saved in. |
DashboardEnabled | Boolean | |
DataOutput | String | One of:
|
Datasource | String | Name of data source that the report depends on. |
DrillCode | String | Drill type if available on the report. One of:
|
FormatCode | String | Format code of the specified report. One of:
|
HitCount | Integer | Number of times the specified report has been accessed. |
LastModifiedDate | String | Date when report was last modified. |
LastRunDuration | Integer | |
PreRunFilterString | String | |
Private | Boolean | Determines if the report is a private or a public one. (Private for Legacy services.) |
ReportDescription | String | Description of the specified report. |
ReportId | Integer | ID of the specified report. |
ReportName | String | Name of the specified report. |
ReportTemplate | String | The template applied to the report. One of:
|
ReportUUID | String | UUID of the report. |
ReportUsage | Integer | |
ViewName | String | Name of view that the report depends on. |
Tags | String | |
ErrorCode | Integer | The code number of the error if the web service fails. |
Messages | String[] | Array of Strings that show debug information as the report is run on the server. Used for debugging and tracing errors. |
Anchor | ||||
---|---|---|---|---|
|
The ReportSchema object will return the following parameters containing information on the report column.
Parameter | Type | Description |
---|---|---|
ColumnName | String | Name of the report column. |
DisplayName | String | Display name of column. |
ColumnLength | String | Length of the report column. |
FieldId | Integer | Field Id of column. |
DataType | String | Data type of the report column. |
SortOrder | Integer | The order in which the column is sorted. |
Hidden | Boolean | Whether the column is displayed in the report or not. |
NumberOfDecimals | Integer | |
OutputLocation | String | |
AllowPrompt | Boolean | Only for filters. |
CachedValues | Boolean | Only for filters. Whether or not the filter is set to use Cached Values. |
FilterDisplayType | String | Only for filters. Filter Display Type if the column is a filter. |
FilterId | String | Only for filters. Filter Id if the column is a filter. |
FilterOmittable | Boolean | Only for filters |
FilterType | String | Only for filters. Determines the filter type and what data would have to be posted to engage the prompt. |
DefaultValue1 | String | Only for filters. First default value for filter if set. |
DefaultValue2 | String | Only for filters. Second default value for filter if set. |
FilterTypeCode | String | Only for filters |
FilterUUID | String | Only for filters. The UUID of the filter. |
MinimumValue | BigDecimal | Only for filters. Minimum value for filter if set. |
MaximumValue | BigDecimal | Only for filters. Maximum value for filter if set |
ParentFilterId | Integer | Only for filters. Filter ID of parent filter if a filter dependency is in place. |
Prompt | Boolean | Only for filters. Whether the column is a prompt field or not. |
ValueUnitCode | String | Only for filters. Time units for the filter if set. |
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>
<author>System Administrator</author>
<authoringMode>JAVA</authoringMode>
<averageRunTime>0</averageRunTime>
<canDrill>false</canDrill>
<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>
<allowPrompt>false</allowPrompt>
<cachedValues>true</cachedValues>
<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>
<prompt>true</prompt>
<sortOrder>0</sortOrder>
</columns>
<dashboardEnabled>true</dashboardEnabled>
<dataOutput>COLUMN</dataOutput>
<datasource>Ski Team !!!</datasource>
<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 filters</reportName>
<reportTemplate>REPORTANDCHART</reportTemplate>
<reportUUID>982500e8-7b33-476b-be47-6a1aab611349</reportUUID>
<reportUsage>100</reportUsage>
<sessionId>7e9971ea99fff609387ac1c504abcc63</sessionId>
<statusCode>SUCCESS</statusCode>
<subCategory>Training</subCategory>
<tags>No tags</tags>
<viewName>Ski Team</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_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 | ||||
---|---|---|---|---|
| ||||
<%
/* ws_reportschema.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.*" %>
<%
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>");
ReportSchema[] schema = rs.getColumns();
for (ReportSchema s: schema)
//display filters:
if (s.getFilterType() != null && s.getFilterTypeCode().equals("FILTER")){
out.write("<br>Display Name: " + s.getDisplayName());
out.write("<br>Filter UUID:" + s.getFilterUUID());
out.write("<br>Filter Id:" + s.getFilterId());
}
} else {
out.write(rs.getStatusCode());
out.write(rs.toString());
}
%>
|
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:
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:
|
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:
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:
|
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:
|
...
|
...
|
...
|
...
|
...
Code Block | ||
---|---|---|
| ||
ReportComment rc=new ReportComment(); |
...
|
Code Block | ||
---|---|---|
| ||
rc.setReportId(60712); |
...
|
...
|
...
|
...
|
...
Complete ExampleBelow is a full example of this function. To use it for yourself, carry out the following the steps:
|
...
|
...
|
...
language | java |
---|---|
theme | Eclipse |
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|