Like what you see? Have a play with our trial version.

Versions Compared

Old Version 24

changes.mady.by.user user-3484a

Saved on

compared with

New Version Current

changes.mady.by.user Yellowfin Wiki

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated based on YFN-16875

...

User groups and roles can be created and modified with a the web service call. The objects returned in the response is dependent on the type of call made in the request.calls discussed in this section. 

Note: If the Client Org functionality is switched on in the Configuration page, a Client Org can also be specified where applicable for certain types of calls.


User Role Functions

These web services are specific to Yellowfin user roles.

Note

When using LDAP authentication, any web services that return a role, will return the role that the LDAP user last logged in with successfully. (This role is updated every time an LDAP user logs in.)


Anchor
listroles
listroles

Expand
titleLISTROLES

This function returns all the user roles available in Yellowfin. The response contains an array of AdministrationRole objects displaying available roles.

 


Request Elements

The following elements will be passed with this request:

Request Element

Data Type

Description

LoginId

String

Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.

This Yellowfin 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 services function. Set this to "LISTROLES".

 

 



Request Example

The following SOAP example shows the parameters that you can pass to this call:

Code Block
languagexml
<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>LISTROLES</function>                            
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>
 
 


Response Elements
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
 
 
Instructions
See below for step-by-step instructions on how to perform this call, using a Java example:


Response Elements
The service will return the below response, according to our SOAP example:
 Displayed below is a basic request for this function:
javaOnce the request is configured, perform the call:
 Expand
titleStep-by-step instructions
 Code Block
language
xml
AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("LISTROLES");
 Code Block
languagejava
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.
 
 Code Block
languagejava
<%<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>
            <roles>
/*               ws_listroles.jsp<functions>
                  *<accessLevelCode>CRUD</accessLevelCode>
%>
<%@  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); <functionCode>ACTIVITYSTREAM</functionCode>
               // adjust host and<functionDescription>Allows portusers number
AdministrationServiceSoapBindingStubto adminServiceaccess =the (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();

rsr.setLoginId("admin@yellowfin.com.au");activity stream.</functionDescription>
                  <functionName>Activity Stream</functionName>
   // provide your Yellowfin webservices admin account
rsr.setPassword("test");      </functions>
               <functions>
      // 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());
         <accessLevelCode>CRUD</accessLevelCode>
                  <functionCode>TIMELINE</functionCode>
                  <functionDescription>Allows users to access their timeline.</functionDescription>
                  <functionName>Timeline</functionName>
        
		// 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());
}
%>


 
 
...
</functions>
               <functions>
                  <accessLevelCode>CRUD</accessLevelCode>
                  <functionCode>BROADCASTSUBSCRIBE</functionCode>
                  <functionDescription>Allows users to subscribe to report broadcasts.</functionDescription>
                  <functionName>Subscribe to Broadcast</functionName>
               </functions>
               <functions>
                  <accessLevelCode>R</accessLevelCode>
                  <functionCode>STORYBOARD</functionCode>
                  <functionDescription>Allows users to view, create, edit or delete Storyboards.</functionDescription>
                  <functionName>Storyboard</functionName>
               </functions>
               <functions>
                  <accessLevelCode>R</accessLevelCode>
                  <functionCode>DASHPUBLIC</functionCode>
                  <functionDescription>Allows users to create and edit Public dashboards.</functionDescription>
                  <functionName>Public Dashboards</functionName>
               </functions>
               <functions>
                  <accessLevelCode>CRUD</accessLevelCode>
                  <functionCode>TASKPERSONAL</functionCode>
                  <functionDescription>Allow users to create and assign tasks to themselves.</functionDescription>
                  <functionName>Personal Tasks</functionName>
               </functions>
               .
               .
			   .
               <roleCode>YFADMIN</roleCode>
               <roleDescription>This user has the widest range of access to the system, and as such you should have a very limited number of people assigned this role. They can do everything from create content through to managing system tasks.</roleDescription>
               <roleName>System Administrator</roleName>
            </roles>
            <sessionId>4f86f0e30e30bf4b07dea21267de0a74</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
titleStep-by-step instructions
 
  • Displayed below is a basic request for this function:

     Code Block
    languagejava
    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:

     Code Block
    languagejava
    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.

 Code Block
languagejava
themeEclipse
<%            
/*              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());
}
%>




 Anchor
saverole
saverole
 Expand
titleSAVEROLE
This function creates a new role and/or updates a role's functions. The request must contain an AdministrationRole object to specify the role details, and 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 a mandatory function, Report Access (function code: MIREPORT). MIREPORT must have its access level code set to at least R (read). Each time this function is called, the security functions will be overwritten.

Request Elements
The following elements will be passed with this request:
Request Element
Data Type
Description
LoginId
String
Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.
This Yellowfin 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 services function. Set this to "SAVEROLE".
RoleAdministrationRoleThis object contains details of the role to be added/updated. See table below.

 Anchor
saveroleap
saveroleap
These are the main parameters that you need to set in the AdministrationRole object for this function:
AdministrationRole Element
Data Type
Description
RoleCodeStringTo specify the internal code of an existing role. This parameter must be included if you want to update a role that already exists. If unspecified, a new role will be created, even if one with the same name already exists.
RoleNameStringName of the new or existing role. This is mandatory even when modifying an existing role, otherwise the call will set the role name to blank.
RoleDescriptionStringDescription of the role.
FunctionsAdministrationFunctionThis object contains a list of security functions. These will be overwritten every time the Save Role function is called. The function Report Access is mandatory. See table below for more details.

 Anchor
saveroleaf
saveroleaf
These are the main parameters that you need to set in the AdministrationFunction object for this web service:
AdministrationFunction Element
Data Type
Description
FunctionCodeStringTo specify the code of a security function. For example, to include the function Report Access, specify it with its code MIREPORT.
AccessLevelCodeStringThe access level of the function. For example, R means read.


The following SOAP example shows the parameters that you can pass to this call:
 Code Block
languagexml
 <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>SAVEROLE</function> 
            <role>
            	<roleCode>REPORTWRITER</roleCode>
            	<roleName>Report Content Writer</roleName>
            	<roleDescription>This role can generate reports.</roleDescription>
            	<functions>
            		<functionCode>MIREPORT</functionCode>
            		<accessLevelCode>R</accessLevelCode>
            	</functions>
            </role>                           
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

Response Elements
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

The service will return the below response, according to our SOAP example:
 Code Block
languagexml
<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>
            <roles>
               <functions>
                  <accessLevelCode>R</accessLevelCode>
                  <functionCode>MIREPORT</functionCode>
               </functions>
               <roleCode>REPORTCONTENTWRITER</roleCode>
               <roleDescription>This role can generate reports.</roleDescription>
               <roleName>Report Content Writer</roleName>
            </roles>
            <sessionId>ceaa85d0ca1eb6057dc4facb0a7a5aa9</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
titleStep-by-step instructions
  • Displayed below is a basic request for this function:

     Code Block
    languagejava
    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
    languagejava
    AdministrationRole role = new AdministrationRole();



  • Role Code is mandatory if you want to modify an existing role:
     Code Block
    languagejava
    role.setRoleCode("NEWROLE");			// If you want to create a new role, comment this out.
    If you do not specify the 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 codes from Yellowfin's database OrgRole table. (Usually, it is based on role name with all letters capitalized and with no space between them.)


  • Role Name is mandatory even when modifying an existing role, otherwise the call will set the role name to blank:
     Code Block
    languagejava
    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
    languagejava
    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.


  • Then feed the security functions to the role:
     Code Block
    languagejava
    role.setFunctions(f);
rsr.setRole(role);



  • Once the request is configured, perform the call:

     Code Block
    languagejava
    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



Complete Example
Below is a full example of the SAVEROLE function. To use it for yourself, carry out the following the steps:
  1. Copy the code and save it as ws_saverole.jsp.
  2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
  3. Adjust host, port, admin user details according to your environment.
  4. Run http://<host>:<port>/ws_saverole.jsp from your Internet browser.

 Code Block
languagejava
themeEclipse
<%            
/*              ws_saverole.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");                           // change to the password of the account above
rsr.setOrgId(1);

rsr.setFunction("SAVEROLE");

//define a role:
AdministrationRole role = new AdministrationRole();
role.setRoleCode("NEWROLE");
role.setRoleName("New Role");
role.setRoleDescription("testing");

AdministrationFunction[] f = new AdministrationFunction[2];

f[0] = new AdministrationFunction();
f[0].setFunctionCode("MIREPORT");           // mandatory
f[0].setAccessLevelCode("R");

f[1] = new AdministrationFunction();
f[1].setFunctionCode("ACTIVITYSTREAM");               
f[1].setAccessLevelCode("CRUD");


//Feed the security functions to the role:
role.setFunctions(f);

rsr.setRole(role);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);


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





 Anchor
deleterole
deleterole
 Expand
titleDELETEROLE
This function deletes a specified user role. You can identify this role by providing the Role Code in the AdministrationRole object.
...
 Expand
titleSAVEROLE
This function creates a new role and/or updates a role's functions. The request must contain an AdministrationRole object to specify the role details, and 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 a mandatory function, Report Access (function code: MIREPORT). MIREPORT must have its access level code set to at least R (read). Each time this function is called, the security functions will be overwritten.
 

Request Elements
The following elements will be passed with this request:
This object contains details of the role  be added/updated. See table below.
Request Element
Data Type
Description
LoginId
String
Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.
This Yellowfin 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 services function. Set this to "SAVEROLE".
RoleAdministrationRole
 to 
 
 Anchor
saveroleap
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 services function. Set this to "DELETEROLE".
RoleAdministrationRoleThis object contains details of the role to be deleted. See table below.

 Anchor
delroleap
delroleap
saveroleap
These are the main parameters that you need to set in the AdministrationRole object to create a new Yellowfin role:
AdministrationRole Element
Data Type
Description
RoleCodeStringTo specify the internal code of an existing role. This parameter must be included if you want to update a role that already exists. If unspecified, a new role will be created, even if one with the same name already exists.
RoleNameStringName of the new or existing role. This is mandatory even when modifying an existing role, otherwise the call will set the role name to blank.
RoleDescriptionStringDescription of the role.
FunctionsAdministrationFunctionThis object contains a list of security functions. These will be overwritten every time the Save Role function is called. The function Report Access is mandatory. See table below for more details.
 
 Anchor
saveroleafsaveroleaf
These are the main parameters that you need to set in the AdministrationFunction objectthe AdministrationRole object:
 
AdministrationFunction AdministrationRole Element
Data Type
Description
FunctionCodeRoleCodeString
To specify the internal code of 
 a security function. For example, to include the function Report Access, specify it with its code MIREPORT.
AccessLevelCodeStringThe access level of the function. For example, R means read.
 
an existing role that is to be deleted.


The following SOAP example shows the parameters that you can pass to this call:
 Code Block
languagexml
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
<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>DELETEROLE</function> 
            <role>
            	<roleCode>REPORTWRITER</roleCode>
            </role>                           <web:remoteAdministrationCall>
         <arg0></arg0>
      </web:remoteAdministrationCall>
       <loginId>admin@yellowfin.com.au</loginId>
   </soapenv:Body>
</soapenv:Envelope>

Response Elements
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

The service will return the below response, according to our SOAP example:
 Code Block
languagexml
 <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
         <password>test</password>
            <orgId>1</orgId>
            <function>SAVEROLE</function> <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
            <role><return>
            	<roleCode>REPORTWRITER<<errorCode>0</roleCode>errorCode>
            <messages>Successfully 	<roleName>ReportAuthenticated Content Writer</roleName>User: admin@yellowfin.com.au</messages>
            	<roleDescription>This<messages>Web roleService can generate reports.</roleDescription>Request Complete</messages>
            	<functions><roles>
            		<functionCode>MIREPORT</functionCode>
            		<accessLevelCode>R</accessLevelCode><roleCode>REPORTWRITER</roleCode>
            	</functions>
            </role>   </roles>
            <sessionId>6c494a263bb684c1082317d0e1d695eb</sessionId>
            <statusCode>SUCCESS</statusCode>
         </arg0>return>
      </webns2:remoteAdministrationCall>remoteAdministrationCallResponse>
   </soapenvS:Body>
</soapenvS:Envelope>
 
Response Elements
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
 
The service will return the below response, according to our SOAP example:


Instructions
See below for step-by-step instructions on how to perform this call, using a Java example:
 Expand
titleStep-by-step instructions
 
  • Displayed below is a basic request for this function:

     Code Block
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("DELETEROLE");


  • Define the role that needs to be deleted:

     Code Block
    languagejava
    AdministrationRole role = new AdministrationRole();
role.setRoleCode("NEWROLE");
 Code Block
languagexml
<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>

  •           // existing 
<roles>

  • role. Role Codes can be found by calling LISTROLES
												 // or retrieved from the Yellowfin database table OrgRole.
rsr.setRole(role);



  • Once the request is configured, perform the call:

     Code Block
    languagejava
    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



Complete Example
Below is a full example of the DELETEROLE function. To use it for yourself, carry out the following the steps:
  1. Copy the code and save it as ws_deleterole.jsp.
  2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
  3. Adjust the host, port, admin user, and role code values according to your environment.
  4. Run http://<host>:<port>/ws_deleterole.jsp from your Internet browser.

 Code Block
languagejava
themeEclipse
<%        <functions>
                  <accessLevelCode>R</accessLevelCode>
                  <functionCode>MIREPORT</functionCode>
               </functions>
               <roleCode>REPORTCONTENTWRITER</roleCode>
/*               <roleDescription>This role can generate reports.</roleDescription>
ws_deleterole.jsp               <roleName>Report Content Writer</roleName>
            </roles>
            <sessionId>ceaa85d0ca1eb6057dc4facb0a7a5aa9</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
titleStep-by-step instructions
Displayed below is a basic request for this function:
 Code Block
languagejava
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
languagejava
AdministrationRole role = new AdministrationRole();

  • Role Code is mandatory if you want to modify an existing role:
     Code Block
    languagejava
    role.setRoleCode("NEWROLE");			// If you want to create a new role, comment this out.
    If you do not specify the 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 codes from Yellowfin's database OrgRole table. (Usually, it is based on role name with all letters capitalized and with no space between them.)
     
     
    • Role Name is mandatory even when modifying an existing role, otherwise the call will set the role name to blank:
     Code Block
    languagejava
    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
    languagejava
    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.
    Then feed the security functions to the role:
     Code Block
    languagejava
    role.setFunctions(f);
rsr.setRole(role);

    Once the request is configured, perform the call:
     Code Block
    languagejava
    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
     */
%>
<%@ 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 the password of the above account above
rsr.setOrgId(1);


rsr.setFunction("DELETEROLE");


AdministrationRole role = new AdministrationRole();
role.setRoleCode("NEWROLE");
rsr.setRole(role);

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);


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







    User Group Functions
    Web services related to user groups are defined below:
     Anchor
    listgroups
    listgroups
     Expand
    titleLISTGROUPS
    The LISTGROUPS function returns all the user groups available in Yellowfin. The response contains an array of AdministrationGroup objects representing available groups. For a list of groups belonging to a specific client, you can pass the Client Org reference ID in the call. 

    Request Elements
    The following elements will be passed with this request:
    Request Element
    Data Type
    Description
    LoginId
    String
    Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.
    This Yellowfin 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 services function. Set this to "LISTGROUPS".
    OrgRefStringYou may include a Client Org ID to list groups belonging to a specific client. If this is not specified, then the default organization's groups will be returned.


    The following SOAP example shows the parameters that you can pass to this call:
     Code Block
    languagexml
    <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>

     
     
    Complete Example
    Below is a full example of the SAVEROLE function. To use it for yourself, carry out the following the steps:
    1. Copy the code and save it as ws_saverole.jsp.
    2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
    3. Adjust host, port, admin user details according to your environment.
    4. Run http://<host>:<port>/ws_saverole.jsp from your Internet browser.
     
     Code Block
    languagejava
    <%            
/*              ws_saverole.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");                 <loginId>admin@yellowfin.com.au</loginId>
          // change to<password>test</password>
 the password of the account above
rsr.setOrgId(1);

rsr.setFunction("SAVEROLE");

//define a role:
AdministrationRole role = new AdministrationRole();
role.setRoleCode("NEWROLE");
role.setRoleName("New Role");
role.setRoleDescription("testing");

AdministrationFunction[] f = new AdministrationFunction[2];

f[0] = new AdministrationFunction();
f[0].setFunctionCode("MIREPORT");    <orgId>1</orgId>
            <function>LISTGROUPS</function>        // mandatory
f[0].setAccessLevelCode("R");

f[1] = new AdministrationFunction();
f[1].setFunctionCode("ACTIVITYSTREAM");               
f[1].setAccessLevelCode("CRUD");


//Feed the security functions to the role:
role.setFunctions(f);

rsr.setRole(role);
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);


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



     
     
    ...
     </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>


    Response Elements
    The response returned will contain these parameters:
    Response 
    ...
    These are the main parameters that you need to set in the AdministrationRole object:
     Expand
    titleDELETEROLE
    This function deletes a specified user role. You can identify this role by providing the Role Code in the AdministrationRole object.
     
    Request Elements
    The following elements will be passed with this request:
    Request Element
    Data Type
    Description
    LoginId
    String
    Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.
    This Yellowfin 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 services function. Set this to "DELETEROLE".
    RoleAdministrationRoleThis object contains details of the role to be deleted. See table below.
     
     Anchor
    delroleapdelroleap
    AdministrationRole Element
    Data Type
    Description
    RoleCode
    StatusCode
    String
    To specify the internal code of an existing role that is to be deleted.
     
     
    Status of the web service call. Possible values include:
    • SUCCESS
    • FAILURE
    Groups
    AdministrationGroup[]
    List of groups

    The service will return the below response, according to our SOAP exampleThe following SOAP example shows the parameters that you can pass to this call:
     Code Block
    languagexml
    <soapenv <S:Envelope xmlns:soapenvS="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:webns2="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
   <return>
   <web:remoteAdministrationCall>
         <arg0><errorCode>0</errorCode>
            <loginId>admin@yellowfin.com.au</loginId><groups>
            <password>test</password>
   <groupDescription>This group contains all users with the Admin  <orgId>1</orgId>
role.</groupDescription>
             <function>DELETEROLE</function> 
  <groupId>11950</groupId>
               <role><groupMembers>
            	<roleCode>REPORTWRITER</roleCode>      <internalId>5</internalId>
            </role>      <loginId>admin@yellowfin.com.au</loginId>
               </groupMembers>
       
         </arg0><groupMembers>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>
     
    Response Elements
    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
     
    The service will return the below response, according to our SOAP example:
     Code Block
    languagexml
     <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/"><internalId>13000</internalId>
         <return>
            <errorCode>0</errorCode><loginId>binish.sheikh@yellowfin.com.au</loginId>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> </groupMembers>
            <messages>Web Service Request Complete<<groupName>Administrators</messages>groupName>
            <roles></groups>
            <messages>Successfully Authenticated  <roleCode>REPORTWRITER</roleCode>
User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request <Complete</roles>messages>
            <sessionId>6c494a263bb684c1082317d0e1d695eb<<sessionId>79d937ead121745d93289f287d55b0ac</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
    titleStep-by-step instructions
     
    • Displayed below is a basic request for this function:

       Code Block
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("DELETEROLE");
      Define the role that needs to be deleted:
       Code Block
      languagejava
      AdministrationRole role = new AdministrationRole();
role.setRoleCode("NEWROLE");                     // existing role. Role Codes can be found by calling LISTROLES
												 // or retrieved from the Yellowfin database table OrgRole.
rsr.setRole(role);

     
    • ");
rsr.setPassword("test");
rsr.setOrgId(1);

rsr.setFunction("LISTGROUPS");


    • Include a Client Org ID to list groups specific to that client. (If not included, then the default (that is, the Primary Org) groups will be displayed).
       Code Block
      languagejava
      rsr.setOrgRef("org1");



    • Once the request is configured, perform the call:

       Code Block
      languagejava
      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
     
     
    • Groups
      AdministrationGroup[]
      List of groups

    • You can retrieve members of each group by using AdministrationGroup.getGroupMembers(). This will retrieve an array of AdministrationGroupMember. Keep in mind that if the group has a user role as a member, it will not be retrieved. Only user accounts will be retrieved via getGroupMembers().



    Complete Example
    Below is a full example of the DELETEROLE LISTGROUPS function. To use it for yourself, carry out the following the steps:
    1. Copy the code and save it as ws_deleterolelistgroups.jsp.
    2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
    3. Adjust the host, port, admin user , and role code values details according to your environment.
    4. Run http://<host>:<port>/ws_deleterolelistgroups.jsp from your Internet browser.
     

     Code Block
    languagejava
    themeEclipse
    <%            
/*              ws_deleterolelistgroups.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");                           // change to the password of the above account
rsr.setOrgId(1);

rsr.setFunction("LISTGROUPS");

//rsr.setOrgRef("org1");                    	   // change to the password of the above account above
rsr.setOrgId(1);


rsr.setFunction("DELETEROLE");


AdministrationRole role = new AdministrationRole();
role.setRoleCode("NEWROLE");
rsr.setRole(role);

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);


if ("SUCCESS".equals(rs.getStatusCode()) ) {
	out.write("Success"); provide org reference if required. Default org groups will be retrieved otherwise


AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode()) ) {
	out.write("Success.<br>Available Groups:");
	AdministrationGroup[] groups = rs.getGroups();
	for (AdministrationGroup group: groups){
		out.write("<br>");
		out.write("<br>Group Name: " + group.getGroupName());
		out.write("<br>Group Id: " + group.getGroupId());
		out.write("<br>Group Description: " + group.getGroupDescription());
		out.write("<br>Group Status: " + group.getGroupStatus());
		out.write("<br>Group Internal Reference: " + group.getGroupInternalReference());


		// uncomment to display the members:
		/*
		out.write("<br>Members:<br>Login Id | Internal Id ");
		for (AdministrationGroupMember member: group.getGroupMembers()){
			out.write("<br>" + member.getLoginId() + " | " + member.getInternalId() );
		}
		*/
	}
} else {
	out.write("Failure");
	out.write(" Code: " + rs.getErrorCode());
}
%>



     
     


     Anchor
    listgroupsgetgrouplistgroups
    getgroup
     Expand
    titleLISTGROUPSGETGROUP
    Use this function to retrieve a specified user group with its members. Group name must be provided to the request.

    The LISTGROUPS function returns all the user groups available in Yellowfin. The response contains an array of AdministrationGroup objects representing available groups. For a list of groups belonging to a specific client, you can pass the Client Org reference ID in the call. 
     
    Request Elements
    The following elements will be passed with this request:
    Request Element
    Data Type
    Description
    LoginId
    String
    Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.
    This Yellowfin 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 services function. Set this to "LISTGROUPSGETGROUP".
    GroupAdministrationGroupThis object contains details of the user group to be retrieved. See table below.
    OrgRefStringYou may include a Client Org ID to list groups belonging to ID to search for the group within a specific client org. If this is not specified, then the default organization's groups will be returned.
     
     
    searched.

     Anchor
    getgrpap
    getgrpap
    These are the main parameters that you need to set in the AdministrationGroup object for this function:
    AdministrationGroup Element
    Data Type
    Description
    GroupNameString
    Specify name of the user group to retrieve its details and member list.


    The following SOAP example shows the parameters that you can pass to this call:
     Code Block
    languagexml
    <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>LISTGROUPS<<function>GETGROUP</function>
            <group>
            	<groupName>Administrators</groupName>
            </group>                    
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>
     
     


    Response Elements
    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
    GroupsGroup
    AdministrationGroup[]
    List of groups
     
    Group details with a list of its members.

    The service will return the below response, according to our SOAP example:
     Code Block
    languagexml
     <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>
            <groups><group>
               <groupDescription>This group contains all users with the Admin role.</groupDescription>
               <groupId>11950</groupId>
               <groupMembers>
                  <internalId>5</internalId>
                  <loginId>admin@yellowfin.com.au</loginId>
               </groupMembers>
               <groupMembers>
                  <internalId>13000</internalId>
                  <loginId>binish.sheikh@yellowfin.com.au</loginId>
               </groupMembers>
               <groupName>Administrators</groupName>
               <groupStatus>OPEN</groupStatus>
            </groups>group>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>79d937ead121745d93289f287d55b0ac<<sessionId>54c5cf263f323b439c5834d1f6d8b645</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>Envelope> 
     
     

    Instructions
    See below for step-by-step instructions on how to perform this call, using a Java example:
     Expand
    titleStep-by-step instructions
     
    • Displayed below is a basic request for this function:

       Code Block
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("LISTGROUPSGETGROUP");


    • Include a Client Org ID to list groups specific to that client. (If not included, then the default (that is, the Primary Org) groups group will be displayed).displayed).
       Code Block
      languagejava
      rsr.setOrgRef("org1");



    • Provide name of a user group to retrieve its members:

       Code Block
      languagejava
      rsr.setOrgRef("org1AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");
rsr.setGroup(group);


    • Once the request is configured, perform the call:

       Code Block
      languagejava
      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
      GroupsGroup
      AdministrationGroup[]
      List of groups
      Group with members

    • Use the following to retrieve members:

       Code Block
      languagejava
      AdministrationGroupMember[] members = rs.getGroup()
      You can retrieve members of each group by using AdministrationGroup
      .getGroupMembers()
      . This will retrieve an array of AdministrationGroupMember. Keep in mind that if the group has a user role as a member, it will not be retrieved. Only user accounts will be retrieved via getGroupMembers().
     
     
     
    • ;


       Tip
      You can use AdministrationGroupMember.getInternalId() to get the IpId of the Yellowfin account. Then pass it to a GETUSERBYIP call to retrieve the AdministrationPerson object for the user.




    Complete Example
    Below is a full example of the LISTGROUPS GETGROUP function. To use it for yourself, carry out the following the steps:
    1. Copy the code and save it as ws_listgroupsgetgroup.jsp.
    2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
    3. Adjust the host, port, admin user details and group name according to your environment.
    4. Run http://<host>:<port>/ws_listgroupsgetgroup.jsp from your Internet browser.
     

     Code Block
    languagejava
    themeEclipse
    <%            
/*              ws_listgroupsgetgroup.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");                           // change to the password of the account above account

rsr.setOrgId(1);

rsr.setFunction("LISTGROUPSGETGROUP");

//rsr.setOrgRef("org1");                    	   // provide org reference ID if required. Default org groups will be retrievedsearched otherwise

AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");
rsr.setGroup(group);

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode()) ) {
	out.write("Success.<br>Available Groups:<br>");
	AdministrationGroup[] groupsgroup = rs.getGroupsgetGroup();
	for (AdministrationGroup group: groups){
		out.write("<br>");
		out.write("<br>Group Name: " + group.getGroupName());
		out.write("<br>Group Id: " + group.getGroupId());
		out.write("<br>Group Description: " + group.getGroupDescription());
		out.write("<br>Group Status: " + group.getGroupStatus());
		out.write("<br>Group Internal Reference: " + group.getGroupInternalReference());


		// uncomment to display the members:
		/*
		out.write("<br>Members:<br>Login Id | Internal Id ");
		for (AdministrationGroupMember member: group.getGroupMembers()){
			out.write("<br>" + member.getLoginId() + " | "  + member.getInternalId() );
		}
		*/
	}
} else {
	out.write("Failure");
	out.write(" Code: " + rs.getErrorCode());
}
%>





     Anchor
    ...
    creategroup
    ...
    creategroup
     Expand
    titleGETGROUPCREATEGROUP
    Use this This function to retrieve creates a specified new user group with its members. Group name must be provided to the request. in either a specified client org (if its reference ID is provided), or the default (primary) org. The new group details will be passed using the AdministrationGroup object. You may also provide group member detials via AdministrationGroupMember, to add them to the new group. (Note however, that these members must be existing Yellowfin users.)

    Request Elements
    The following elements will be passed with this request:
    Request Element
    Data Type
    Description
    LoginId
    String
    Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.
    This Yellowfin 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 services function. Set this to "GETGROUPCREATEGROUP".
    GroupAdministrationGroupThis object contains details of the user group to be retrievedadded. See table below.
    OrgRefString
    You may include a Client Org ID to 
     search for 
    add the new group within a specific client org. If this is not specified, then the group will be created in the default organization
    's groups will be searched
    .
     

     Anchor
    getgrpapcreategrpapgetgrpap
    creategrpap
    These are the main parameters that you need to set in the AdministrationGroup object for this function:
    AdministrationGroup Element
    Data Type
    Description
    GroupNameString
    Specify name Name of the user group to retrieve its details and member list.
     
     
    The following SOAP example shows the parameters that you can pass to this call:
     Code Block
    languagexml
    <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>GETGROUP</function>
            <group>
            	<groupName>Administrators</groupName>
            </group>                    
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>
     
     
    Response Elements
    The response returned will contain these parameters:
    new group.
    GroupMembersAdministrationGroupMemberThis object can be used to provide details of the group members. See the table below.

     Anchor
    creategroupmembsap
    creategroupmembsap
    These are the main parameters that you need to set in the AdministrationGroupMembers object for this function:
    AdministrationGroupMembers Response Element
    Data Type
    Description
    StatusCodeLoginIdString
    Status of the web service call. Possible values include:
    • SUCCESS
    • FAILURE
    Group
    AdministrationGroup[]
    Group details with a list of its members.
     
    The user ID of an existing Yellowfin user, to add them to this group.


    The following SOAP example shows the parameters that you can pass to this callThe service will return the below response, according to our SOAP example:
     Code Block
    languagexml
    <S<soapenv:Envelope xmlns:Ssoapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:remoteAdministrationCallResponse xmlns:ns2web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
    <return>     <arg0>
            <loginId>admin@yellowfin.com.au</loginId>
            <errorCode>0<<password>test</errorCode>password>
            <group><orgId>1</orgId>
            <function>CREATEGROUP</function>
    <groupDescription>This group contains all users with the Admin role.</groupDescription><group>
               <groupId>11950</groupId>	<groupName>Supervisors</groupName>
               	<groupMembers>
                  <internalId>5</internalId>		<loginId>admin@yellowfin.com.au</loginId>
                  <loginId>admin@yellowfin		<loginId>binish.sheikh@yellowfin.com.au</loginId>
               	</groupMembers>
            </group>   <groupMembers>
                  <internalId>13000</internalId>
         </arg0>
         <loginId>binish.sheikh@yellowfin</web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

    Response Elements
    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

    The service will return the below response, according to our SOAP example:
     Code Block
    languagexml
     <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
.com.au</loginId>
               </groupMembers>
               <groupName>Administrators</groupName><ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
               <groupStatus>OPEN</groupStatus><return>
            <<errorCode>0</group>errorCode>
            <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
            <messages>Web Service Request Complete</messages>
            <sessionId>54c5cf263f323b439c5834d1f6d8b645<<sessionId>b1f1b17d503e1e11c05b72e674bc80ec</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope> Envelope>
     


    Instructions
    See below for step-by-step instructions on how to perform this call, using a Java example:
     Expand
    titleStep-by-step instructions
     
    • Displayed below is a basic request for this function:

       Code Block
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("GETGROUPCREATEGROUP");


    • Include a To add the new group to a specific client, include its Client Org ID to list groups specific to that client. (If not included, then the group will be created in the default (that is, the Primary Org) group will be displayed).
       Code Block
      languagejava
      rsr.setOrgRef("org1");



    • Set parameters for the new group:

       Code Block
      languagejava
      AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Test Group");


    • Inclue members to the group, for exampleProvide name of a user group to retrieve its members:

       Code Block
      languagejava
      AdministrationGroup groupAdministrationGroupMember[] member = new AdministrationGroupMember[2];

member[0] = new AdministrationGroupMember();
member[0].setLoginId("admin@yellowfin.com.au");

member[1] = new AdministrationGroupAdministrationGroupMember();
group.setGroupName("Administrators"member[1].setLoginId("john.smith@yellowfin.com.au");

group.setGroupMembers(member);

rsr.setGroup(group);
     


    • Once the request is configured, perform the call:

       Code Block
      languagejava
      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
      Group
      AdministrationGroup[]
      Group with members
      Use the following to retrieve members:
       Code Block
      languagejava
      AdministrationGroupMember[] members = rs.getGroup().getGroupMembers();

       Tip
      You can use AdministrationGroupMember.getInternalId() to get the IpId of the Yellowfin account. Then pass it to a GETUSERBYIP call to retrieve the AdministrationPerson object for the user.
     
     
     
    • String
      Status of the web service call. Possible values include:
      • SUCCESS
      • FAILURE



    Complete Example
    Below is a full example of the GETGROUP CREATEGROUP function. To use it for yourself, carry out the following the steps:
    1. Copy the code and save it as ws_getgroupcreategroup.jsp.
    2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
    3. Adjust the host, port, admin user, group members and group name according to your environment.
    4. Run http://<host>:<port>/ws_getgroupcreategroup.jsp from your Internet browser.
     

     Code Block
    languagejava
    themeEclipse
    <%            
/*              ws_getgroupcreategroup.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");                           // change to the password of the account above

rsr.setOrgId(1);

rsr.setFunction("GETGROUP");

//rsr.setOrgRef("org1");                    	   // provide org reference ID if required. Default org will be searched otherwise

AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");
rsr.setGroup(group);

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

if ("SUCCESS".equals(rs.getStatusCode()) ) {
	out.write("Success.<br>");
	group = rs.getGroup();
	
	out.write("<br>");
	out.write("<br>Group Name: " + group.getGroupName());
	out.write("<br>Group Id: " + group.getGroupId());
	out.write("<br>Group Description: " + group.getGroupDescription());
	out.write("<br>Group Status: " + group.getGroupStatus());
	out.write("<br>Group Internal Reference: " + group.getGroupInternalReference());


	// display the members:
	out.write("<br>Members:<br>Login Id | Internal Id ");
	for (AdministrationGroupMember member: group.getGroupMembers()){
		out.write("<br>" + member.getLoginId() + " | "  + member.getInternalId() );
	} (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("CREATEGROUP");

//Specify client org (if omitted, the group will be created in the default (primary) org):
rsr.setOrgRef("org1");

//Set parameters of the new group:
AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Test Group");                          // mandatory. Other parameters are optional.

//Add members:
AdministrationGroupMember[] member = new AdministrationGroupMember[2];
member[0] = new AdministrationGroupMember();
member[0].setLoginId("admin@yellowfin.com.au");

member[1] = new AdministrationGroupMember();
member[1].setLoginId("john.smith@yellowfin.com.au");

group.setGroupMembers(member);

rsr.setGroup(group);

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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



     


     Anchor
    modifygroup
    ...
    modifygroup
     Expand
    titleCREATEGROUPMODIFYGROUP
    This function creates a new user group in either a specified client org (if its reference ID is provided), or the default (primary) org. The new group details will be passed using the AdministrationGroup object. You may also provide group member detials via AdministrationGroupMember, to add them to the new group. (Note however, that these members must be existing Yellowfin users.)
     
    is used to update the members of a group. If a list of members is provided with this request, the previous member list will be overwritten, that is, the service will delete all existing members and add the new ones. If a member list is not supplied, then all the existing members will be removed from the group.

    Request Elements
    The following elements will be passed with this request:
    Request Element
    Data Type
    Description
    LoginId
    String
    Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.
    This Yellowfin 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 services function. Set this to "CREATEGROUPMODIFYGROUP".
    GroupAdministrationGroupThis object contains details of the user group to be addedmodified. See table below.
    OrgRefString
    You may include a Client Org ID to add search for the new group within a specific client org. If this is not specified, then the group will be created searched in the default (Primary) organization.
     

     Anchor
    creategrpapmodgrpapcreategrpap
    modgrpap
    These are the main parameters that you need to set in the AdministrationGroup object for this function:
    AdministrationGroup Element
    Data Type
    Description
    GroupNameString
    Name of the new group.
    GroupMembersAdministrationGroupMembersAdministrationGroupMemberThis object can be used to provide details of the group members. See the table below.
     

     Anchor
    creategroupmembsapmodgroupmembsapcreategroupmembsap
    modgroupmembsap
    These are the main parameters that you need to set in the AdministrationGroupMembers object for this function:
    AdministrationGroupMembers Element
    Data Type
    Description
    LoginIdStringThe user ID of an existing Yellowfin user, to add them to this group.
     
     


    The following SOAP example shows the parameters that you can pass to this call:
     Code Block
    languagexml
    <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>CREATEGROUP<<function>MODIFYGROUP</function>
            <group>
            	<groupName>Supervisors</groupName>
            	<groupMembers>
            		<loginId>admin@yellowfin.com.au</loginId>
            		<loginId>binish.sheikh@yellowfin.com.au</loginId>
            	</groupMembers>
            </group>                    
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>
     


    Response Elements
    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
     

    The service will return the below response, according to our SOAP example:
     Code Block
    languagexml
     <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>b1f1b17d503e1e11c05b72e674bc80ec<<sessionId>6589bf668504fd3468e0b43844550a22</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
    titleStep-by-step instructions
     
    • Displayed below is a basic request for this function:

       Code Block
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("CREATEGROUPMODIFYGROUP");


    • To add the new group to a specific client, include search for a group in a client organization, provide its Client Org ID. (If not included, then the group will be created searched in the default (that is, the Primary Org) group).primary) org.)
       Code Block
      languagejava
      rsr.setOrgRef("org1");



    • Set parameters for the new group:

       Code Block
      languagejava
      AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Test Group");


    • Inclue Include members to the group, for example:

       Code Block
      languagejava
      AdministrationGroupMember[] member = new AdministrationGroupMember[2];

member[0] member = new AdministrationGroupMember();
member[0].setLoginId("admin@yellowfin.com.au")1];

member[10] = new AdministrationGroupMember();
member[10].setLoginId("john.smith@yellowfinadmin@yellowfin.com.au");

group.setGroupMembers(member);

rsr.setGroup(group);
     


    • Once the request is configured, perform the call:

       Code Block
      languagejava
      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
     
     



    Complete Example
    Below is a full example of the CREATEGROUP MODIFYGROUP function. To use it for yourself, carry out the following the steps:
    1. Copy the code and save it as ws_creategroupmodifygroup.jsp.
    2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
    3. Adjust the host, port, admin user, group members and group name according to your environment.
    4. Run http://<host>:<port>/ws_creategroupmodifygroup.jsp from your Internet browser.
     

     Code Block
    languagejava
    themeEclipse
    <%            
/*              ws_creategroupmodifygroup.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);
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();

AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("CREATEGROUPMODIFYGROUP");

//Specify client org (if omitted, the group will be created in the default (primary) org will be searched):
rsr.setOrgRef("org1");

//Set parameters of the new group:
AdministrationGroup group = new AdministrationGroup();

group.setGroupName("Test Group");                          // mandatory. Other parameters are optional.


//Add members:
AdministrationGroupMember[] member = new AdministrationGroupMember[21];

member[0] = new AdministrationGroupMember();
member[0].setLoginId("admin@yellowfin.com.au");

member[1] = new AdministrationGroupMember();
member[1].setLoginId("john.smith@yellowfin.com.au");

group.setGroupMembers(member);

rsr.setGroup(group);

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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





     Anchor
    ...
    renamegroup
    ...
    renamegroup
     Expand
    titleMODIFYGROUPRENAMEGROUP
    This function is used to update the members of a group. If a list of members is provided with this request, the previous member list will be overwritten, that is, the service will delete all existing members and add the new ones. If a member list is not supplied, then all the existing members will be removed from the group.rename a group. Use the AdministrationGroup object to specify the group with its ID. The group IDs can be retrieved from Yellowfin's database (AccessGroupId field of AccessGroup table) or calling GETGROUP by group name and getting response.getGroup().getGroupId(). 

    Request Elements
    The following elements will be passed with this request:
    Request Element
    Data Type
    Description
    LoginId
    String
    Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.
    This Yellowfin 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 services function. Set this to "MODIFYGROUPRENAMEGROUP".
    GroupAdministrationGroupThis object contains details of the user group to be modifiedrenamed. See table below.
    OrgRefString
    You may include a Client Org ID to search for add the new group within a specific client org. If this is not specified, then the group will be searched created in the default (Primary) organization.
     

     Anchor
    modgrpaprenamegrpapmodgrpap
    renamegrpap
    These are the main parameters that you need to set in the AdministrationGroup object for this function:
    AdministrationGroup Element
    Data Type
    Description
    GroupNameGroupIdStringInteger
    Name Internal ID of the group to identify it.
    GroupMembersGroupNameAdministrationGroupMembersStringNew name This object can be used to provide details of the group members. See the table below.
     
    GroupDescription
     Anchor
    modgroupmembsap
    StringDescription of the group.


    modgroupmembsap
    These are the main parameters that you need to set in the AdministrationGroupMembers object for this function:
    AdministrationGroupMembers Element
    Data Type
    Description
    LoginIdStringThe user ID of an existing Yellowfin user, to add them to this group.
     
     
    The following SOAP example shows the parameters that you can pass to this call:
     Code Block
    languagexml
     <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>MODIFYGROUP<<function>RENAMEGROUP</function>
            <group>
               	<groupName>Supervisors<<groupId>13001</groupName>
groupId>            	<groupMembers>
            		<loginId>admin@yellowfin.com.au</loginId><groupName>Report Creators</groupName>
            	<groupDescription>Users of this group will create reports.</groupMembers>groupDescription>
            </group>                    
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>
     
     


    Response Elements
    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
     


    The service will return the below response, according to our SOAP example:
     Code Block
    languagexml
     <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>6589bf668504fd3468e0b43844550a22<<sessionId>2ca79b1696913aa7a4f8b601ac1641a4</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
    titleStep-by-step instructions
    • Displayed below is a basic request for this function:

       Code Block
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("MODIFYGROUPRENAMEGROUP");


    • To search for a group in within a specific client organization, provide include its Client Org ID. (If not included, then the group will be searched in the default (primary) org.)that is, the Primary Org) group).
       Code Block
      languagejava
      rsr.setOrgRef("org1");



    • Set parameters for the new groupDefine a group to rename it:

       Code Block
      languagejava
      AdministrationGroup group = new AdministrationGroup();


    • Identify the group by its group ID:

       Code Block
      languagejava
      group.setGroupId(13002);

    • Provide a new group name and description
      .setGroupName("Test Group");

      Include members to the group:

       Code Block
      languagejava
      AdministrationGroupMember[] member = new AdministrationGroupMember[1];

member[0] = new AdministrationGroupMember();
member[0].setLoginId("admin@yellowfin.com.augroup.setGroupName("Org 1");

group.setGroupMembers(membersetGroupDescription("Organization 1 user group");

rsr.setGroup(group);

     


    • Once the request is configured, perform the call:

       Code Block
      languagejava
      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
     
     



    Complete Example
    Below is a full example of the MODIFYGROUP RENAMEGROUP function. To use it for yourself, carry out the following the steps:
    1. Copy the code and save it as ws_modifygrouprenamegroup.jsp.
    2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
    3. Adjust the host, port, admin user, group members and group name ID according to your environment.
    4. Run http://<host>:<port>/ws_modifygrouprenamegroup.jsp from your Internet browser.
     

     Code Block
    languagexmljava
    themeEclipse
    <%            
/*              ws_modifygrouprenamegroup.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");                           //password of the account above
rsr.setOrgId(1);

rsr.setFunction("MODIFYGROUPRENAMEGROUP");

rsr.setOrgRef("org1");                        //Specify clientprovide org (reference if omitted,required. defaultDefault (primary) org will be searched):
rsr.setOrgRef("org1");

//Set parameters of the new group: otherwise

AdministrationGroup group = new AdministrationGroup();

group.setGroupName("Test Group"setGroupId(13002);                 // mandatory. Other parameters are optional.


//Add members:
AdministrationGroupMember[] member =// new AdministrationGroupMember[1];

member[0] = new AdministrationGroupMember();
member[0].setLoginId("admin@yellowfin.com.au");

group.setGroupMembers(member);identify the group to rename
group.setGroupName("Org1");                      // new group name

group.setGroupDescription("Organization 1 user group");               // new description

rsr.setGroup(group);


AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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





     Anchor
    ...
    deletegroup
    ...
    deletegroup
     Expand
    titleRENAMEGROUPDELETEGROUP
    Call this web service to delete an existing user group from Yellowfin, by providing the group name.

    Request Parameters
    The following parameters 
    This function is used to rename a group. Use the AdministrationGroup object to specify the group with its ID. The group IDs can be retrieved from Yellowfin's database (AccessGroupId field of AccessGroup table) or calling GETGROUP by group name and getting response.getGroup().getGroupId(). 
     
    Request Elements
    The following elements will be passed with this request:
    Request Element
    Data Type
    Description
    LoginId
    String
    Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.
    This Yellowfin 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 services function. Set this to "RENAMEGROUPDELETEGROUP".
    GroupAdministrationGroupThis object contains details of the user group to be renameddeleted. See table below.
    OrgRefString
    You may include a Client Org ID to add the new search for this group within a specific client org. If this is not specified, then the group will be created searched in the default organization.
     

     Anchor
    renamegrpapdelgrpaprenamegrpap
    delgrpap
    These are the main parameters that you need to set in the AdministrationGroup object for this function:
    Internal ID of the group to identify it.New name GroupDescription
    AdministrationGroup Element
    Data Type
    Description
    		GroupIdInteger
    GroupNameString
    Name of the group to be deleted.
    		StringDescription of the group.
     
     


    The following SOAP example shows the parameters that you can pass to this call:
     Code Block
    languagexml
     <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>RENAMEGROUP</function>
            <group><arg0>
           <loginId>admin@yellowfin.com.au</loginId>
    <groupId>13001</groupId>       <password>test</password>
     	
      <orgId>1</orgId>
      	<groupName>Report Creators</groupName>
    <function>DELETEGROUP</function>
        	<groupDescription>Users of this group will create reports.</groupDescription> <group>
            </group>	<groupName>Admin</groupName>
           </group>          
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>
     
     


    Response 
     Elements
    Parameters
    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
     
     


    The service will return the below response, according to our SOAP example:
     Code Block
    languagexml
     <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>2ca79b1696913aa7a4f8b601ac1641a4<<sessionId>db18f2503e80ca02a9d37da13fc540a5</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
    titleStep-by-step instructions
    • Displayed below is Start with a basic request for this function:

       Code Block
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("RENAMEGROUPDELETEGROUP");


    • To You may specify a client organization to search for a the group within a specific client, include its Client Org ID. (If it. But if not included, then the group will be searched in the default (that is, the Primary Orgprimary) group)organization.
       Code Block
      languagejava
      rsr.setOrgRef("org1");



    • Define a group to rename itSet parameters for the group which is to be deleted:

       Code Block
      languagejava
      AdministrationGroup group = new AdministrationGroup();

      Identify the group by its group ID:
       Code Block
      languagejava
      group.setGroupId(13002);
      Provide a new group name and description:
       Code Block
      languagejava
      group.setGroupName("Org 1" new AdministrationGroup();
group.setGroupDescriptionsetGroupName("Organization 1 user groupTest Group");

rsr.setGroup(group);



    • Once the request is configured, perform the call:

       Code Block
      languagejava
      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
     
     



    Complete Example
    Below is a full example of the RENAMEGROUP DELETEGROUP function. To use it for yourself, carry out the following the steps:
    1. Copy the code and save it as ws_renamegroupdeletegroup.jsp.
    2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
    3. Adjust the host, port, admin user, group members and group ID name according to your environment.
    4. Run http://<host>:<port>/ws_renamegroupdeletegroup.jsp from your Internet browser.
     

     Code Block
    languagexmljava
    themeEclipse
    <%            
/*              ws_renamegroupdeletegroup.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 the password of the above account above

rsr.setOrgId(1);

rsr.setFunction("RENAMEGROUPDELETEGROUP");

rsr.setOrgRef("org1");                        	// specify a provideclient org reference if required. Default org will be searched otherwise Or skip this to search through the default org


AdministrationGroup group = new AdministrationGroup();

group.setGroupId(13002);                         // identify the group to rename
group.setGroupName("Org1");                      // new group name

group.setGroupDescription("Organization 1 user groupTest Group");        		// this group must exist in the //specified newclient descriptionorg


rsr.setGroup(group);


AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);

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


     


     Anchor
    ...
    includeuseringroup
    ...
    includeuseringroup
     Expand
    titleDELETEGROUPINCLUDEUSERINGROUP
    This function is used to add a specific Yellowfin user to a specific user group.
    This request will require the AdministrationPerson object to specify the user, and the AdministrationGroup object to define the user group.

    Call this web service to delete an existing user group from Yellowfin, by providing the group name.
     
    Request Parameters
    The following parameters will be passed with this request:
    Request Element
    Data Type
    Description
    LoginId
    String
    Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.
    This Yellowfin 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 services function. Set this to "DELETEGROUPINCLUDEUSERINGROUP".
    PersonAdministrationPersonObject containing details of the user that is to be added to the group. See table below.
    GroupAdministrationGroupThis object contains Object containing details of the user group to be deletedwhich the user is added. See table below.
    OrgRefString
    You may include a Client Org ID to search for this group within a specific client org. If this is not specified, then the group will be searched in the default organization.
     
    organization.

     Anchor
    incgrpap
    incgrpap
    These are the main parameters that you need to set in the AdministrationPerson object for this function:
    AdministrationPerson Element
    Data Type
    Description
    UserIdString
    An existing Yellowfin user to add them to the group. This could be a user ID or an email address, depending on the Logon method.

     Anchor
    incgrpag
    incgrpag
     Anchor
    delgrpapdelgrpap
    These are the main parameters that you need to set in the AdministrationGroup object for this function:
    AdministrationGroup Element
    Data Type
    Description
    GroupNameString
    Name of the group to which the user is to be  deletedadded.
     
     


    The following SOAP example shows the parameters that you can pass to this call:
     Code Block
    languagexml
     <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>DELETEGROUP</function><function>INCLUDEUSERINGROUP</function>
           <person>
           	<userId>binish.sheikh@yellowfin.com.au</userId>
           </person>
           <group>
           	<groupName>Admin<<groupName>Administrators</groupName>
           </group>          
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>
     
     

    Response Parameters
    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
     
     


    The service will return the below response, according to our SOAP example:
     Code Block
    languagexml
     <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>db18f2503e80ca02a9d37da13fc540a5<<sessionId>a26d9c279a9c1a4f0dfda86424ca4267</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
    titleStep-by-step instructions
    • Start with a basic request for this function:

       Code Block
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("DELETEGROUPINCLUDEUSERINGROUP");


    • You may specify a client organization to search for the group within it. But if not included, then the group will be searched in the default (that is, the primary) organization.
       Code Block
      languagejava
      rsr.setOrgRef("org1");



    • Set parameters to identify an existing user to include them to a group:

       Code Block
      languagejava
      AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("john.smith@yellowfin.com.au");  // must be an existing Yellowfin user

rsr.setPerson(ap);



    • Set parameters for the group to which is to be deletedinclude the user:

       Code Block
      languagejava
      AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Test GroupAdministrators");

rsr.setGroup(group);
     


    • Once the request is configured, perform the call:

       Code Block
      languagejava
      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
     
     



    Complete Example
    Below is a full example of the DELETEGROUP this function. To use it for yourself, carry out the following the steps:
    1. Copy the code and save it as ws_deletegroupincludeuseringroup.jsp.
    2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
    3. Adjust the host, port, admin user, existing user, and group name according to your environment.
    4. Run http://<host>:<port>/ws_deletegroupincludeuseringroup.jsp from your Internet browser.
     

     Code Block
    languagexmljava
    themeEclipse
    <%            
/*              ws_deletegroupincludeuseringroup.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 theto password of the above account

rsr.setOrgId(1);

rsr.setFunction("DELETEGROUPINCLUDEUSERINGROUP");


rsr.setOrgRef("org1");                        	// specify a client org reference if required. Or skip this to search through the default org


//Specify a client org (if omitted, default (primary) org groups will be searched):
rsr.setOrgRef("org1");


//Identify a user:
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("john.smith@yellowfin.com.au");  			// must be an existing Yellowfin user

rsr.setPerson(ap);


 
//Specify group to add the user to 
AdministrationGroup group = new AdministrationGroup();

group.setGroupName("Test Group");"Administrators");                 		// this group must existbe inan theexisting specified client org
user group

rsr.setGroup(group);


AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);


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


     


     Anchor
    includeusersingroup
    ...
    includeusersingroup
     Expand
    titleINCLUDEUSERINGROUPINCLUDEUSERSINGROUP
    This function is used to add a specific Yellowfin user include multiple specified Yellowfin users to a specific user group.
    This request will require the an array of AdministrationPerson object to specify the userusers, and the AdministrationGroup object to define the user group.
     

    Request Parameters
    The following parameters will be passed with this request:
    Request Element
    Data Type
    Description
    LoginId
    String
    Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.
    This Yellowfin 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 services function. Set this to "INCLUDEUSERINGROUPINCLUDEUSERSINGROUP".
    PersonAdministrationPerson[]Object An object array containing details of the user that is to be added to the users to add them to a group. See table below.
    GroupAdministrationGroupObject containing details of the user group to which the user is users are added. See table below.
    OrgRefString
    You may include a Client Org ID to search for this group within a specific client org. If this is not specified, then the group will be searched in the default organization.
     

     Anchor
    incgrpapincgrpapsincgrpap
    incgrpaps
    These are the main parameters that you need to set in the AdministrationPerson object array for this function:
    AdministrationPerson Element
    Data Type
    Description
    UserIdString
    An existing Existing Yellowfin user to add them to the group. This could be a user ID or an email address, depending on the Logon ID method.
     

     Anchor
    incgrpagincgrpagsincgrpag
    incgrpags
    These are the main parameters that you need to set in the AdministrationGroup object for this function:
    AdministrationGroup Element
    Data Type
    Description
    GroupNameString
    Name of the group to which the user is users are to be added.
     
     


    The following SOAP example shows the parameters that you can pass to this call:
     Code Block
    languagexml
    themeConfluence
     <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:remoteAdministrationCall>
<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>INCLUDEUSERSINGROUP</function>
           <people>
           	<userId>binish.sheikh@yellowfin.com.au</userId>
           	<userId>admin@yellowfin.com.au</userId>
           </people>
           <group>
           	<groupName>Administrators</groupName>
          <arg0>
 </group>          <loginId>admin@yellowfin.com.au</loginId>
           <password>test<</password>arg0>
      </web:remoteAdministrationCall>
     <orgId>1</orgId></soapenv:Body>
</soapenv:Envelope>


    Response Parameters
    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


    The service will return the below response, according to our SOAP example:
     Code Block
    languagexml
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
        <function>INCLUDEUSERINGROUP</function><ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
           <person><return>
           	<userId>binish.sheikh@yellowfin.com.au</userId> <errorCode>0</errorCode>
           </person>
 <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
       <group>
     <messages>Web Service Request Complete</messages>
   	<groupName>Administrators</groupName>
         <sessionId>799b3c35c5359c6105586e426f1b9f8c</sessionId>
  </group>          <statusCode>SUCCESS</statusCode>
         </arg0>return>
      </webns2:remoteAdministrationCall>remoteAdministrationCallResponse>
   </soapenvS:Body>
</soapenvS:Envelope>
     
    Response Parameters
    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
     
     
    The service will return the below response, according to our SOAP example



    Instructions
    See below for step-by-step instructions on how to perform this call, using a Java example:
     Expand
    titleStep-by-step instructions
    • Start with a basic request for this function:

       Code Block
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("INCLUDEUSERSINGROUP");


    • You may specify a client organization to search for the group within it. But if not included, then the group will be searched in the default (that is, the primary) organization.
       Code Block
      languagejava
      rsr.setOrgRef("org1");



    • Set parameters to identify existing users to include them to a group:

       Code Block
      language
    		xml
    • java
      AdministrationPerson[] ap = new AdministrationPerson[1];
ap[0] = new AdministrationPerson();
ap[0].setUserId("john.smith@yellowfin.com.au");
    <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>a26d9c279a9c1a4f0dfda86424ca4267<
    • /
    sessionId>

    •  must be an existing 
           <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:
    • Yellowfin user


rsr.setPeople(ap);



    • Set parameters for the group where the users are to be included
     Expand
    titleStep-by-step instructions
    • Start with a basic request for this function:

       Code Block
      languagejava
      AdministrationServiceRequestAdministrationGroup rsrgroup = new AdministrationServiceRequestAdministrationGroup();

rsrgroup.setLoginIdsetGroupName("admin@yellowfin.com.auAdministrators");					//must be an existing group

rsr.setPasswordsetGroup("test");
rsr.setOrgId(1);

rsr.setFunction("INCLUDEUSERINGROUP");
      You may specify a client organization to search for the group within it. But if not included, then the group will be searched in the default (that is, the primary) organization.
       Code Block
      languagejava
      rsr.setOrgRef("org1");

      Set parameters to identify an existing user to include them to a group:
      group);


    • Once the request is configured, perform the call:

       Code Block
      languagejava
      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



    Complete Example
    Below is a full example of this function. To use it for yourself, carry out the following the steps:
    1. Copy the code and save it as ws_includeusersingroup.jsp.
    2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
    3. Adjust the host, port, admin user, existing users, and group name according to your environment.
    4. Run http://<host>:<port>/ws_includeusersingroup.jsp from your Internet browser.

     
    Set parameters for the group to which to include the user:
     Code Block
    languagejava
    AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("john.smith@yellowfin.com.au");  // must be an existing Yellowfin user

rsr.setPerson(ap);

     Code Block
    languagejava
    AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");

rsr.setGroup(group);
     
    Once the request is configured, perform the call:
     Code Block
    languagejava
    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
     
     
    Complete Example
    Below is a full example of this function. To use it for yourself, carry out the following the steps:
    1. Copy the code and save it as ws_includeuseringroup.jsp.
    2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
    3. Adjust the host, port, admin user, existing user, and group name according to your environment.
    4. Run http://<host>:<port>/ws_includeuseringroup.jsp from your Internet browser.
     
    themeEclipse
    <%            
/*             ws_includeusersingroup.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");
     Code Block
    languagexml
    themeEclipse
    <%            
/*          // provide  ws_includeuseringroup.jspyour Yellowfin web services admin account
rsr.setPassword("test");                */
%>
<%@ 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@yellowfinset to password of the above account

rsr.setOrgId(1);

rsr.setFunction("INCLUDEUSERINGROUP");


//Specify a client org (if omitted, default (primary) org groups will be searched):
rsr.setOrgRef("org1");


//Provide all the users that are to be included:
AdministrationPerson[] ap = new AdministrationPerson[1];
ap[0] = new AdministrationPerson();
ap[0].setUserId("john.smith@yellowfin.com.au");          			// providemust yourbe Yellowfinan webexisting services admin accountYellowfin user

rsr.setPasswordsetPerson("test"ap);


 
//Specify group to add the users to 
AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");                 	// setmust tobe passwordan ofexisting theuser above accountgroup

rsr.setOrgIdsetGroup(1group);


rsr.setFunction("INCLUDEUSERINGROUP"AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);


//Specify a client org (if omitted, default (primary) org groups will be searched):
rsr.setOrgRef("org1");


//Identify a user:
AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("john.smith@yellowfin.com.au");  			// must be an existing Yellowfin user

rsr.setPerson(ap);


 
//Specify group to add the user to 
AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");                 	// must be an existing user group

rsr.setGroup(group);


AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);


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


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




     Anchor
    excludeuserfromgroup
    excludeuserfromgroup
     Expand
    titleEXCLUDEUSERFROMGROUP
    This function is used to add a specific Yellowfin user to a specific user group, but with an "exclude" tag. Note that this user is not actually removed from the group, but will exist as an excluded member.

    Image Added
    This request will require the AdministrationPerson object to specify the user, and the AdministrationGroup object to define the user group.

    Request Parameters
    The following parameters will be passed with this request:
    Request Element
    Data Type
    Description
    LoginId
    String
    Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.
    This Yellowfin 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 services function. Set this to "EXCLUDEUSERFROMGROUP".
    PersonAdministrationPersonObject containing details of the user to be excluded from group. See table below.
    GroupAdministrationGroupObject containing details of the user group. See table below.
    OrgRefString
    You may include a Client Org ID to search for this group within a specific client org. If this is not specified, then the group will be searched in the default organization.

     Anchor
    excluserap
    excluserap
    These are the main parameters that you need to set in the AdministrationPerson object for this function:
    AdministrationPerson Element
    Data Type
    Description
    UserIdString
    An existing Yellowfin user to exclude them from the group. This value could be a user ID or an 
     Expand
    titleINCLUDEUSERSINGROUP
    This function is used to include multiple specified Yellowfin users to a specific user group.
    This request will require an array of AdministrationPerson object to specify the users, and the AdministrationGroup object to define the user group.
     
    Request Parameters
    The following parameters will be passed with this request:
    Request Element
    Data Type
    Description
    LoginId
    String
    Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.
    This Yellowfin 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 services function. Set this to "INCLUDEUSERSINGROUP".
    PersonAdministrationPerson[]An object array containing details of the users to add them to a group. See table below.
    GroupAdministrationGroupObject containing details of the user group to which the users are added. See table below.
    OrgRefString
    You may include a Client Org ID to search for this group within a specific client org. If this is not specified, then the group will be searched in the default organization.
     
     Anchor
    incgrpaps

     Anchor
    excluserag
    excluserag
    These are the main parameters that you need to set in the AdministrationGroup object for this function:
    AdministrationGroup Element
    Data Type
    Description
    GroupNameString
    Name of the group from which the user is to be excluded.


    The following SOAP example shows the parameters that you can pass to this call:
     Code Block
    languagexml
    <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>EXCLUDEUSERFROMGROUP</function>
           <person>
           	<userId>binish.sheikh@yellowfin.com.au</userId>
           </person>
           <group>
           	<groupName>Administrators</groupName>
           </group>                     
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>


    Response Parameters
    The response returned will contain these parameters:
    Response 
    incgrpaps
    These are the main parameters that you need to set in the AdministrationPerson object array for this function:
    AdministrationPerson Element
    Data Type
    Description
    UserId
    StatusCode
    String
    Existing Yellowfin user to add them to the group. This could be a user ID or an email address, depending on the Logon ID method.
     
     Anchorincgrpags
    Status of the web service call. Possible values include:
    • SUCCESS
    • FAILURE


    The service will return the below response, according to our SOAP example:
     Code Block
    languagexml
    <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>c15a0993df4f37f4dbff9b3244f41ea2</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>
    incgrpags
    These are the main parameters that you need to set in the AdministrationGroup object for this function:
    AdministrationGroup Element
    Data Type
    Description
    GroupNameString
    Name of the group to which the users are to be added.
     
    Response Parameters
    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
     
     


    Instructions
    See below for step-by-step instructions on how to perform this call, using a Java example:
     Expand
    titleStep-by-step instructions
    • Start with a basic request for this function:

       Code Block
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("INCLUDEUSERSINGROUPEXCLUDEUSERFROMGROUP");


    • You may specify a client organization to search for the group within it. But if not included, then the group will be searched in the default (that is, the primary) organization.
       Code Block
      languagejava
      rsr.setOrgRef("org1");



    • Set parameters to identify existing users to include them to a groupa user :

       Code Block
      languagejava
      AdministrationPerson[] ap = new AdministrationPerson[1];
ap[0] = new AdministrationPerson();
ap[0].setUserId("john.smith@yellowfin.com.au");              	// must be an existing Yellowfin user


rsr.setPeoplesetPerson(ap);

     


    • Set parameters for the group where the users are to be included:

       Code Block
      languagejava
      AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");					//must be an existing user group

rsr.setGroup(group);
     


    • Once the request is configured, perform the call:

       Code Block
      languagejava
      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
     
     



    Complete Example
    Below is a full example of this function. To use it for yourself, carry out the following the steps:
    1. Copy the code and save it as ws_includeusersingroupexcludeuserfromgroup.jsp.
    2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
    3. Adjust the host, port, admin user, existing usersuser to exclude, and the group name according to your environment.
    4. Run http://<host>:<port>/ws_includeusersingroupexcludeuserfromgroup.jsp from your Internet browser.
     

     Code Block
    languagexmljava
    themeEclipse
    <%            
/*              ws_includeusersingroup excludeuserfromgroup.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 tothe password of the above account

rsr.setOrgId(1);

rsr.setFunction("INCLUDEUSERINGROUPEXCLUDEUSERFROMGROUP");


//Specify athe client org (if omitted, the default (primary) org groups will be searched):


rsr.setOrgRef("org1");


//ProvideSpecify alla the users that are user to be includedexclude:


AdministrationPerson[] ap = new AdministrationPerson[1];
ap[0] = new AdministrationPerson();
ap[0].setUserId("john.smith@yellowfin.com.au");  			// must be an existing Yellowfin useruse

rsr.setPerson(ap);


 
//Specify group to add the userswhich group to exclude from:

AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");                 	// must be an existing user group

rsr.setGroup(group);


AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);


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


     


     Anchor
    excludeusersfromgroup
    ...
    excludeusersfromgroup
     Expand
    titleEXCLUDEUSERFROMGROUPEXCLUDEUSERSFROMGROUP
    This function is used to add a specific Yellowfin user multiple users to a specific user group, but with an "exclude" tag. Note that this user is these users are not actually removed from the group, but will exist as an excluded membermembers.

    This request will require the AdministrationPerson object array to specify the userusers, and the AdministrationGroup object to define the user group.
     

    Request Parameters
    The following parameters will be passed with this request:
    Request Element
    Data Type
    Description
    LoginId
    String
    Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.
    This Yellowfin 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 services function. Set this to "EXCLUDEUSERFROMGROUPEXCLUDEUSERSFROMGROUP".
    PersonAdministrationPerson[]Object array containing details of the user users who are to be excluded from the group. See table below.
    GroupAdministrationGroupObject containing details of the user group. See table below.
    OrgRefString
    You may include a Client Org ID to search for this group within a specific client org. If this is not specified, then the group will be searched in the default organization.
     

     Anchor
    excluserapexcluserapsexcluserap
    excluseraps
    These are the main parameters that you need to set in the AdministrationPerson object array for this function:
    AdministrationPerson Element
    Data Type
    Description
    UserIdString
    An existing Existing Yellowfin user to exclude them from the group. This value could be a user ID or an email address, depending on the Logon ID method.
     

     Anchor
    excluseragexcluseragsexcluserag
    excluserags
    These are the main parameters that you need to set in the AdministrationGroup object for this function:
    AdministrationGroup Element
    Data Type
    Description
    GroupNameString
    Name of the group from which the user is to be users are excluded.
     
     
    The following SOAP example shows the parameters that you can pass to this call:
     Code Block
    languagexml
    <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>EXCLUDEUSERFROMGROUP</function>
           <person>
           	<userId>binish.sheikh@yellowfin.com.au</userId>
           </person>
           <group>
           	<groupName>Administrators</groupName>
           </group>                     
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>
     
     
    Response Parameters


    Response Parameters
    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


    Instructions
    See below for step-by-step instructions on how to perform this call, using a Java example:
     Expand
    titleStep-by-step instructions
    • Start with a basic request for this function:

       Code Block
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("EXCLUDEUSERSFROMGROUP");


    • You may specify a client organization to search for the group within it. But if not included, then the group will be searched in the default (that is, the primary) organization.
       Code Block
      languagejava
      rsr.setOrgRef("org1");



    • Set parameters to identify a users:

       Code Block
      languagejava
      AdministrationPerson[] ap = new AdministrationPerson[1];
ap[0] = new AdministrationPerson();
ap[0].setUserId("john.smith@yellowfin.com.au");  	// must be an existing Yellowfin user

rsr.setPerson(ap);



    • Set parameters for the group:

       Code Block
      languagejava
      AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");			//must be an existing user group

rsr.setGroup(group);


    • Once the request is configured, perform the call:

       Code Block
      languagejava
      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
    • . Possible values include:
      • SUCCESS
      • FAILURE



    Complete Example
    Below is a full example of this function. To use it for yourself, carry out the following the steps:
    1. Copy the code and save it as ws_excludeusersfromgroup.jsp.
    2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
    3. Adjust the host, port, admin user, users to exclude, and the group name according to your environment.
    4. Run http://<host>:<port>/ws_excludeusersfromgroup.jsp from your Internet browser.

     Code Block
    languagejava
    themeEclipse
    <%
     
     
    The service will return the below response, according to our SOAP example:
     Code Block
    languagexml
    <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>c15a0993df4f37f4dbff9b3244f41ea2</sessionId>
  ws_ excludeusersfromgroup.jsp         <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:
    AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("john.smith@yellowfin
    */
%>
<%@ 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 
    must
    your 
    be
    Yellowfin 
    an
    web 
    existing
    services 
    Yellowfin
    admin 
    user
    account

    

    rsr.
    setPerson
    setPassword(
    ap);

     
    Set parameters for the group:
     Expand
    titleStep-by-step instructions
     Code Block
    languagejava
    themeEclipse
    Start with a basic request for this function:
     Code Block
    languagejava
    AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("EXCLUDEUSERFROMGROUP");
    You may specify a client organization to search for the group within it. But if not included, then the group will be searched in the default (that is, the primary) organization.
     Code Block
    languagejava
    rsr.setOrgRef("org1");

    Set parameters to identify a user :
     Code Block
    languagejava
     Code Block
    languagejava
    AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");			//must be an existing user group

rsr.setGroup(group);
     
    Once the request is configured, perform the call:
     Code Block
    languagejava
    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
     
     
    Complete Example
    Below is a full example of this function. To use it for yourself, carry out the following the steps:
    1. Copy the code and save it as ws_excludeuserfromgroup.jsp.
    2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
    3. Adjust the host, port, admin user, user to exclude, and the group name according to your environment.
    4. Run http://<host>:<port>/ws_excludeuserfromgroup.jsp from your Internet browser.
     
    <%            
/*              ws_ excludeuserfromgroup.jsp"test");                           // set the password of the above account

rsr.setOrgId(1);

rsr.setFunction("EXCLUDEUSERFROMGROUP");


//Specify the client org (if omitted, the default (primary) org groups will be searched):


rsr.setOrgRef("org1");


//Specify users to exclude:

AdministrationPerson[] ap = new AdministrationPerson[1];
ap[0] = new AdministrationPerson();
ap[0].setUserId("john.smith@yellowfin.com.au");  	// must be an existing Yellowfin user

rsr.setPerson(ap);


//Specify which group to exclude from:

AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");                 // must be an existing  */
%>
<%@ 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 the password of the above account

rsr.setOrgId(1);

rsr.setFunction("EXCLUDEUSERFROMGROUP");


//Specify the client org (if omitted, the default (primary) org groups will be searched):


rsr.setOrgRef("org1");


//Specify a user to exclude:


AdministrationPerson ap = new AdministrationPerson();
ap.setUserId("john.smith@yellowfin.com.au");  		// must be an existing Yellowfin use

rsr.setPerson(ap);


//Specify which group to exclude from:

AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");      user group

rsr.setGroup(group);

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);


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




     Anchor
    deluserfromgroup
    deluserfromgroup
    These are the main parameters that you need to set in the AdministrationPerson object array for this function:
     Expand
    titleDELUSERFROMGROUP
    This function is used to remove a specific Yellowfin user from a specific user group. On doing so, the user will not appear in the group's member list at all.
    This request will require the AdministrationPerson object to specify the user, and the AdministrationGroup object to define the user group.

    Request Parameters
    The following parameters will be passed with this request:
    Request Element
    Data Type
    Description
    LoginId
    String
    Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.
    This Yellowfin 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 services function. Set this to "DELUSERFROMGROUP".
    PersonAdministrationPersonObject containing details of the user who is to be deleted from the group. See table below.
    GroupAdministrationGroupObject containing details of the user group. See table below.
    OrgRefString
    You may include a Client Org ID to search for this group within a specific client org. If this is not specified, then the group will be searched in the default organization.

     Anchor
    deluserap
    deluserap
    These are the main parameters that you need to set in the AdministrationPerson object for this function:
    AdministrationPerson Element
    Data Type
    Description
    UserIdString
    An existing Yellowfin user to remove them from the group. This value could be a user ID or an email address, depending on the Logon method.

     Anchor
    deluserag
    deluserag
    These are the main parameters that you need to set in the AdministrationGroup object for this function:
    AdministrationGroup Element
    Data Type
    Description
    GroupNameString
    Name of the group from which the user is to be deleted.


    The following SOAP example shows the parameters that you can pass to this call:
     Code Block
    languagexml
    <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>
           // must be an existing user group

rsr.setGroup(group);

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);


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


     
     
     
     Expand
    titleEXCLUDEUSERSFROMGROUP
    <password>test</password>
           <orgId>1</orgId>
           <function>DELUSERFROMGROUP</function>
           <person>
           	<userId>binish.sheikh@yellowfin.com.au</userId>
           </person>
           <group>
           	<groupName>Administrators</groupName>
           </group>                     
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>

    Response Parameters
    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


    The service will return the below response, according to our SOAP example:
     Code Block
    languagexml
    <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>ed4f6504e415411875b2c359b9384cf9</sessionId>
            <statusCode>SUCCESS</statusCode>
         </return>
      </ns2:remoteAdministrationCallResponse>
   </S:Body>
</S:Envelope>


    This function is used to add a specific multiple users to a specific user group, but with an "exclude" tag. Note that these users are not actually removed from the group, but will exist as an excluded members.
    Image Removed
    This request will require the AdministrationPerson object array to specify the users, and the AdministrationGroup object to define the user group.
     
    Request Parameters
    The following parameters will be passed with this request:
    Request Element
    Data Type
    Description
    LoginId
    String
    Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.
    This Yellowfin 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 services function. Set this to "EXCLUDEUSERSFROMGROUP".
    PersonAdministrationPerson[]Object array containing details of the users who are to be excluded from the group. See table below.
    GroupAdministrationGroupObject containing details of the user group. See table below.
    OrgRefString
    You may include a Client Org ID to search for this group within a specific client org. If this is not specified, then the group will be searched in the default organization.
     
     Anchor
    excluserapsexcluseraps
    AdministrationPerson Element
    Data Type
    Description
    UserIdString
    Existing Yellowfin user to exclude them from the group. This could be a user ID or an email address, depending on the Logon method.
     
     Anchorexcluseragsexcluserags
    These are the main parameters that you need to set in the AdministrationGroup object for this function:
    AdministrationGroup Element
    Data Type
    Description
    GroupNameString
    Name of the group from which the users are excluded.
     
     
    Response Parameters
    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
     
     
    Instructions
    See below for step-by-step instructions on how to perform this call, using a Java example:
     Expand
    titleStep-by-step instructions
    • Start with a basic request for this function:

       Code Block
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("EXCLUDEUSERSFROMGROUPDELUSERFROMGROUP");


    • You may specify a client organization to search for the group within it. But if not included, then the group will be searched in the default (that is, the primary) organization.
       Code Block
      languagejava
      rsr.setOrgRef("org1");



    • Set parameters to identify a usersuser who is to be deleted:

       Code Block
      languagejava
      AdministrationPerson[] ap = new AdministrationPerson[1];
ap[0] = new AdministrationPerson();
ap[0].setUserId("john.smith@yellowfin.com.au");  	// must be an existing Yellowfin user

rsr.setPerson(ap);

     


    • Set parameters for the groupfor the group from which the user is to be deleted:

       Code Block
      languagejava
      AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");			//must be an existing user group

rsr.setGroup(group);
     


    • Once the request is configured, perform the call:

       Code Block
      languagejava
      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
     
     



    Complete Example
    Below is a full example of this function. To use it for yourself, carry out the following the steps:
    1. Copy the code and save it as ws_excludeusersfromgroupdeluserfromgroup.jsp.
    2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
    3. Adjust the host, port, admin user, users user to excluderemove, and the group name according to your environment.
    4. Run http://<host>:<port>/ws_excludeusersfromgroupdeluserfromgroup.jsp from your Internet browser.
     

     Code Block
    languagejava
    themeEclipse
    <%            
/*              ws_ excludeusersfromgroupdeluserfromgroup.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 the password of the above account

rsr.setOrgId(1);

rsr.setFunction("EXCLUDEUSERFROMGROUPDELUSERFROMGROUP");


//Specify the client org (if omitted, the default (primary) org groups will be searched):


rsr.setOrgRef("org1");


//Specify usersa user to exclude remove from a group:


AdministrationPerson[] ap = new AdministrationPerson[1];
ap[0] = new AdministrationPerson();
ap[0].setUserId("john.smith@yellowfin.com.au");  		// must be an existing Yellowfin useruse

rsr.setPerson(ap);


//Specify which group to remove excludeuser from:

AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");                 // must be an existing user group

rsr.setGroup(group);

AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);


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


     


     Anchor
    ...
     
    AssignDefaultDashboard
     
    AssignDefaultDashboard
     Expand
    titleDELUSERFROMGROUPASSIGNDEFAULTDASHBOARD
    This function is used to remove a specific Yellowfin user from a specific assign a particular dashboard as the default dashboard for a specified user group. On doing so, the user will not appear in the group's member list at all.This request will require the AdministrationPerson Use the ContentResource object to specify the user, dashboard and the AdministrationGroup object to define identify the user group.
     

    Request Parameters
    The following parameters will be passed with this request:
    Request Element
    Data Type
    Description
    LoginId
    String
    Yellowfin web services admin user ID. This can be the user ID or the email address, depending on the Logon ID method.
    This Yellowfin 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 services function. Set this to "DELUSERFROMGROUPASSIGNDEFAULTDASHBOARD".
    PersonAdministrationPersonObject containing details of the user who is to be deleted from the group. See table below.
    GroupAdministrationGroupObject containing details of the user group. See table below.
    OrgRefContentResourcesString
    You may include a Client Org ID to search for this group within a specific client org. If this is not specified, then the group will be searched in the default organization.
     
    ContentResource[]
    Object array containing the details of the dashboard that is to be made the default one for the group. See table below.

     Anchor
    defaultdashag
    defaultdashag
     Anchor
    deluserapdeluserap
    These are the main parameters that you need to set in the AdministrationPerson object the AdministrationGroup object for this function:
    AdministrationPerson AdministrationGroup Element
    Data Type
    Description
    UserIdGroupNameString
    An existing Yellowfin user to remove them from the group. This value could be a user ID or an email address, depending on the Logon method.
     
    Name of the group that is to be assigned a default dashboard.
    GroupIdIntegerUnique ID of the user group.

     Anchor
    defaultdashcr
    defaultdashcr
     Anchor
    deluseragdeluserag
    These are the main parameters that you need to set in the AdministrationGroup object the ContentResource object for this function:
    GroupName
    AdministrationGroup ContentResource Element
    Data Type
    Description
    ResourceIdInteger
    ID of the dashboard.
    ResourceTypeString
    Name of the group from which the user is to be deleted.
     
     
    This must be set to the fixed value "GROUP". Any elements which do not have this value set correctly will be ignored.


    Request Example
    The following SOAP example shows the parameters that you can pass to this call:
     Code Block
    languagexml
    <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>ASSIGNDEFAULTDASHBOARD</function>
            <function>DELUSERFROMGROUP</function><group>
           <person> 	<groupName>Administrators</groupName>
            	<userId>binish.sheikh@yellowfin.com.au</userId>
<groupId>11950</groupId>
            </person>group>
            <group><contentResources>
            	<groupName>Administrators<<resourceId>61251</groupName>resourceId>
           </group>     <ResourceType>GROUP</ResourceType>
                </contentResources>
         </arg0>
      </web:remoteAdministrationCall>
   </soapenv:Body>
</soapenv:Envelope>
     


    Response Parameters
    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
     


    Response Example
     
    The service will return the below response, according to our SOAP example:
     Code Block
    languagexml
    <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>ed4f6504e415411875b2c359b9384cf9<<sessionId>7b5510bf9919823f6067747b5d305984</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
    titleStep-by-step instructions
    • Start with a basic request for this function:

       Code Block
      languagejava
      AdministrationServiceRequest rsr = new AdministrationServiceRequest();

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

rsr.setFunction("DELUSERFROMGROUPASSIGNDEFAULTDASHBOARD");

    • You may specify a client organization to search for the group within it. But if not included, then the group will be searched in the default (that is, the primary) organization.
       Code Block
      languagejava
      rsr.setOrgRef("org1");

      Set parameters to identify a user who is to be deletedSpecify the group by using the AdministrationGroup object:

       Code Block
      languagejava
      AdministrationPersonAdministrationGroup apadministrationGroup = new AdministrationPersonAdministrationGroup();
apadministrationGroup.setUserIdsetGroupName("john.smith@yellowfin.com.auAdministrators");  	// must be an existing Yellowfin user

rsr.setPerson(ap);

     
    • 
administrationGroup.setGroupId(11950);

    • Use the ContentResources object to specify a dashboardSet parameters for the group from which the user is to be deleted:

       Code Block
      languagejava
      AdministrationGroupContentResource groupdashboardContentResource = new AdministrationGroup(ContentResource();
dashboardContentResource.setResourceId(61195);
groupdashboardContentResource.setGroupNamesetResourceType("AdministratorsGROUP");			//must be an existing user group

rsr.setGroup(group);
     

    • Then set this object in the request:
       Code Block
      languagejava
      rsr.setContentResources(new ContentResource[] { dashboardContentResource });


    • Once the request is configured, perform the call:

       Code Block
      languagejava
      AdministrationServiceResponse rs = adminServicenull;
rs = rssbs.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
     
     
    • the StatusCode parameter. See the Response Parameters table above for details.



    Complete Example
    Below is a full example of this function. To use it for yourself, carry out the following the steps:
    1. Copy the code and save it as ws_deluserfromgroupassigndefaultdashboard.jsp.
    2. Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
    3. Adjust the host, port, admin user, user to remove, and the group name according to your environment.
    4. Run http://<host>:<port>/ws_deluserfromgroupassigndefaultdashboard.jsp from your Internet browser.
     

     Code Block
    languagejava
    themeEclipse
    <%            
/*              ws_ deluserfromgroupassigndefaultdashboard.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 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");          // provide your Yellowfin web services admin account
rsr.setPassword("test");                           // set the password of the above account

rsr.setOrgId(new Integer(1));

rsr.setFunction("DELUSERFROMGROUPASSIGNDEFAULTDASHBOARD");


//Specify the client org (if omitted, the default (primary) org groups will be searched):


rsr.setOrgRef("org1");


//Specify a user to remove from a group:


AdministrationPerson ap This is the group 
AdministrationGroup administrationGroup = new AdministrationPersonAdministrationGroup();
apadministrationGroup.setUserIdsetGroupName("john.smith@yellowfin.com.au");  		// must be an existing Yellowfin use

rsr.setPerson(ap);
Administrators");
administrationGroup.setGroupId(11950);
    
rsr.setGroup(administrationGroup);

//Specify whichThis groupis to remove user from:

AdministrationGroup groupthe Dashboard
ContentResource dashboardContentResource = new AdministrationGroup(ContentResource();
dashboardContentResource.setResourceId(61195);
groupdashboardContentResource.setGroupNamesetResourceType("AdministratorsGROUP");
    
rsr.setContentResources(new ContentResource[] {           // must be an existing user group

rsr.setGroup(group);

AdministrationServiceResponse dashboardContentResource });
    
rs = adminServicerssbs.remoteAdministrationCall(rsr);


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