Page History

Versions Compared

Old Version 9

changes.mady.by.user user-3484a

Saved on 08 Mar, 2018

compared with

New Version Current

changes.mady.by.user user-3484a

Saved on 12 Aug, 2018

Key

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

These web services are used in a cluster environment, where Yellowfin is set up amongst multiple nodes connected to a local database. Most of these are used to transmit messages between the cluster nodes, and to clear the cache of a specific node, when data is updated or deleted locally, ensuring consistency in content throughout the cluster. Each of these services remove a specific type of content/data.

Anchor

	binaryCacheFlush
	binaryCacheFlush

Favourting Items

Request Example

Below is

These are the main parameters that you must set in the AdministrationPerson object for this web service call:

Expand

title	GETFAVOURITESBINARYCACHEFLUSH

This web service call returns all reports marked as favourite by a specific user. is used to remove classes that are in the binary class loader. For example, this could be classes that were loaded as plug-ins such as connectors or data transformation steps that are stored in the database rather than on the file system.

Request Parameters

The following parameters should be passed with this request:

Person

Request Element	Data Type	Description
LoginId	String	An admin account to connect to Yellowfin web services. This can be the user ID or the email address, depending on the Logon ID method. This 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.
Function	String	Web service function. Set this to "GETFAVOURITESBINARYCACHEFLUSH".

AdministrationPerson

This object contains details of the user. See table below.

Anchor

getfaveap

AdministrationPerson Element	Data Type	Description
UserId	String	ID of the user whose favourite reports are to be fetched. This value could be the user ID or user's email address, depending on the Logon ID method.

Request Example

Below is a SOAP XML example for this request:

Code Block

theme

language	xml		Confluence

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall> 
         <arg0>
      		      <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>GETFAVOURITES<<function>BINARYCACHEFLUSH</function>
            <person>
            	<userId>admin@yellowfin.com.au</userId>
    </arg0>
        </person>   web:remoteAdministrationCall>
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:</soapenv:Body>
</soapenv:Envelope>

Response Parameters

The returned response will contain the following parameterthese parameters:

Response Element	Data Type	Description
StatusCode	String	Status of the web service call. Possible values include: SUCCESS FAILURE
Person	AdministrationPerson	Full details of the user.
Reports	AdministrationReports[]	An array of the user's favourite reports.

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Person

AdministrationPerson

Full details of the user.

Reports

AdministrationReports[]

An array of the user's favourite reports.

Response Example

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

Code Block

language	xml
theme	Confluence

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Getting user information...</messages>
            <messages>Getting user information...</messages>
            <messages>Web Service Request Complete</messages>
            <person><sessionId>071e8a40b17160cbc3e55df360cdab11</sessionId>
               <emailAddress>admin@yellowfin.com.au</emailAddress><statusCode>SUCCESS</statusCode>
         </return>
      <firstName>System<</firstName>ns2:remoteAdministrationCallResponse>
               <initial/>
               <ipId>5</ipId>
               <languageCode>EN</languageCode>
               <lastName>Administrator</lastName>
               <roleCode>YFADMIN</roleCode>
               <salutationCode/>
               <status>ACTIVE</status>
               <timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
               <userId>admin@yellowfin.com.au</userId>
            </person>
</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

Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

Code Block

language	java
theme	Confluence

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

rsr.setFunction("BINARYCACHEFLUSH");

Once the request is configured, perform the call:
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.

The response will contain the StatusCode. (See details in the Response Parameters table above.)

Complete Example

Below is a full example of this web service call. To use it for yourself, carry out the following the steps:

Copy the code and save it as ws_binarycacheflush.jsp.
Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
Adjust the host, port, and admin user details according to your environment.
Run http://<host>:<port>/ws_binarycacheflush.jsp from your Internet browser.

Code Block

language	java
theme	Eclipse

<%   	
/*    	ws_binarycacheflush.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.*" %>
 
AdministrationServiceResponse rs = null;
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();

rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("BINARYCACHEFLUSH");    
rs = rssbs.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode())) {
    out.write("Success");
} else {
    out.write("Failure");
    out.write(rs.toString());
}

Anchor

	uploadLicence
	uploadLicence

Expand

title	UPLOADLICENCE

This web service is used to upload a new licence for the Yellowfin instance.

Request Parameters

The following parameters should be passed with this request:

Request Element	Data Type	Description
LoginId	String	An admin account to connect to Yellowfin web services. This can be the user ID or the email address, depending on the Logon ID method. This 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.
Function	String	Web service function. Set this to "UPLOADLICENCE".
BinaryData	byte[]	A byte array containing the new licence.

Response Parameters

The returned response will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Instructions

See below for step-by-step instructions on how to perform this call, using a Java example:

Expand

title	Step-by-step instructions

Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

Code Block

language	java
theme	Confluence

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

rsr.setFunction("UPLOADLICENCE");

Provide the new licence for your instance. The licence will be a byte array; you can encode it to Base64 and use the util method to convert it.
Code Block
language java
byte[] lic = com.hof.util.Base64.decode("Base64 Encoded String of licence file"); rsr.setBinaryData(lic);

Once the request is configured, perform the call:
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.

The response will contain the StatusCode. (See details in the Response Parameters table above.)

Complete Example

Below is a full example of this web service call. To use it for yourself, carry out the following the steps:

Copy the code and save it as ws_uploadlicence.jsp.
Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
Adjust the host, port, and admin user details according to your environment.
Run http://<host>:<port>/ws_uploadlicence.jsp from your Internet browser.

Code Block

language	java
theme	Eclipse

<%   	
/*    	ws_uploadlicence.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.*" %>
 
AdministrationServiceResponse rs = null;
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();

rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("UPLOADLICENCE");
    
// Licence needs to be a byte array. An easy way to do this is to encode it to Base64 and use the util method to convert it
byte[] lic = com.hof.util.Base64.decode("Base64 Encoded String of licence file");
rsr.setBinaryData(lic);
    
rs = rssbs.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode())) {
	out.write("Success");
} else {
	out.write(rs.getStatusCode());
	out.write(rs.toString());
}

Anchor

	delGeoPack
	delGeoPack

Expand

title	DELGEOPACK

This web service removes a specified Geopack from the Geopack cache. Note, however, that it does not delete the Geopack from the server.

Request Parameters

The following parameters should be passed with this request:

Request Element	Data Type	Description
LoginId	String	An admin account to connect to Yellowfin web services. This can be the user ID or the email address, depending on the Logon ID method. This 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.
Function	String	Web service function. Set this to "DELGEOPACK".
OrgRef	String	This optional parameter can be used to specify a client org. ID
Parameters	String	Use this to specify the UUID of the geopack to be deleted from the cache.

Request Example

Below is a SOAP XML example for this request:

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:remoteAdministrationCall>  <reports>
               <authoringMode>JAVA</authoringMode>
               <averageRunTime>0</averageRunTime>
               <birtData/>
               <chartTypeCode/>
               <dashboardEnabled>true</dashboardEnabled>
               <dataOutput>COLUMN</dataOutput>
               <deliveryMode/>
               <executionObject/>
               <lastModifiedDate>2016-03-29T00:00:00+11:00</lastModifiedDate>
               <lastModifierId>5</lastModifierId>
               <lastModifierName>System Administrator</lastModifierName>
               <publishDate>2016-03-23T00:00:00+11:00</publishDate>
               <reportCategory>Audit Reports</reportCategory>
               <reportDescription/>
               <reportId>56401</reportId>
               <reportName>Active Sessions</reportName>
               <reportSubCategory>Admin Reports</reportSubCategory>
               <reportTemplate>REPORTANDCHART</reportTemplate>
               <reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID>
               <roleCode>OPERATIONAL</roleCode>
               <sourceName/>
               <usage>24</usage>
               <viewDescription>Yellowfin Usage Audit</viewDescription>
               <viewId>56169</viewId>
               <viewName>NEW VIEW</viewName>
            </reports>
            <reports>
               <authoringMode>JAVA</authoringMode>
               <averageRunTime>0</averageRunTime>
               <birtData/>
               <chartTypeCode/>
               <dashboardEnabled>true</dashboardEnabled>
               <dataOutput>COLUMN</dataOutput>
               <deliveryMode/>
               <executionObject/>
               <lastModifiedDate>2016-03-29T00:00:00+11:00</lastModifiedDate>
               <lastModifierId>5</lastModifierId>
               <lastModifierName>System Administrator</lastModifierName>
               <publishDate>2016-03-23T00:00:00+11:00</publishDate>
               <reportCategory>Audit Reports</reportCategory>
         <arg0>
 		     <reportDescription/><loginId>admin@yellowfin.com.au</loginId>
               <reportId>56401</reportId><password>test</password>
               <reportName>Active Sessions</reportName><orgId>1</orgId>
               <reportSubCategory>Admin Reports</reportSubCategory><function>DELGEOPACK</function>
               <reportTemplate>REPORTANDCHART</reportTemplate><parameters>
               <reportUUID>594d4da4-1b58-44d3-bf4f-11456a42f68c</reportUUID>	<string>db1cf6f7-3561-45a0-b6bc-ff7b94117741</string>
               <roleCode>OPERATIONAL</roleCode></parameters>
               <sourceName/></arg0>
               <usage>24</usage></web:remoteAdministrationCall>
               <viewDescription>Yellowfin Usage Audit</viewDescription>
    </soapenv:Body>
</soapenv:Envelope>

Response Parameters

The returned response will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

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>
           <viewId>56169</viewId><ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
               <viewName>NEW VIEW</viewName><return>
            <<errorCode>0</reports>errorCode>
            <sessionId>dffb6a0f4f155d46c73d1e77dffbd81c<<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>9a3871407a758998334a2d780c44f9ae</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </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

Start with a basic Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

Code Block

language	java
theme	Confluence

AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("GETFAVOURITESDELGEOPACK");

You can specify the user to fetch their favourite reportsSpecify which geopack to remove from the cache, by providing its UUID through a Parameters element:

Code Block

language	java

AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(aprsr.setParameters(new String[] { "db1cf6f7-3561-45a0-b6bc-ff7b94117741" } );

Once the request is configured, perform the call:
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.

The response will contain the StatusCode, Person and Reports parameters. (See details in the Response Parameter Parameters table above for details on these..)

Complete Example

Below is a full example of this web service call. To use it for yourself, carry out the following the steps:

Copy the code and save it as ws_ getfavouritesdelgeopack.jsp.
Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
Adjust the host, port, and admin user details according to your environment.
Run http://<host>:<port>/ws_ getfavouritesdelgeopack.jsp from your Internet browser.

Code Block

language	java
theme	Eclipse

<%        	
/*          	ws_getfavouritesdelgeopack.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.*" %>
<% 
AdministrationServiceResponse rs = null;
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceService s_admts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);    	// adjust host and port number
AdministrationServiceSoapBindingStub adminServicerssbs = (AdministrationServiceSoapBindingStub) s_admts.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");      		// provide your Yellowfin web services admin account
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELGEOPACK");
rsr.setParameters(new String[]                          // set to the password of the account above
rsr.setOrgId(1);
rsr.setFunction("GETFAVOURITES");
 
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
 
rsr.setPerson(ap);
 
AdministrationServiceResponse rs = adminService{ "db1cf6f7-3561-45a0-b6bc-ff7b94117741" } );
    
rs = rssbs.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
	    out.write("<br>SuccessSuccess");
} else {
  AdministrationReport[] reports = rsout.getReportswrite("Failure");
    if (reports != null)
    	for(AdministrationReport r: reports){
			out.write("<br>Report Name: " + r.getReportName());
        }
} else {
	out.write("Failure");
	out.write(" Code: " + rs.getErrorCode());
}
%>

Expand

title	GETINBOX

out.write(rs.toString());
}

Anchor

	dashboardCache
	dashboardCache

Expand

title	REFRESH_DASHBOARD_CACHED_FILTERS

This web service is used to refresh cached filters associated with a particular dashboard. The dashboard is specified by providing its ID or UUIDThis returns a specified user's inbox reports. These are reports which have been distributed to the user.

Request Parameters

The following parameters should be passed with this request:

Request Element	Data Type	Description
LoginId	String	An admin account to connect to Yellowfin web services. This can be the user ID or the email address, depending on the Logon ID method. This 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.
Function	String	Web service function. Set this to "GETINBOXREFRESH_DASHBOARD_CACHED_FILTERS".
PersonParameters	AdministrationPerson	This object contains details of the user. See table below.

Anchor

getinboxap

String[]

Array string containing the ID or UUID of the dashboard whose cached filters are to be removed. Note that only the first parameter in the array is used.

Response Parameters

The returned response will contain these parameters:

Response

getinboxap

These are the main parameters that you must set in the AdministrationPerson object for this web service call:

UserIdID user whose inbox reports are to be fetched. This value could be the user ID or user's email address, depending on the Logon ID method.

AdministrationPerson Element	Data Type	Description
StatusCode	String	Status of the

Request Example

Below is a SOAP XML example for this request:

web service call. Possible values include:

SUCCESS
FAILURE

Instructions

See below for step-by-step instructions on how to perform this call, using a Java example:

Expand

title	Step-by-step instructions

Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

Code Block

language	java
theme	Confluence

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

rsr.setFunction("REFRESH_DASHBOARD_CACHED_FILTERS");

Specify the dashboard UUID by using the parameters element.
Code Block
language java
rsr.setParameters(new String[] { "61209" });

Once the request is configured, perform the call:
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.

The response will contain the StatusCode. (See details in the Response Parameters table above.)

Complete Example

Below is a full example of this web service call. To use it for yourself, carry out the following the steps:

Copy the code and save it as ws_refreshdashboardfilters.jsp.
Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
Adjust the host, port, and admin user details according to your environment.
Run http://<host>:<port>/ws_refreshdashboardfilters.jsp from your Internet browser.

Code Block

language	java
theme	Eclipse

<%   	
/*    	ws_refreshdashboardfilters.jsp

Code Block

language	xml
theme	Confluence

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall> 
         <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1<	*/orgId>
%>
<%@ page           <function>GETINBOX</function>         
            <person>
            	<userId>admin@yellowfin.com.au</userId>
            </person>   
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>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.*" %>
 
AdministrationServiceResponse rs = null;
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();

rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("REFRESH_DASHBOARD_CACHED_FILTERS");
    
// Provide the Dashboard UUID
rsr.setParameters(new String[] { "61209" });
    
rs = rssbs.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode())) {
    out.write("Success");
} else {
    out.write(rs.getStatusCode());
    out.write(rs.toString());
}

Anchor

	viewCache
	viewCache

Expand

title	REFRESH_VIEW_CACHED_FILTERS

This web service is used to refresh cached filters associated with a particular view. The view is specified by providing its ID or UUID.

Request Parameters

The following parameters should be passed with this request:

Request Element	Data Type	Description
LoginId	String	An admin account to connect to Yellowfin web services. This can be the user ID or the email address, depending on the Logon ID method. This 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.
Function	String	Web service function. Set this to "REFRESH_VIEW_CACHED_FILTERS".
Parameters	String[]	Array string containing the ID or UUID of the view whose cached filters are to be removed. Note that only the first parameter in the array is used.

Response Parameters

The returned response will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Instructions

See below for step-by-step instructions on how to perform this call, using a Java example:

Expand

title	Step-by-step instructions

Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

Code Block

language	java
theme	Confluence

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

rsr.setFunction("REFRESH_VIEW_CACHED_FILTERS");

Specify the view UUID by using the Parameters element.
Code Block
language java
rsr.setParameters(new String[] { "61209" });

Once the request is configured, perform the call:
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.

The response will contain the StatusCode. (See details in the Response Parameters table above.)

Complete Example

Below is a full example of this web service call. To use it for yourself, carry out the following the steps:

Copy the code and save it as ws_refreshviewfilters.jsp.
Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
Adjust the host, port, and admin user details according to your environment.
Run http://<host>:<port>/ws_refreshviewfilters.jsp from your Internet browser.

Code Block

language	java
theme	Eclipse

<%   	
/*    	ws_refreshviewfilters.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.*" %>
 
AdministrationServiceResponse rs = null;
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();

rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(new Integer(1));
rsr.setFunction("REFRESH_VIEW_CACHED_FILTERS");
    
// Provide the View UUID
rsr.setParameters(new String[] { "61209" });
    
rs = rssbs.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode())) {
    out.write("Success");
} else {
    out.write(rs.getStatusCode());
    out.write(rs.toString());
}

Anchor

	refreshsourcefilters
	refreshsourcefilters

Expand

title	REFRESH_SOURCE_FILTERS

This service refreshes all access source filters for the specified data source connection.

Request Parameters

The following parameters should be passed with this request:

Request Element	Data Type	Description
LoginId	String	An admin account to connect to Yellowfin web services. This can be the user ID or the email address, depending on the Logon ID method. This 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.
Function	String	Web service function. Set this to "REFRESH_SOURCE_FILTERS".
Parameters	String[]	The function requires only one string as a parameter, which is the target source ID. You can find this value in the reportviewsource table of the SourceId column.

Request Example

Below is a SOAP XML example for this request:

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:remoteAdministrationCall>
     	<arg0>

Response Parameters

The returned response will contain the following parameter:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Person

AdministrationPerson

Full details of the user.

Reports

AdministrationReports[]

An array of the user's inbox reports.

Response Example

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

Code Block

language	xml
theme	Confluence

 <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Getting user information...</messages>
            <messages>Getting user information...</messages>
            <messages>Web Service Request Complete</messages>
            <person>
               <emailAddress>admin@yellowfin.com.au</emailAddress>
               <firstName>System</firstName>
               <initial/>
               <ipId>5</ipId>
               <languageCode>EN</languageCode>
               <lastName>Administrator</lastName>
               <roleCode>YFADMIN</roleCode>
               <salutationCode/>
               <status>ACTIVE</status>
               <timeZoneCode>AUSTRALIA/SYDNEY</timeZoneCode>
               <userId>admin@yellowfin.com.au</userId>
            </person>
            <reports>
               <authoringMode>JAVA</authoringMode><loginId>admin@yellowfin.com.au</loginId>
               <averageRunTime>0</averageRunTime><password>test</password>
               <birtData/>	<orgId>1</orgId>
               <chartTypeCode/><function>REFRESH_SOURCE_FILTERS</function>
               <dashboardEnabled>true</dashboardEnabled><parameters>54700</parameters>
       	</arg0>
        <dataOutput>COLUMN</dataOutput>	</web:remoteAdministrationCall>
               <deliveryMode>DISTRIBUTE</deliveryMode>
               <executionObject/</soapenv:Body>
</soapenv:Envelope>

Response Parameters

The returned response will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

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:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
     	<return>
          <lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>  <errorCode>0</errorCode>
        	<messages>Successfully Authenticated      <lastModifierId>5</lastModifierId>User: admin@yellowfin.com.au</messages>
  	      <messages>Web Service      <lastModifierName>System Administrator</lastModifierName>Request Complete</messages>
               <lastRunTime>0</lastRunTime><sessionId>13143fc20f2d7eeb52ec27f588a9942f</sessionId>
               <publishDate>2016-11-17T00:00:00+11:00</publishDate><statusCode>SUCCESS</statusCode>
               <reportCategory>Tutorial</reportCategory>	</return>
               <reportDescription>Look at the number of athletes by age, region, and average camp rating.</reportDescription></ns2:remoteAdministrationCallResponse>
               <reportId>61053</reportId>
               <reportName>Profitability by Customer Age &amp; Location Breakdown</reportName>
               <reportSubCategory>Marketing &amp; Booking</reportSubCategory>
               <reportTemplate>CHART</reportTemplate>
               <reportUUID>c554165d-7c85-4d19-b19a-61ce5919dc5b</reportUUID></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

Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

Code Block

language	java
theme	Confluence

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

rsr.setFunction("REFRESH_SOURCE_FILTERS");

Specify the data source by its source ID number to remove its definition from the cache:
Code Block
language java
rsr.setParameters(new String[] {"54700"});

Once the request is configured, perform the call:
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.

Add the following check to retrieve the response, containing the StatusCode.
Code Block
language java
if ("SUCCESS".equals(rs.getStatusCode()) ) {

<roleCode>OPERATIONAL</roleCode>

	out.write("<br>Success");

} else {

	out.write("<br>Failure");
              	out.write(" Code: " + rs.getErrorCode());
}

Complete Example

Below is a full example of this web service call. To use it for yourself, carry out the following the steps:

Copy the code and save it as ws_refresh_source_filters.jsp.
Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
Adjust the host, port, and admin user details according to your environment.
Run http://<host>:<port>/ws_refresh_source_filters.jsp from your Internet browser.

Code Block

language	java
theme	Eclipse

<%        	
/* <viewName>New View</viewName>
            </reports>
            <reports>
               <authoringMode>JAVA</authoringMode>
               <averageRunTime>0</averageRunTime>
	ws_refresh_source_filters.jsp               <birtData/>
               <chartTypeCode/>
               <dashboardEnabled>true</dashboardEnabled>
               <dataOutput>COLUMN</dataOutput>
               <deliveryMode>DISTRIBUTE</deliveryMode>
	*/
%>
<%@ 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.*" %>
<%
 
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);    	// adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");      	// provide your Yellowfin web services admin account
rsr.setPassword("test");      <executionObject/>
                  <lastModifiedDate>2017-06-26T00:00:00+10:00</lastModifiedDate>
               <lastModifierId>5</lastModifierId>
    // set to the password of the account above
rsr.setOrgId(1);
rsr.setFunction("REFRESH_SOURCE_FILTERS");
 
rsr.setParameters(new String[] {"54700"});
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
           <lastModifierName>System Administrator</lastModifierName>   	out.write("<br>Success");
               <lastRunTime>0</lastRunTime>	
}
else {
               <publishDate>2016-11-17T00:00:00+11:00</publishDate>
	out.write("<br>Failure");
              	out.write("  <reportCategory>Tutorial</reportCategory>
               <reportDescription>Look at the number of athletes by age, region, and average camp rating.</reportDescription>
               <reportId>61053</reportId>
               <reportName>Profitability by Customer Age &amp; Location Breakdown</reportName>
Code: " + rs.getErrorCode());
}               <reportSubCategory>Marketing &amp; Booking</reportSubCategory>
               <reportTemplate>CHART</reportTemplate>
               <reportUUID>c554165d-7c85-4d19-b19a-61ce5919dc5b</reportUUID>
               <roleCode>OPERATIONAL</roleCode>
               <sourceName/>
               <usage>25</usage>
               <viewDescription>Ski Team</viewDescription>
               <viewId>70103</viewId>
               <viewName>New View</viewName>
            </reports>
            <sessionId>76a9a9f93246f29678744bf60727943f</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>

Instructions

See below for step-by-step instructions on how to perform this call, using a Java example:

%>

Anchor

	reloadcodes
	reloadcodes

expand

Expand

title	RELOADCODES

This web service will reload the specified Org Reference Codes within Yellowfin.

Request Parameters

The following parameters should be passed with this request:

Request Element	Data Type	Description
LoginId	String	An admin account to connect to Yellowfin web services. This can be the user ID or the email address, depending on the Logon ID method. This 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.
Function	String	Web service function. Set this to "RELOADCODES".
Parameters	String[]	Array of Org reference codes to refresh. Following are some of the options and their descriptions: NAME: Use this option to reload the organization names. PARAMETER: This option reloads prganization Parameters, including system configurations, custom parameters, and date periods. REFCODE: Reloads Org Ref Codes. ROLEFN: Reloads functions and role definitions. ORGRELATIONSHIPS: Reloads organization relationships, including 'Client Reference ID to Org ID' mappings.

Response Parameters

The returned response will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Instructions

See below for step-by-step instructions on how to perform this call, using a Java example:

Expand

title	Step-by-step instructions

Define the

Expand

title	Step-by-step instructions

Start with a basic request for this function, which includes logging in as the admin user and specifying the web service call to perform:

Code Block

language	java
theme	Confluence

AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("GETINBOXRELOADCODES");

You can specify the user to fetch their favourite reportsSpecify the Org reference codes that you need to reload into Yellowfin:

Code Block

language	java

AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(aprsr.setParameters(new String[] {
    "ADDRESS", "HIERARCHY", "NAME", "PARAMETER", "REFCODE", "ROLEFN", "ORGRELATIONSHIPS"
});

Once the request is configured, perform the call:
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.

The response will contain the StatusCode, Person and Reports parameters. (See details in the Response Parameter Parameters table above for details on these.)

Complete Example

Below is a full example of this web service call. To use it for yourself, carry out the following the steps:

Copy the code and save it as ws_ getinboxreloadcodes.jsp.
Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
Adjust the host, port, and admin user details according to your environment.
Run http://<host>:<port>/ws_ getinboxreloadcodes.jsp from your Internet browser.

Code Block

language	java
theme	Eclipse

<%        	
/*          	ws_getinboxreloadcodes.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.*" %>
<%
AdministrationServiceService s_adm 
	AdministrationServiceResponse rs = null;
    AdministrationServiceRequest rsr = new AdministrationServiceServiceLocator(AdministrationServiceRequest();
    AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080, "/services/AdministrationService", false);
    	// adjust host and port number
AdministrationServiceSoapBindingStub adminServicerssbs = (AdministrationServiceSoapBindingStub) s_admts.getAdministrationService();

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
  	// provide your Yellowfin web services admin account
rsr.setPassword("test");rsr.setOrgId(new Integer(1));
    rsr.setFunction("RELOADCODES");
    
    rsr.setParameters(new String[] {
            "ADDRESS",  // set to the password of the above account
rsr.setOrgId(1);
rsr.setFunction("GETINBOX");
 
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
 
rsr.setPerson(ap);
 
AdministrationServiceResponse"HIERARCHY", "NAME", "PARAMETER", "REFCODE", "ROLEFN", "ORGRELATIONSHIPS"
    });
    
    rs = adminServicerssbs.remoteAdministrationCall(rsr);

    
if ("SUCCESS".equals(rs.getStatusCode()) ) {
	        out.write("<br>SuccessSuccess </br>");
	AdministrationReport[] reports = rs.getReports();
	if (reports != null)
    	for(AdministrationReport r: reports) } else {
        	out.write("<br>Report Name: " + r.getReportNamers.getStatusCode());
        }
} else {
	out.write("Failure"rs.toString());
	out.write(" Code: " + rs.getErrorCode());
}
%>

Anchor

	geometryFlush
	geometryFlush

Expand

title	GEOMETRYFLUSH	title	ISREPORTFAVOURITE

This web service checks whether or not a particular report is marked as a specific user's favourite. Both the user and the report would need to be specified here, the latter by providing the Report ID. This ID can be retrieved from Yellowfin database's Report Header table. You can even use the GETIDFORUUID web service call to retrieve the Report ID.will clear the geometry cache in Yellowfin.

Request Parameters

The following parameters should be passed with this request:

Request Element	Data Type	Description
LoginId	String	An admin account to connect to Yellowfin web services. This can be the user ID or the email address, depending on the Logon ID method. This 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.
Function	String	Web service function. Set this to "ISREPORTFAVOURITEGEOMETRYFLUSH".
PersonParameters	AdministrationPerson	This object contains details of the user. See table below.
ReportId	Integer	The report ID to check whether the report is the user's favourite.

Anchor

isrepfaveap

String[]

IDs of Views from which the geometry objects are cached with.

Response Parameters

The returned response will contain these parameters:

Response

isrepfaveap

These are the main parameters that you must set in the AdministrationPerson object for this web service call:

UserIdID user whose inbox reports are to be fetched. This value could be the user ID or user's email address, depending on the Logon ID method.

AdministrationPerson Element	Data Type	Description
StatusCode	String	Status of the

Request Example

Below is a SOAP XML example for this request

web service call. Possible values include:

SUCCESS
FAILURE

Instructions

See below for step-by-step instructions on how to perform this call, using a Java example:

xml

Expand

title	Step-by-step instructions

Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

Code Block
language

java
theme Confluence

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/"> <soapenv:Header/> <soapenv:Body> <web:remoteAdministrationCall>

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

rsr.setFunction("GEOMETRYFLUSH");

Specify the Views from which to flush geometery objects:
Code Block
language java
rsr.setParameters(new String[] { "70103", "70104" });

Once the request is configured, perform the call:
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.

The response will contain the StatusCode. (See details in the Response Parameters table above.)

Complete Example

Below is a full example of this web service call. To use it for yourself, carry out the following the steps:

Copy the code and save it as ws_geometryflush.jsp.
Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
Adjust the host, port, and admin user details according to your environment.
Run http://<host>:<port>/ws_geometryflush.jsp from your Internet browser.

Code Block

language	java
theme	Eclipse

<%   	
/*    	ws_geometryflush.jsp       <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            <orgId>1</orgId>
            <function>ISREPORTFAVOURITE</function>
            <reportId>56401</reportId>	*/
%>
<%@ 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.*" %>
 
	AdministrationServiceResponse rs = null;
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();
    AdministrationServiceService ts = new AdministrationServiceServiceLocator("localhost", 8080,   <person>"/services/AdministrationService", false);
    AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();

    	<userId>admin@yellowfin.com.au</userId>rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
    rsr.setFunction("GEOMETRYFLUSH");
    </person>   
	//View IDs from which geometry objects are to be removed
    rsr.setParameters(new String[] {
           </arg0>
    "70103", "70104"
    });
    </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

Response Parameters

The returned response will contain the following parameter:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS - If the specified report is the user's favourite.
FAILURE - If the report is not a favourite report of the user.

Response Example

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

Code Block

language	xml
theme	Confluence

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body> rs = rssbs.remoteAdministrationCall(rsr);

    if ("SUCCESS".equals(rs.getStatusCode())) {
        out.write("Success </br>");
    } else {
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">  out.write(rs.getStatusCode());
         <return>
            <errorCode>0</errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>out.write(rs.toString());
            <messages>Web Service Request Complete</messages>
            <sessionId>ca75c7ebef710e4fc7c6ca6137baa784</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </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

Start with a basic request for this function, which includes logging in as the admin user and specifying the web service call to perform:

Anchor

	removeView
	removeView

Expand

title	REMOVEVIEW

This web service will remove a view's cache in Yellowfin.

Request Parameters

The following parameters should be passed with this request:

Request Element	Data Type	Description
LoginId	String	An admin account to connect to Yellowfin web services. This can be the user ID or the email address, depending on the Logon ID method. This 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.
Function	String	Web service function. Set this to "REMOVEVIEW".
Parameters	String[]	IDs of views whose caches are to be removed.

Response Parameters

The returned response will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

Instructions

See below for step-by-step instructions on how to perform this call, using a Java example:

Code Block

language	java

AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("ISREPORTFAVOURITE");

You can identify the user for whom to check the report's favourite status:

Code Block

language	java

AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap);

Specify which report to check the favourite status for:

Code Block

language	java

rsr.setReportId(61131);

Once the request is configured, perform the call:
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.

The response will contain the StatusCode. See the Response Parameter table above for details on this.

Complete Example

Below is a full example of this web service call. To use it for yourself, carry out the following the steps:

Copy the code and save it as ws_ isreportfavourite.jsp.
Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
Adjust the host, port, and admin user according to your environment.
Run http://<host>:<port>/ws_ isreportfavourite.jsp from your Internet browser.

Expand

title	Step-by-step instructions

Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

Eclipse

Code Block
language java
theme

Confluence

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

rsr.setFunction("REMOVEVIEW");

Specify the Views whose caches are to be removed:
Code Block
language java
rsr.setParameters(new String[] { "70103", "70104" });

Once the request is configured, perform the call:
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.

The response will contain the StatusCode. (See details in the Response Parameters table above.)

Complete Example

Below is a full example of this web service call. To use it for yourself, carry out the following the steps:

Copy the code and save it as ws_removeview.jsp.
Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
Adjust the host, port, and admin user details according to your environment.
Run http://<host>:<port>/ws_removeview.jsp from your Internet browser.

Code Block

language	java
theme	Eclipse

<%   	
/*    	ws_removeview.jsp     	
/*          	ws_isreportfavourite.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.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);    	// adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");      	// provide your Yellowfin web services admin account
rsr.setPassword("test");                     	*/
%>
<%@ page language="java" // set to the password of the account above
rsr.setOrgId(1);
rsr.setFunction("ISREPORTFAVOURITE");
 
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
 
rsr.setPerson(ap);
 
rsr.setReportId(61131);
 
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.*" %>
 
	AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr)null;
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
    AdministrationServiceService ts =    	out.writenew AdministrationServiceServiceLocator("<br>Successlocalhost");
,    8080, "/services/AdministrationService", false);
    AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService();

    rsr.setLoginId("admin@yellowfin.com.au");
    rsr.setPassword("test");
    rsr.setOrgId(new Integer(1));
    rsr.setFunction("REMOVEVIEW");
    
	
} else//View IDs whose caches are to be removed
    rsr.setParameters(new String[] {
              	out.write("Failure");"70103", "70104"
    });
    
    rs = 	outrssbs.write(" Code: " + rs.getErrorCode());
}
%>remoteAdministrationCall(rsr);

    if ("SUCCESS".equals(rs.getStatusCode())) {
        out.write("Success </br>");
    } else {
        out.write(rs.getStatusCode());
        out.write(rs.toString());
    }

Anchor

	flushReport
	flushReport

Expand

title	ADDTOFAVOURITESFLUSHREPORT

Also, ADDTOFAVORITES. This web service call marks will remove a particular report as the specified user's favourite. Both the user and the report would need to be specified here, the latter by providing the report ID. Use the GETIDFORUUID web service call to retrieve the report ID, or fetch it from the database (this value is stored in the Report Header table).cached definitions.

Request Parameters

The following parameters should be passed with this request:

Request Element	Data Type	Description
LoginId	String	An admin account to connect to Yellowfin web services. This can be the user ID or the email address, depending on the Logon ID method. This 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.
Function	String	Web service function. Set this to "ADDTOFAVOURITESFLUSHREPORT" or "ADDTOFAVORITES".
PersonParameters	AdministrationPerson	This object contains details of the user. See table below.
ReportId	Integer	The ID of the report that is to be added as a favourite of the user's.

Anchor

addtofavap

String[]

ID of report to remove its cached definition or metadata. Only the first string will be read, so ensure that it is the report ID.

addtofavap

These are the main parameters that you must set in the AdministrationPerson object for this web service call:

AdministrationPerson Element	Data Type	Description
UserId	String	ID of the user to add the report as their favourite. This value could be the user ID or user's email address, depending on the Logon ID method.

Request Example

Below is a SOAP XML example for this request:

Code Block

language	xml
theme	Confluence

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      	<web:remoteAdministrationCall> 
         	<arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <password>test</password>
            	<orgId>1</orgId>
            <function>ADDTOFAVOURITES<	<function>FLUSHREPORT</function>
            <reportId>56401</reportId>
        	<parameters>65254</parameters>
    <person>
            	<userId>admin@yellowfin.com.au</userId>
            </person>   
         </arg0>
      	</web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

Response Parameters

The returned response will contain the following parameterthese parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS - if the report is added as the user's favourite.
FAILURE - if the report is not added as the user's favourite.

Response Example

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

Code Block

theme

language	xml		Confluence

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      	<ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
         	<return>
            <errorCode>0</errorCode>
            	<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            	<messages>Web Service Request Complete</messages>
            <sessionId>cf897244c65ceecd6c4c39e8ab8c4fcb<<sessionId>5a29f6eaf3ee084b00c76da124f31fe0</sessionId>
            <statusCode>SUCCESS</statusCode>
         	</return>
      	</ns2:remoteAdministrationCallResponse>
   </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

Start with a basic Define the request for this function, which includes logging in as the admin user and specifying the web service call to perform:

Code Block

language	java
theme	Confluence

AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("ADDTOFAVOURITESFLUSHREPORT");

You can identify the user for whom to check the report's favourite statusSpecify the report by its ID to remove its definition from the cache:
Code Block
language java
AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test.user@yellowfin.com.au"); rsr.setPerson(ap);
Specify which report to check the favourite status for:
Code Block
language java
rsr.setReportId(61131);
rsr.setParameters(new String[] { "56401" });

Once the request is configured, perform the call:
Code Block
language java
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.

The response will contain Add the following check to retrieve the response, containing the StatusCode. See the Response Parameter table above for details on this.

Complete Example

Code Block

language	java

 if ("SUCCESS".equals(rs.getStatusCode()) ) {
              	out.write("<br>Success");
              	
}
else {
              	out.write("<br>Failure");
              	out.write(" Code: " + rs.getErrorCode());
}

Complete Example

Below is a full example of this web service call. To use it for yourselfBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:

Copy the code and save it as ws_ addtofavouritesflushreport.jsp.
Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
Adjust the host, port, and admin user details according to your environment.
Run http://<host>:<port>/ws_ addtofavouritesflushreport.jsp from your Internet browser.

Code Block

language	java
theme	Eclipse

/*  <%        	
/*          	ws_addtofavouritesFLUSHREPORT.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.*" %>
<%
 
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false);    	// adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
 
rsr.setLoginId("admin@yellowfin.com.au");      	// provide your Yellowfin webservices admin account
rsr.setPassword("test");                                                    	// changeset to be the password of the account above
rsr.setOrgId(1);
rsr.setFunction("ADDTOFAVORITESFLUSHREPORT");
 
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au"rsr.setParameters(new String[] {"65254"});
 
rsr.setPerson(ap);
 
rsr.setReportId(56361);
 
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
 
if ("SUCCESS".equals(rs.getStatusCode()) ) {
              	out.write("<br>Success");
                    	
}
else {
            	
} else {
	out.write("Failure<br>Failure");
	out.write(" Code: " +               	out.write(" Code: " + rs.getErrorCode());
}             	
%>

Anchor

	flushTab
	flushTab

Expand

title	REMOVEFAVOURITEFLUSHTAB

Also, REMOVEFAVORITE. This web service call removes a particular report from the specified user's favourite list. Both the user and the report would need to be specified here, the latter by providing the report ID. Use the GETIDFORUUID web service call to retrieve the report ID, or fetch it from the database (this value is stored in the Report Header table)will remove a dashboard tab's cached definitions in Yellowfin.

Request Parameters

The following parameters should be passed with this request:

Request Element	Data Type	Description
LoginId	String	An admin account to connect to Yellowfin web services. This can be the user ID or the email address, depending on the Logon ID method. This 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.
Function	String	Web service function. Set this to "REMOVEFAVOURITE" or "REMOVEFAVORITEFLUSHTAB".
Person	AdministrationPerson	This object contains details of the user. See table below.
ReportId	Integer	The ID of the report that is to be removed from the user's favourite list.

Anchor

removefavap

Parameters

String[]

ID of dashboard tab to remove its cached definition or metadata. Only the first string is read, which should contain this ID.

These are the main parameters that you must set in the AdministrationPerson object for this web service call:

Request Example

Response Parameters

Response Example

Instructions

See below for step-by-step instructions on how to perform this call, using a Java example:

Complete Example

Complete Example

Below is a full example of this web service call. To Below is a full example of this web service call. To use it for yourself, carry out the following the steps:

PersonFavourite Element	Data Type	Description
PersonId	Integer	A mandatory parameter to identify the user with their internal ID (that is, the IP ID). The items selected will be added as this user's favourite.
ContentType	String	This mandatory parameter is used to specify the content type of the item to be added as favourite. Possible values include: REPORT REPORTGROUP DISCUSSIONGROUP REPORTVIEW STORYBOARD IMAGE
ContentId	Integer	This mandatory parameter is used to define the item that is to be marked as the user's favourite by providing its internal ID.
FavouriteType	String
CreationCode	String
TextEntityId	Integer	This parameter is required if a comment is to be flagged.

PersonFavourite Element	Data Type	Description
PersonId	Integer	A mandatory parameter to identify the user with their internal ID (that is, the IP ID). The items selected will be removed as this user's favourite.
ContentType	String	This mandatory parameter is used to specify the content type of the item to be removed as favourite. Possible values include: REPORT REPORTGROUP DISCUSSIONGROUP REPORTVIEW STORYBOARD IMAGE
ContentId	Integer	This mandatory parameter is used to define the item that is to be marked as the user's favourite by providing its internal ID.
FavouriteType	String	This is required to remove reports or dashboards as the user's favourite.
CreationCode	String
TextEntityId	Integer	This parameter is required if a comment is to be unflagged.

Content

Space Tools

Page History

Versions Compared

Old Version 9

New Version Current

Key

Request Parameters

Request Example

Request Example

Response Parameters

Response Example

Instructions

Complete Example

Request Parameters

Response Parameters

Instructions

Complete Example

Request Parameters

Request Example

Response Parameters

Response Example

Instructions

Complete Example

Request Parameters

Response Parameters

Request Example

Instructions

Complete Example

Request Parameters

Response Parameters

Instructions

Complete Example

Request Parameters

Request Example

Response Parameters

Response Example

Response Parameters

Response Example

Instructions

Complete Example

Instructions

Request Parameters

Response Parameters

Instructions

Complete Example

Request Parameters

Response Parameters

Request Example

Instructions

Complete Example

Response Parameters

Response Example

Instructions

Request Parameters

Response Parameters

Instructions

Complete Example

Complete Example

Request Parameters

Request Example

Response Parameters

Response Example

Instructions

Complete Example

Complete Example

Request Parameters

Request Example

Response Parameters

Response Example

Instructions

Complete Example

Complete Example

Request Parameters

Request Parameters

Request Example

Request Example

Response Parameters

Response Example

Instructions