Page History

Versions Compared

Old Version 30

changes.mady.by.user user-3484a

Saved on 04 Jul, 2018

compared with

New Version Current

changes.mady.by.user user-3484a

Saved on 04 Jul, 2018

Key

This line was added.
This line was removed.
Formatting was changed.

...

Expand

title	SCHEMA

This web service returns schematic information of a specified 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 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 "SCHEMA".
OrgRef	String	Client Org internal reference ID (optional).
ReportId	Integer	The internal report ID to search for a particular report. 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.

Request Example

The following SOAP example shows the parameters that you can pass to this call:

Code Block

language	xml

<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>SCHEMA</reportRequest>
            <reportId>60712</reportId>
            </arg0>
      </web:remoteReportCall>
   </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 request. Possible values include: SUCCESS FAILURE
Columns	ReportSchema[]	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: COLUMN ROW PIVOT
Datasource	String	Name of data source that the report depends on.
DrillCode	String	Drill type if available on the report. One of: DRILLDOWN DRILLTHROUGH DRILLANYWHERE
FormatCode	String	Format code of the specified report. One of: REPORTANDCHART CHART REPORT
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: REPORTANDCHART CHART REPORT
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

	reportSchema
	reportSchema

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

language	xml

<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

title	Step-by-step instructions

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

language	java

ReportServiceRequest rsr = new ReportServiceRequest();

rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));

rsr.setReportRequest("SCHEMA");

If you need to specify the client org where the report exists, add this to your code:
Code Block
language java
rsr.setOrgRef("org1"); // search for the report in this client org

You can even specify which report's comment to change the status of:
Code Block
language java
rsr.setReportId(70045);

Once the request is configured, carry out the call:
Code Block
language java
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, 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_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

language	java
theme	Eclipse

<%        	
/*          	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

	filteroptions
	filteroptions

Expand

title	FILTEROPTIONS

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 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 "FILTEROPTIONS".
OrgRef	String	(Optional) Client Org internal reference ID, if you want to specify a specific client org to search the report in. If not specified, the default org will be searched.
ReportClientReferenceId	String	(Optional) This is another option to specify a particular client org.
ReportId	Integer	The internal report ID to search for a particular report. 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	The internal filter ID. Tip: Use the SCHEMA function to get a valid filter ID as it changes each time the report is modified.

Request Example

The following SOAP example shows the parameters that you can pass to this call:

Code Block

language	xml

<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>FILTEROPTIONS</reportRequest>
        	  	<reportId>70066</reportId>
        	  	<objectName>70081</objectName>
         </arg0>
  	</web:remoteReportCall>
   </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 request. Possible values include: SUCCESS FAILURE
Results	ReportRow[]	Array of available filter values. See the table below 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: COLUMN ROW PIVOT
Datasource	String	Name of data source used for this report.
FormatCode	String	Format code of the specified report. One of: REPORTANDCHART CHART REPORT
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: REPORTANDCHART CHART REPORT
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

	reportRow
	reportRow

The ReportRow object will return the following parameter.

Parameter	Type	Description
DataValue	String[]	Array of Strings with data for each column in the report result set.

Response Example

The service will return the below response, according to our SOAP example:

Code Block

language	xml

<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>
            <dashboardEnabled>true</dashboardEnabled>
            <dataOutput>COLUMN</dataOutput>
        	<datasource>Ski Team</datasource>
            <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

title	Step-by-step instructions

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

language	java

ReportServiceRequest rsr = new ReportServiceRequest();

rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));

rsr.setReportRequest("FILTEROPTIONS");

Specify the report whose filters are to be retrieved:
Code Block
language java
rsr.setReportId(70066);

To retrieve a specific filter, provide its filter ID in the ObjectName parameter:
Code Block
language java
rsr.setObjectName("70081");

Once the request is configured, carry out the call:
Code Block
language java
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, 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_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

language	java
theme	Eclipse

<%        	
/*          	ws_filteroptions.jsp                         	*/
%>
<% 
	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");
              	
 	
	rs = rssbs.remoteReportCall(rsr);
 
	if ("SUCCESS".equals(rs.getStatusCode())) {
    	out.write("Success </br>");
                                	ReportRow[] rows = rs.getResults();
                                	for (ReportRow r: rows) {
                                                  	//display filter values:                                      	
                                                                    	out.write("<br>" + r.getDataValue()[0]);
                                                  	}
	} else {
    	out.write(rs.getStatusCode());
    	out.write(rs.toString());
	}
%>

...

Content

Space Tools

Versions Compared

Old Version 30

New Version Current

Key

Request Elements

Request Example

Response Elements

Response Example

Instructions

Complete Example

Request Elements

Request Example

Response Elements

Response Example

Instructions

Complete Example