User groups and roles can be created and modified with a web service call. The objects returned in the response is dependent on the type of call made in the request.
Note: If the Client Org functionality is turned on in the Configuration page, a Client Org can also be specified where applicable for certain types of calls.
This function returns all the user roles available in Yellowfin. The response contains an array of AdministrationRole objects representing available roles.
Displayed below is a basic request for this function:
AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("LISTROLES");Once the request is configured, perform the call:
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
Initialize the Administration web service. Click here to learn how to do this.
The response returned will contain these parameters:
Response Element
Data Type
Description
StatusCode
String
Status of the web service call. Possible values include:
- SUCCESS
- FAILURE
Roles
AdministrationRole[]
List of roles
Complete Example
Below is a full example of the LISTROLES function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_listroles.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user details according to your environment.
- Run http://<host>:<port>/ws_listroles.jsp from your Internet browser.
<%
/* ws_listroles.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"); // change to be the password of the account above
rsr.setOrgId(1);
rsr.setFunction("LISTROLES");
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success.<br>Available Roles:");
AdministrationRole[] roles = rs.getRoles();
for (AdministrationRole role: roles){
out.write("<br>");
out.write("<br>Role Name: " + role.getRoleName());
out.write("<br>Role Code: " + role.getRoleCode());
out.write("<br>Role Description: " + role.getRoleDescription());
// uncomment to display all the security functions:
/*
out.write("<br>Function Name | Code | Description | TypeCode | AccessLevelCode");
for (AdministrationFunction f: role.getFunctions()){
out.write("<br>" + f.getFunctionName() + " | "
+ f.getFunctionCode() + " | "
+ f.getFunctionDescription() + " | "
+ f.getFunctionTypeCode() + " | "
+ f.getAccessLevelCode());
}
*/
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%>