Page History
Objects belonging to a user in a Primary or Client Organization can be retrieved by using the web service calls defined in this section. These calls are used to retrieve report or dashboard metadata (such as its their name, description, ID, etc.), which is then used to access the report/dashboard by sending links . Then links can be provided to access a selected report/dashboard via Yellowfin application (SSO and Session Options).
...
Retrieving Report Objects
...
Expand | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||
Retrieves report metadata for a specified report ID. Requires user Id and a report Id. User Id should be passed via AdministrationPerson object. Keep in mind that each time when you edit a report, Yellowfin changes the report Id whereas the report UUID is always the same for the report. You can do GETIDFORUUID call to find out what id corresponds to the report UUID at that moment This web service call is used to remove a specified user's access to a client organization. The user and the client org can be identified using the AdministrationPerson and AdministrationClientOrg objects, respectively. This removed user account will remain in the system, even if that user doesn't belong to any other client organizations. To delete that user account from the system, you can use the DELETEUSER call. Or you could even add that user to the default organization by using the ADDUSERACCESS call.
Request ParametersThe following parameters should be passed with this request:
These are the main parameters that you must set in the AdministrationPerson object for this web service call:
| remuserco | remuserco | |||||||||||||||||||||||||||||||||||||||
AdministrationClientOrg Element | Data Type | Description | ClientReferenceID | String | To identify an existing client organization to remove the user from.
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>a30aafab603330389d2bfb5a3e0faae7</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_ removeuseraccess.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user, user whose access is to be removed and the client org. reference ID according to your environment.
- Run http://<host>:<port>/ws_ removeuseraccess.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_removeuseraccess.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 above account rsr.setOrgId(1); rsr.setFunction("REMOVEUSERACCESS"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("admin@yellowfin.com.au"); rsr.setPerson(ap); AdministrationClientOrg ac = new AdministrationClientOrg(); ac.setClientReferenceId("org3"); // must be an existing client org rsr.setClient(ac); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %> |