Page History

This function creates a new role and/or updates the role functions. The request must contain an AdministrationRole object to specify the role details, and also an array of AdministrationFunction for the role. Whether this function is used to update a role, or create a new one, it should be noted that every Yellowfin role requires one a mandatory function: , Report Access (function code: MIREPORT), MIREPORT access level code must be at least R (read). Each time this function is called, the security functions will be overwritten.

• Displayed below is a basic request for this function:
  
  

  Code Block
  language java
  AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("SAVEROLE");

  
  
  

• Then define a role:

  Code Block
  language java
  AdministrationRole role = new AdministrationRole();

  
  
  

• Role Code is mandatory if you want to modify an existing role:

  Code Block
  language java
  role.setRoleCode("NEWROLE"); // If you want to create a new role, comment this out.

   

  If you do not specify Role Code, the call will create a new role even if another role with the same name already exists.

   

  Tip
  You can get the role

  code

  codes from Yellowfin's database OrgRole table. (Usually, it is based on role name with all letters being capital and no spaces.)

   

   

• Role Name is mandatory even when modifying an existing role, otherwise the call will set the role name to blank:

  Code Block
  language java
  role.setRoleName("New Role"); role.setRoleDescription("testing");

  
  
  

• Each time you call the SAVEROLE function, you need to provide a list of security functions. This call overwrites the role function. For instance, 2 functions will be assigned to the role: Report Access (mandatory) and Activity Stream (optional):

  Code Block
  language java
  AdministrationFunction[] f = new AdministrationFunction[1]; f[0] = new AdministrationFunction(); f[0].setFunctionCode("MIREPORT"); f[0].setAccessLevelCode("R"); f[1] = new AdministrationFunction(); f[1].setFunctionCode("ACTIVITYSTREAM"); f[1].setAccessLevelCode("CRUD");

  Note
  You cannot omit security functions; the call will generate an error otherwise. Click here for all available security function options.

  
  
  

• Then feed the security functions to the role:
  
  
  
  

• 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 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:

1. Copy the code and save it as ws_listroles.jsp.
2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
3. Adjust the host, port, admin user details according to your environment.
4. 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());
}
%>