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 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:
|
...
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:
|
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service returns schematic information of a specified report, which includes metadata for report columns and filters as well. 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 these main parameters:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Charts | Array of ReportChart objects that contains multiple chart bitmaps when attached to a HTML report response. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Columns | Array of ReportSchema objects that contain information on each column in the report result set, and whether the report requires user prompt filter data to be passed to it. |
|
|
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> |
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>1</averageRunTime> <canDrill>false</canDrill> <category>Tutorial</category> <columns> <author>System Administrator</author> <columnName>TopN</columnName> <authoringMode>JAVA</authoringMode> <dataType>TEXT</dataType> <averageRunTime>0</averageRunTime> <displayName>Top N<<canDrill>false</displayName>canDrill> <category>Tutorial</category> <fieldId>3</fieldId> <columns> <hidden>false<<columnName>Region</hidden>columnName> <numberOfDecimals>0<<dataType>TEXT</numberOfDecimals>dataType> <displayName>Athlete Region</displayName> <outputLocation>COLUMN</outputLocation> <fieldId>1</fieldId> <prompt>false< <hidden>false</prompt>hidden> <sortOrder>0<<numberOfDecimals>0</sortOrder>numberOfDecimals> </columns> <outputLocation>COLUMN</outputLocation> <columns> <columnName>AGENCYNAME</columnName><prompt>false</prompt> <dataType>TEXT<<sortOrder>0</dataType>sortOrder> </columns> <displayName>Company Name</displayName> <columns> <fieldId>4<<allowPrompt>false</fieldId>allowPrompt> <hidden>false<<cachedValues>true</hidden>cachedValues> <numberOfDecimals>0<<columnName>Region</numberOfDecimals>columnName> <outputLocation>COLUMN<<dataType>TEXT</outputLocation>dataType> <prompt>false</prompt> <displayName>Athlete Region</displayName> <filterDisplayType>DROPDOWN</filterDisplayType> <sortOrder>1</sortOrder> <<filterId>74908</columns>filterId> <columns> <filterOmittable>true</filterOmittable> <columnName>DEMOGRAPHIC<<filterType>INLIST</columnName>filterType> <dataType>TEXT<<filterTypeCode>FILTER</dataType>filterTypeCode> <displayName>Demographic</displayName><filterUUID>d4ea61ab-247e-403a-b51b-8243aeea63db</filterUUID> <fieldId>1<<numberOfDecimals>0</fieldId>numberOfDecimals> <hidden>false<<prompt>true</hidden>prompt> <numberOfDecimals>0<<sortOrder>0</numberOfDecimals>sortOrder> </columns> <outputLocation>COLUMN< <dashboardEnabled>true</outputLocation>dashboardEnabled> <prompt>false</prompt><dataOutput>COLUMN</dataOutput> <datasource>Ski Team !!!</datasource> <drillCode>DRILLDOWN</drillCode> <errorCode>0</errorCode> <formatCode>REPORTANDCHART</formatCode> <hitCount>3</hitCount> <lastModifiedDate>2018-06-07</lastModifiedDate> <sortOrder>2</sortOrder> <lastRunDuration>0</lastRunDuration> <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> <messages>Loaded Report: 74907 </columns> <columns> <columnName>FormulaBuilderMetric</columnName> <dataType>NUMERIC</dataType> <displayName>Sum Invoiced (Pref Currency)</displayName> <fieldId>2</fieldId> <hidden>false</hidden> <numberOfDecimals>0</numberOfDecimals> <outputLocation>COLUMN</outputLocation>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:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Initialize the Report web service. Click here to learn how to do this. The response returned will contain the StatusCode parameter, along with other report specific parameters. Refer to the Response Parameter table above for details.
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.
...
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 Main Report ServicesReportServiceResponse 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:
|
...
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 Main Report Services 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:
Complete ExampleBelow is a full example of this function. To use it for yourself, carry out the following the steps:
|