Page History
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 | ||||
---|---|---|---|---|
|
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
This web service 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 ParametersThe following parameters should be passed with this request:
|
Expand | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||
This web service is used to retrieve users' avatar images. If an avatar image is not set up for a user in Yellowfin, then no image will be retrieved for that user. This service requires the users' internal IDs (that is, their IP ID).
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response 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: Expand | | ||||||||||||||||||||||||||||||||||||||
|
Code Block | ||
---|---|---|
| ||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("GETAVATARS"); |
You can specify the users' IP IDs:
Code Block | ||
---|---|---|
| ||
rsr.setParameters(new String[] {"5","13073"});
|
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 a StatusCode element, along with a BinaryAttachment array.
To get the first image, use the following:
Code Block | ||
---|---|---|
| ||
byte[] data = response.getBinaryAttachments[0].getData();
|
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_ getavatars.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_ getavatars.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<%<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>071e8a40b17160cbc3e55df360cdab11</sessionId> <statusCode>SUCCESS</statusCode> ws_getavatars.jsp </return> *</ns2:remoteAdministrationCallResponse> %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java </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 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 | ||||
---|---|---|---|---|
| ||||
<% /* ws_binarycacheflush.jsp.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> <html> <body> <% 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" contentType="text/html; charset=UTF-8" %> <%@ // set to the password of the above account rsr.setOrgId(1); rsr.setFunction("GETAVATARS"); rsr.setParameters(new String[] {"5","13073"}); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { ReportBinaryObject[] objects = rs.getBinaryAttachments(); if (objects != null) { byte[] data,encodeBase64; String base64Encoded; for(ReportBinaryObject o: objects){ data = o.getData(); if (data != null){ encodeBase64 = java.util.Base64.getEncoder().encode(data); base64Encoded = new String(encodeBase64, "UTF-8"); if (base64Encoded != null) out.write("<br>"); %> <img src="data:image/jpg;base64,<%=base64Encoded%>" alt="No image"> <% } } } } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %> </body> </html> |
title | SETAVATARIMAGE |
---|
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 | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service is used to upload a new licence for the Yellowfin instance. Request ParametersThe following parameters should be passed with this request:
Response ParametersThe returned response 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 web service call. To use it for yourself, carry out the following the steps:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service removes a specified Geopack from the Geopack cache. Note, however, that it does not delete the Geopack from the server. Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
This web service is used to upload an avatar image for a specified user. The image should be an array of bytes in UTF-8 which you could convert to a String value.
Request ParametersThe following parameters should be passed with this request:
Anchor | | setavatarap | setavatarap |
AdministrationPerson Element | Data Type | Description |
---|---|---|
IpId | Integer | Provide the internal Yellowfin IP ID of the user. This value is stored in the Person parameter's IpId field in Yellowfin's database. |
Request Example
Below is a SOAP XML example for this request:
Code Block | ||||
---|---|---|---|---|
| ||||
|
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:
|
Response Example
The service will return the below response, according to our SOAP example:
Code Block | ||||
---|---|---|---|---|
| ||||
|
Instructions
See below for step-by-step instructions on how to perform this call, using a Java example:
title | Step-by-step instructions |
---|
Code Block | ||
---|---|---|
| ||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("SETAVATARIMAGE"); |
You can specify the user by providing their IP ID:
Code Block | ||
---|---|---|
| ||
AdministrationPerson ap = new AdministrationPerson();
ap.setIpId(5);
rsr.setPerson(ap); |
Select the image file, by using the java.nio.file library:
Code Block | ||
---|---|---|
| ||
Path path = Paths.get("D:/TMP/fish.jpg"); // existing image file
byte[] data = Files.readAllBytes(path);
byte[] encodeBase64 = java.util.Base64.getEncoder().encode(data);
String img = new String(encodeBase64, "UTF-8");
rsr.setParameters(new String[] {img}); |
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 a StatusCode element.
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_ setavatarimage.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_ setavatarimage.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_setavatarimage.jsp */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> <%@ page import="java.nio.file.Files" %> <%@ page import="java.nio.file.Paths" %> <%@ page import="java.nio.file.Path" %> <% 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"); <orgId>1</orgId> <function>DELGEOPACK</function> <parameters> <string>db1cf6f7-3561-45a0-b6bc-ff7b94117741</string> // change to be the password of the account above rsr.setOrgId(1); rsr.setFunction("SETAVATARIMAGE"); AdministrationPerson ap = new AdministrationPerson(); ap.setIpId(5); rsr.setPerson(ap); Path path = Paths.get("D:/TMP/fish.jpg"); // existing image file byte[] data = Files.readAllBytes(path); byte[] encodeBase64 = java.util.Base64.getEncoder().encode(data); String img = new String(encodeBase64, "UTF-8"); rsr.setParameters(new String[] {img}); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { </parameters> </arg0> </web:remoteAdministrationCall> </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:
|
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:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/"> <return> <errorCode>0</errorCode> <messages>Successfully out.write("<br>Success"); } else { Authenticated User: admin@yellowfin.com.au</messages> <messages>Web Service Request Complete</messages> out.write("Failure"); <sessionId>9a3871407a758998334a2d780c44f9ae</sessionId> out.write(" Code: " + rs.getErrorCode()); } %> |
...
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
| GETFAVOURITES |
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
This web service call returns all reports marked as favourite by a specific user.
Request ParametersThe following parameters should be passed with this request:
Anchor | | getfaveap | 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 | ||||
---|---|---|---|---|
| ||||
<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> <person> <userId>admin@yellowfin.com.au</userId> </person> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope> */ %> <%@ 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("DELGEOPACK"); rsr.setParameters(new String[] { "db1cf6f7-3561-45a0-b6bc-ff7b94117741" } ); rs = rssbs.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode())) { out.write("Success"); } else { out.write("Failure"); out.write(rs.toString()); } |
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service is used to refresh cached filters associated with a particular dashboard. The dashboard is specified by providing its ID or UUID. Request ParametersThe following parameters should be passed with this request:
Response ParametersThe returned response will contain the following parameter:
Response ParametersThe returned response 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 web service call. To use it for yourself, carry out the following the steps:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 ParametersThe following parameters should be passed with this request:
Response ParametersThe returned response 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 web service call. To use it for yourself, carry out the following the steps:
Response ExampleThe service will return the below response, according to our SOAP example:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This service refreshes all access source filters for the specified data source connection.
Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response 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 web service call. To use it for yourself, carry out the following the steps:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service will reload the specified Org Reference Codes within Yellowfin. Request ParametersThe following parameters should be passed with this request:
Response ParametersThe returned response 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 web service call. To use it for yourself, carry out the following the steps:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service will clear the geometry cache in Yellowfin. Request ParametersThe following parameters should be passed with this request:
Response ParametersThe returned response 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 web service call. To use it for yourself, carry out the following the steps:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service will remove a view's cache in Yellowfin. Request ParametersThe following parameters should be passed with this request:
Response ParametersThe returned response 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 web service call. 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: Expand | | |||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block | ||
---|---|---|
| ||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("GETFAVOURITES"); |
You can specify the user to fetch their favourite reports:
Code Block | ||
---|---|---|
| ||
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("test.user@yellowfin.com.au");
rsr.setPerson(ap); |
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 the Response Parameter table above for details on these.
}
|
Anchor | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service will remove a report's cached definitions. Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Complete ExampleBelow is a full example of this web service call. To use it for yourself, carry out the following the steps:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 web service call. To use it for yourself, carry out the following the steps:
This returns a specified user's inbox reports. These are reports which have been distributed to the user.
Request ParametersThe following parameters should be passed with this request:
Anchor | | getinboxap | getinboxap |
AdministrationPerson Element | Data Type | Description |
---|---|---|
UserId | String | ID of the 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. |
Request Example
Below is a SOAP XML example for this request:
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/"> <soapenv:Header/> <soapenv:Body> <web:remoteAdministrationCall> <arg0> <loginId>admin@yellowfin.com.au</loginId> <password>test</password> <orgId>1</orgId> <function>GETINBOX</function> <person> */ %> <%@ 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 <userId>admin@yellowfin.com.au</userId> admin account rsr.setPassword("test"); </person> <//arg0> set to the password </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:
|
Person | Full details of the user. | |
Reports | An array of the user's inbox reports. |
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> of the account above rsr.setOrgId(1); rsr.setFunction("FLUSHREPORT"); rsr.setParameters(new String[] {"65254"}); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/"> out.write("<br>Success"); <return> } else { <errorCode>0</errorCode> out.write("<br>Failure"); <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> out.write(" Code: " + rs.getErrorCode()); } %> |
Anchor | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service will remove a dashboard tab's cached definitions in Yellowfin. Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response 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 web service call. To use it for yourself, carry out the following the steps:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service will remove a person's cached details. Request ParametersThe following parameters should be passed with this request:
Request ExampleBelow is a SOAP XML example for this request:
Response ParametersThe returned response 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:
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 web service call. To use it for yourself, carry out the following the steps:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 reload a licence in Yellowfin. Request ParametersThe following parameters should be passed with this request:
Anchor | | isrepfaveap | isrepfaveap | These are the main parameters that you must
set |
this to 1. | ||
Function | String | Web service function. Set this to "RELOADLICENCE". |
Request Example
The following SOAP XML example shows how perform this request with the mandatory parameters
AdministrationPerson Element | Data Type | Description |
---|---|---|
UserId | String | ID of the 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. |
Request Example
Below is a SOAP XML example for this request:
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/"> <soapenv:Header/> <soapenv:Body> <web:remoteAdministrationCall> <arg0> <loginId>admin@yellowfin.com.au</loginId> <password>test</password> <orgId>1</orgId> <function>ISREPORTFAVOURITE</function> <reportId>56401</reportId> <person> <function>RELOADLICENCE</function> <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:
|
Response Example
The service will return the below response, according to our SOAP following SOAP XML response will be returned based on our example:
Code Block | ||||
---|---|---|---|---|
| ||||
<S <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>ca75c7ebef710e4fc7c6ca6137baa784<<sessionId>c4d0b6dec61e890a417132f05c3f0fbc</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 | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
|
|
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_ isreportfavouritereloadlicence.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_ isreportfavourite.jsp from your Internet browser.
language | java |
---|---|
theme | Eclipse |
- /ws_reloadlicence.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_reloadlicence.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("RELOADLICENCE"); rs = rssbs.remoteAdministrationCall(rsr); * 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"); // 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); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("<br>SuccessSuccess </br>"); } else { out.write("Failure"(rs.getStatusCode()); out.write(" Code: " + rs.getErrorCodetoString()); } %> |
Anchor | ||
---|---|---|
|
...
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Also, ADDTOFAVORITES. This web service call marks 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). will close the connection pool of a specified data source. Request ParametersThe following parameters should be passed with this request:
Anchor | | addtofavap |
this to "CLOSECONNECTIONPOOL". | ||
Parameters | String[] | ID of the data source whose connection pools are to be closed. |
Request Example
The following SOAP XML example shows how perform this request with the mandatory parameters
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 | ||||
---|---|---|---|---|
| ||||
<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>CLOSECONNECTIONPOOL</function> <reportId>56401</reportId> <person> <parameters>74909</parameters> <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:
|
Response Example
The service will return the below response, according to our SOAP following SOAP XML response will be returned based on our example:
Code Block | ||||
---|---|---|---|---|
| ||||
<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 | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
|
|
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_ addtofavouritescloseconnectionpool.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_ addtofavouritescloseconnectionpool.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_addtofavouritescloseconnectionpool.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 webservicesservices admin account rsr.setPassword("test"); // changeset to be the password of the account above rsr.setOrgId(1); rsr.setFunction("ADDTOFAVORITESCLOSECONNECTIONPOOL"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test.user@yellowfin.com.au"); rsr.setPerson(ap); rsr.setReportId(56361rsr.setParameters(new String[] {"74909"}); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("<br>Success"); } else { } else { out.write("Failure<br>Failure"); out.write(" Code: " + rs.getErrorCode()); } %> |
Anchor |
---|
...
|
...
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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). removes a cached text entity. Request ParametersThe following parameters should be passed with this request:
Anchor | | removefavap |
this to "FLUSHTEXTENTITY". | ||
Parameters | String[] | ID of the text entity that is to be flushed from a cache. (Only the first parameter is read, so ensure it is the text ID.) |
Request Example
The following SOAP XML example shows how perform this request with the mandatory parameters
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 remove the report from their favourite list. 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 | ||||
---|---|---|---|---|
| ||||
<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>REMOVEFAVOURITE</function> <reportId>56401</reportId> <person> <userId>admin@yellowfin.com.au</userId> <function>FLUSHTEXTENTITY</function> </person> <parameters>65254</parameters> </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:
|
Response Example
The service will return the below response, according to our SOAP following SOAP XML response will be returned based on our example:
Code Block | ||||
---|---|---|---|---|
| ||||
<S<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>1be6b980918323dab6f41fec3c040c56</sessionId> <messages>Successfully Authenticated <statusCode>SUCCESS</statusCode>User: admin@yellowfin.com.au</messages> </return> <messages>Web Service Request Complete</messages> </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 | ||
---|---|---|
| ||
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 | | |
|
Code Block | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
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_ removefavourite.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_ removefavourite.jsp from your Internet browser.
<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 | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||
| Eclipse
|
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_flushtextentity.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_flushtextentity.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% ws_removefavourite.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"); /* ws_flushtextentity.jsp // set to the password of the account above rsr.setOrgId(1); rsr.setFunction("REMOVEFAVOURITE"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test.user@yellowfin.com.au"); rsr.setPerson(ap); rsr.setReportId(56361); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("<br>Success"); } else { */ %> <%@ 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"); out.write("Failure"); // change to out.write(" Code: " + rs.getErrorCode()); } %> |
title | LISTPERSONFAVOURITES |
---|
the password of the account above
rsr.setOrgId(1);
rsr.setFunction("FLUSHTEXTENTITY");
rsr.setParameters(new String[] {"65254"});
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("<br>Success");
}
else {
out.write("<br>Failure");
out.write(" Code: " + rs.getErrorCode());
}
%> |
Anchor | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service removes cached filter definitions. Request ParametersThe following parameters should be passed with this request:
This web service call returns a specific user's favourite items, including reports, storyboards, views, dashboards, distributed content, discussions or comments flagged by them.
Request ParametersThe following parameters should be passed with this request:
Anchor | | listfavperson | listfavperson |
PersonFavourite Element | Data Type | Description | PersonId||
---|---|---|---|---|
LoginId | Integer | ID of the user to remove the report from their favourite list. This value could String | An admin account to connect to Yellowfin web services. This can be the user ID or | user's the email address, depending on the Logon ID method. |
ContentType | String | This optional parameter can be set to filter the result by a specific content type. Values could include:
| ||
ContentId | Integer | This optional parameter can be used to restrict the result to a specific content by providing its internal ID. |
Request Example
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 "FLUSHCACHEDFILTERCACHE". |
Parameters | String[] | ID of the filter that is to be flushed from the cache. (Only the first parameter is read, so ensure it is the filter ID.) |
Request Example
The following SOAP XML example shows how perform this request with the mandatory parametersBelow is a SOAP XML example for this request:
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv<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>LISTPERSONFAVOURITES</function> <favourite> <function>FLUSHCACHEDFILTERCACHE</function> <personId>5<<parameters>74909</personId>parameters> </favourite> </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:
|
Personfavourites | An array containing the user's favourite objects. |
call. Possible values include:
|
Response Example
The service will return the below response, according to our SOAP following SOAP XML response will be returned based on our example:
Code Block | ||||
---|---|---|---|---|
| ||||
<S<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> <personfavourites><sessionId>5a29f6eaf3ee084b00c76da124f31fe0</sessionId> <statusCode>SUCCESS</statusCode> <contentId>61209</contentId> </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 | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
|
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_flushcachedfilter.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_flushcachedfilter.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_flushcachedfilter.jsp <contentType>REPORTGROUP</contentType> <creationCode/> <creationDate>2017-06-26</creationDate> <creatorId>0</creatorId> <favouriteType>REPORTDASHBOARD</favouriteType> <message/> <personId>5</personId> <textEntityId>0</textEntityId> </personfavourites> <personfavourites> <contentId>61250</contentId> <contentType>REPORTGROUP</contentType> <creationCode/> <creationDate>2017-06-26</creationDate> <creatorId>0</creatorId> <favouriteType>REPORTDASHBOARD</favouriteType> <message/> <personId>5</personId> <textEntityId>0</textEntityId> </personfavourites> <sessionId>09123071f17afb11be74ca07a6d25aef</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 | ||
---|---|---|
| ||
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 | | |
|
Code Block | ||
---|---|---|
| ||
PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073); |
The following steps are optional, and can be included to filter the response of this call.
To retrieve the user's favourite reports:
Code Block | ||
---|---|---|
| ||
pf.setContentType("REPORT");
pf.setFavouriteType("FAVOURITE"); |
To retrieve all of the user's dashboard:
Code Block | ||
---|---|---|
| ||
pf.setContentType("REPORTGROUP");
pf.setFavouriteType("REPORTDASHBOARD"); |
To retrieve reports and dashboards distributed to the user:
Code Block | ||
---|---|---|
| ||
pf.setContentType("REPORTGROUP"); // use this for dashboards, or pf.setContentType("REPORT") to get distributed reports
pf.setFavouriteType("INBOX"); |
To retrieve discussions that the user is a member of:
Code Block | ||
---|---|---|
| ||
pf.setContentType("DISCUSSIONGROUP");
pf.setFavouriteType("DISCUSSIONMEMBER"); |
To retrieve user's favourite views:
Code Block | ||
---|---|---|
| ||
pf.setContentType("REPORTVIEW"); |
To retrieve user's favourite storyboards:
Code Block | ||
---|---|---|
| ||
pf.setContentType("STORYBOARD");
pf.setFavouriteType("FAVOURITE"); |
To get user's profile image:
Code Block | ||
---|---|---|
| ||
pf.setContentType("IMAGE");
pf.setFavouriteType("PROFILE"); |
To retrieve report comments flagged by the user:
Code Block | ||
---|---|---|
| ||
pf.setContentType("COMMENT");
pf.setFavouriteType("FLAGGED"); |
Add this object to the request:
Code Block | ||
---|---|---|
| ||
rsr.setFavourite(pf); |
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 and PersonFavourites parameters. 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_ listpersonfavourites.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_ listpersonfavourites.jsp from your Internet browser.
setParameters(new String[] {
"12323"
});
rs = rssbs.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode())) {
out.write("Success </br>");
} else {
out.write(rs.getStatusCode());
out.write(rs.toString());
}
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service removes a specified document from the cache.
Request ParametersThe following parameters should be passed with this request:
Request ExampleThe following SOAP XML example shows how perform this request with the mandatory parameters:
Response ParametersThe returned response will contain these parameters:
Response ExampleThe following SOAP XML response will be returned based on our 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 web service call. To use it for yourself, carry out the following the steps:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service refreshes the access levels for a specific content. The content is specified by providing its ID via a parameter element. This could be a Report ID, Dashboard Tab ID, or ETL Process (data transformation flow) UUID. Request ParametersThe following parameters should be passed with this request:
Request ExampleThe following SOAP XML example shows how perform this request with the mandatory parameters:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service call adds an item to a user's favourite list, such as a report, storyboard, view, etc. It also allows a dashboard tab to be added to a user's dashboard, and even flag a comment for a user.
Request ParametersThe following parameters should be passed with this request:
Anchor | | listfavperson | listfavperson |
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:
|
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. |
Request Example
Below is a SOAP XML example for this request:
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/"> <soapenv:Header/> <soapenv:Body> <web:remoteAdministrationCall> <arg0> <loginId>admin@yellowfin.com.au</loginId> <password>test</password> <orgId>1</orgId> <function>SAVEPERSONFAVOURITE</function>> <soapenv:Header/> <soapenv:Body> <web:remoteAdministrationCall> <arg0> <favourite> <loginId>admin@yellowfin.com.au</loginId> <personId>13000<<password>test</personId>password> <contentType>REPORTGROUP<<orgId>1</contentType>orgId> <contentId>61209<<function>REFRESHACLL</contentId>function> </favourite> <parameters>74909</parameters> </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:
|
Response Example
The service will return the below response, according to our SOAP following SOAP XML response will be returned based on our example:
Code Block | ||||
---|---|---|---|---|
| ||||
<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> <messages>Web Service Request <sessionId>6eb0b81605d3b355cf4a43ae608ab274<Complete</sessionId>messages> <statusCode>SUCCESS<<sessionId>fe029927cc6aae20446f1a8caf25e83a</statusCode>sessionId> </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:
title | Step-by-step instructions |
---|
<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:
Code Block | ||
---|---|---|
| ||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("SAVEPERSONFAVOURITE"); |
Identify a user throught the PersonFavourite object:
Code Block | ||
---|---|---|
| ||
PersonFavourite pf = new PersonFavourite();
pf.setPersonId(13073); |
Code Block | ||
---|---|---|
| ||
pf.setContentId(61252);
pf.setContentType("REPORTVIEW"); |
Add this object to the request:
Code Block | ||
---|---|---|
| ||
rsr.setFavourite(pf); |
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 parameter. 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_ savepersonfavourite.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_ savepersonfavourite.jsp from your Internet browser.
Expand | ||
---|---|---|
| ||
|
| Eclipse
|
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_refreshacll.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_refreshacll.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_refreshacll.jsp /* ws_savepersonfavourite.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"); // set to the password of the account above rsr.setOrgId(1); rsr.setFunction("SAVEPERSONFAVOURITE"); PersonFavourite pf = new PersonFavourite(); pf.setPersonId(13073); pf.setContentId(61252); pf.setContentType("REPORTVIEW"); rsr.setFavourite(pf); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("<br>Success"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %> |
*/
%>
<%@ 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("REFRESHACLL");
rsr.setParameters(new String[] {
"70103" });
rs = rssbs.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode())) {
out.write("Success </br>");
} else {
out.write(rs.getStatusCode());
out.write(rs.toString());
}
%> |
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function is used for cluster messaging. It removes content management records from remote caches when such a record is altered or deleted locally. Request ParametersThe following parameters should be passed with this request:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This web service call removes an item or object from a specific user's favourite list, such as a report, storyboard, view, etc. It also allows a dashboard tab to be removed from a user's dashboard, and even unflag a comment flagged by a user.
Request ParametersThe following parameters should be passed with this request:
Anchor | | listfavperson | listfavperson |
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:
|
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. |
Request Example
Below is a SOAP XML example for this request:
Code Block | ||||
---|---|---|---|---|
| ||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/"> <soapenv:Header/> <soapenv:Body> <web:remoteAdministrationCall> <arg0> <loginId>admin@yellowfin.com.au</loginId> <password>test</password> <orgId>1</orgId> <function>REMOVEPERSONFAVOURITE</function> <favourite> <arg0> <personId>13000</personId><loginId>admin@yellowfin.com.au</loginId> <contentType>REPORTGROUP<<password>test</contentType>password> <contentId>61209<<orgId>1</contentId>orgId> <<function>REMOVECONTENTMANAGEMENT</favourite>function> <parameters>73118</parameters> </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:
|
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: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>0cc3673ed857e1e28fb0e326b8f3b24e<<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 | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
|
|
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_ removepersonfavouriteremovecontentmanagement.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_ removepersonfavouriteremovecontentmanagement.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_removepersonfavouriteremovecontentmanagement.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"); // set to the password of the account above rsr.setOrgId(1); rsr.setFunction("REMOVEPERSONFAVOURITEREMOVECONTENTMANAGEMENT"); PersonFavourite pf = new PersonFavourite(); pf.setPersonId(13073); pf.setContentId(70270); pf.setContentType("REPORTVIEW"); rsr.setFavourite(pfrsr.setParameters(new String[] {"73118"}); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("<br>Success"); } else { out.write("Failure<br>Failure"); out.write(" Code: " + rs.getErrorCode()); } %> |