Page History
...
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 | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||
This function returns all the user roles available in Yellowfin. The response contains an array of AdministrationRole objects displaying available roles. Request ElementsThe following elements will be passed with this request:
Request ExampleThe following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response returned will contain these parameters:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example: Expand | | ||||||||||||||||||||||||||||||
|
Code Block | |||
---|---|---|---|
| java
| ||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("LISTROLES"); |
Code Block | ||
---|---|---|
| ||
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:
|
Roles | AdministrationRole[] | List of roles |
Complete Example
Below is a full example of the LISTROLES function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_listroles.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user details according to your environment.
- Run http://<host>:<port>/ws_listroles.jsp from your Internet browser.
Code Block | ||
---|---|---|
| ||
<%<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/"> <return> <errorCode>0</errorCode> <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> <messages>Web Service Request Complete</messages> <roles> <functions> <accessLevelCode>CRUD</accessLevelCode> <functionCode>ACTIVITYSTREAM</functionCode> <functionDescription>Allows users to access the activity stream.</functionDescription> <functionName>Activity Stream</functionName> /* ws_listroles.jsp </functions> */ %> <%@ 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);<functions> <accessLevelCode>CRUD</accessLevelCode> // adjust host and port number<functionCode>TIMELINE</functionCode> AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); <functionDescription>Allows users to access their timeline.<//functionDescription> provide your Yellowfin webservices admin account rsr.setPassword("test"); <functionName>Timeline</functionName> <//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()); <functions> <accessLevelCode>CRUD</accessLevelCode> <functionCode>BROADCASTSUBSCRIBE</functionCode> <functionDescription>Allows users to subscribe to report broadcasts.</functionDescription> // uncomment to display all the<functionName>Subscribe 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()); } %> |
...
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete Example Below is a full example of the LISTROLES function. To use it for yourself, carry out the following the steps:
|
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 ElementsThe following elements will be passed with this request:
Anchor | | saveroleap | saveroleap |
AdministrationRole Element | Data Type | Description |
---|---|---|
RoleCode | String | To 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. |
RoleName | String | Name 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. |
RoleDescription | String | Description of the role. |
Functions | AdministrationFunction | This 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. |
These are the main parameters that you need to set in the AdministrationFunction object:
AdministrationFunction Element | Data Type | Description |
---|---|---|
FunctionCode | String | To specify the code of a security function. For example, to include the function Report Access, specify it with its code MIREPORT. |
AccessLevelCode | String | The 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 | ||
---|---|---|
| ||
<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> %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, <orgId>1</orgId> <function>SAVEROLE</function> 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 <role>number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = <roleCode>REPORTWRITER</roleCode> new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); <roleName>Report Content Writer</roleName> <roleDescription>This role can generate reports.</roleDescription> // provide your Yellowfin webservices admin account rsr.setPassword("test"); <functions> <functionCode>MIREPORT<//functionCode> change to be the password of the account above rsr.setOrgId(1); rsr.setFunction("LISTROLES"); AdministrationServiceResponse rs <accessLevelCode>R</accessLevelCode> </functions> </role>= 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 </arg0> to display all the </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:
|
The service will return the below response, according to our SOAP example:
Code Block | ||
---|---|---|
| ||
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
<return>
<errorCode>0</errorCode>
<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
<messages>Web Service Request Complete</messages>
<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:
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 | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||
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 ElementsThe following elements will be passed with this request:
These are the main parameters that you need to set in the AdministrationRole object for this function:
Expand | | |||||||||||||||||||||||||||||||||
|
Code Block | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
AdministrationRole role = new AdministrationRole();
|
Role Code is mandatory if you want to modify an existing role:
Code Block | ||
---|---|---|
| ||
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.) |
is mandatory even when modifying an existing role, otherwise the call will set the role name to blank |
. |
RoleDescription |
language | java |
---|
role.setRoleName("New Role");
role.setRoleDescription("testing");
Each time you call the SAVEROLE function, you need to provide a list of security functions. This call overwrites the role function. For instance, 2 functions will be assigned to the role: Report Access (mandatory) and Activity Stream (optional):
Code Block | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
role.setFunctions(f);
rsr.setRole(role);
|
Code Block | ||
---|---|---|
| ||
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:
|
String | Description of the role. | |
Functions | AdministrationFunction | This 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 | ||||
---|---|---|---|---|
|
These are the main parameters that you need to set in the AdministrationFunction object for this web service:
AdministrationFunction Element | Data Type | Description |
---|---|---|
FunctionCode | String | To specify the code of a security function. For example, to include the function Report Access, specify it with its code MIREPORT. |
AccessLevelCode | String | The 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 | ||
---|---|---|
| ||
<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>
|
Complete Example
Below is a full example of the SAVEROLE function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_saverole.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust host, port, admin user details according to your environment.
- Run http://<host>:<port>/ws_saverole.jsp from your Internet browser.
Code Block | ||
---|---|---|
| ||
<% /* ws_saverole.jsp <password>test</password> *<orgId>1</orgId> %> <%@ 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); <function>SAVEROLE</function> <role> <roleCode>REPORTWRITER<//roleCode> adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = <roleName>Report new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au");Content Writer</roleName> // provide your <roleDescription>This Yellowfinrole webcan services admin account rsr.setPassword("test");generate reports.</roleDescription> <functions> <functionCode>MIREPORT</functionCode> // 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"); <accessLevelCode>R</accessLevelCode> </functions> </role> // 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()); } %> |
...
Response ElementsThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
|
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function deletes a specified user role. You can identify this role by providing the Role Code in the AdministrationRole object.
Request ElementsThe following elements will be passed with this request:
Anchor | | delroleap | delroleap |
AdministrationRole Element | Data Type | Description |
---|---|---|
RoleCode | String | To specify the internal code of an existing role that is to be deleted. |
The following SOAP example shows the parameters that you can pass to this call:
Code Block | ||
---|---|---|
| ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/"> <soapenv:Header/> <soapenv:Body> <web:remoteAdministrationCall> <arg0> <messages>Successfully Authenticated User: <loginId>admin@yellowfinadmin@yellowfin.com.au</loginId>messages> <messages>Web Service Request <password>test<Complete</password>messages> <orgId>1</orgId><roles> <function>DELETEROLE</function> <functions> <role> <accessLevelCode>R</accessLevelCode> <roleCode>REPORTWRITER</roleCode> <functionCode>MIREPORT</functionCode> </role>functions> <roleCode>REPORTCONTENTWRITER</roleCode> <roleDescription>This role can generate reports.</roleDescription> <roleName>Report <Content Writer</arg0>roleName> </web:remoteAdministrationCall> roles> </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:
|
The service will return the below response, according to our SOAP example:
Code Block | ||
---|---|---|
| ||
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <sessionId>ceaa85d0ca1eb6057dc4facb0a7a5aa9</sessionId> <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/"> <statusCode>SUCCESS</statusCode> <return></return> <errorCode>0</errorCode></ns2:remoteAdministrationCallResponse> <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> <messages>Web Service Request Complete</messages> <roles> <roleCode>REPORTWRITER</roleCode> </roles> <sessionId>6c494a263bb684c1082317d0e1d695eb</sessionId> <statusCode>SUCCESS</statusCode> </return> </ns2:remoteAdministrationCallResponse> </S:Body> </S:Body> </S:Envelope> |
Instructions
See below for step-by-step instructions on how to perform this call, using a Java example:
Expand | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||
Once the request is configured, perform the call:
Initialize the Administration web service. Click here to learn how to do this. The response returned will contain these parameters:
|
Complete Example
Below is a full example of the DELETEROLE function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_deleterole.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user, and role code values according to your environment.
- Run http://<host>:<port>/ws_deleterole.jsp from your Internet browser.
|
Complete Example
Below is a full example of the SAVEROLE function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_saverole.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust host, port, admin user details according to your environment.
- Run http://<host>:<port>/ws_saverole.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_deleterole.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"); ws_saverole.jsp */ %> <%@ page language="java" // change to the password of the above account above rsr.setOrgId(1); rsr.setFunction("DELETEROLE"); AdministrationRole rolecontentType="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 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()); } %> |
...
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||
This function deletes a specified user role. You can identify this role by providing the Role Code in the AdministrationRole object. Request ElementsThe following elements will be passed with this request:
These are the main parameters that you need to set in the AdministrationRole object:
The following SOAP example shows the parameters that you can pass to this call:
|
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 ElementsThe following elements will be passed with this request:
The following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
Instructions
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete Example Below is a full example of the LISTGROUPS function. To use it for yourself, carry out the following the steps: Complete Example Below is a full example of the DELETEROLE function. To use it for yourself, carry out the following the steps:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
User Group Functions
Web services related to user groups are defined below:
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 ElementsThe following elements will be passed with this request:
The following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example Use this function to retrieve a specified user group with its members. Group name must be provided to the request.
Request ElementsThe following elements will be passed with this request:
Anchor | | getgrpap | getgrpap |
AdministrationGroup Element | Data Type | Description |
---|---|---|
GroupName | String | 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 | ||
---|---|---|
| ||
<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> <errorCode>0</errorCode> <arg0> <groups> <groupDescription>This group contains all users with the Admin <loginId>admin@yellowfinrole.com.au<</loginId>groupDescription> <password>test<<groupId>11950</password>groupId> <orgId>1</orgId> <groupMembers> <function>GETGROUP< <internalId>5</function>internalId> <group> <loginId>admin@yellowfin.com.au</loginId> <groupName>Administrators</groupName> </groupMembers> </group> <groupMembers> <internalId>13000</internalId> </arg0> <loginId>binish.sheikh@yellowfin.com.au</loginId> </web:remoteAdministrationCall> groupMembers> <<groupName>Administrators</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:
|
Group | AdministrationGroup[] | Group details with a list of its members. |
The service will return the below response, according to our SOAP example:
groupName>
</groups>
<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
<messages>Web Service Request Complete</messages>
<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 | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
|
Complete Example
Below is a full example of the LISTGROUPS function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_listgroups.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user details according to your environment.
- Run http://<host>:<port>/ws_listgroups.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<%
/* ws_listgroups.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 above account
rsr.setOrgId(1);
rsr.setFunction("LISTGROUPS");
//rsr.setOrgRef("org1"); // 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 | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Use this function to retrieve a specified user group with its members. Group name must be provided to the request. Request ElementsThe following elements will be passed with this request:
These are the main parameters that you need to set in the AdministrationGroup object for this function:
The following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete Example Below is a full example of the GETGROUP function. To use it for yourself, carry out the following the steps:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.) Request ElementsThe following elements will be passed with this request:
These are the main parameters that you need to set in the AdministrationGroup object for this function:
These are the main parameters that you need to set in the AdministrationGroupMembers object for this function:
The following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete Example Below is a full example of the CREATEGROUP function. To use it for yourself, carry out the following the steps:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. Request ElementsThe following elements will be passed with this request:
These are the main parameters that you need to set in the AdministrationGroup object for this function:
These are the main parameters that you need to set in the AdministrationGroupMembers object for this function:
The following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of the MODIFYGROUP function. To use it for yourself, carry out the following the steps:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 ElementsThe following elements will be passed with this request:
These are the main parameters that you need to set in the AdministrationGroup object for this function:
The following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of the RENAMEGROUP function. To use it for yourself, carry out the following the steps:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Call this web service to delete an existing user group from Yellowfin, by providing the group name. Request ParametersThe following parameters will be passed with this request:
These are the main parameters that you need to set in the AdministrationGroup object for this function:
The following SOAP example shows the parameters that you can pass to this call:
Response ParametersThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of the DELETEGROUP function. To use it for yourself, carry out the following the steps:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. Request ParametersThe following parameters will be passed with this request:
These are the main parameters that you need to set in the AdministrationPerson object for this function:
These are the main parameters that you need to set in the AdministrationGroup object for this function:
The following SOAP example shows the parameters that you can pass to this call:
Response ParametersThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this function. To use it for yourself, carry out the following the steps:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 ParametersThe following parameters will be passed with this request:
These are the main parameters that you need to set in the AdministrationPerson object array for this function:
These are the main parameters that you need to set in the AdministrationGroup object for this function:
The following SOAP example shows the parameters that you can pass to this call:
Response ParametersThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of the GETGROUP this function. To use it for yourself, carry out the following the steps:
|
Anchor |
---|
...
|
...
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.)
Request Elementsis 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. This request will require the AdministrationPerson object to specify the user, and the AdministrationGroup object to define the user group. Request ParametersThe following parameters The following elements will be passed with this request:
These are the main parameters that you need to set in the AdministrationGroup object the AdministrationPerson object for this function:
These are the main parameters that you need to set in the AdministrationGroupMembers object the AdministrationGroup object for this function:
The following SOAP example shows the parameters that you can pass to this call:
ResponseElementsParametersThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of the CREATEGROUP this function. To use it for yourself, carry out the following the steps:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. This request will require the AdministrationPerson object array to specify the users, and the AdministrationGroup object to define the user group. Request ParametersThe following parameters will be passed with this request:
These are the main parameters that you need to set in the AdministrationPerson object array for this function:
These are the main parameters that you need to set in the AdministrationGroup object for this function:
Response ParametersThe response returned will contain these parameters:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
Request ElementsThe following elements will be passed with this request:
Anchor | | modgrpap | modgrpap |
AdministrationGroup Element | Data Type | Description |
---|---|---|
GroupName | String | Name of the group. |
GroupMembers | AdministrationGroupMembers | This object can be used to provide details of the group members. See the table below. |
These are the main parameters that you need to set in the AdministrationGroupMembers object for this function:
AdministrationGroupMembers Element | Data Type | Description |
---|---|---|
LoginId | String | 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 call:
Code Block | ||
---|---|---|
| ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
<soapenv:Header/>
<soapenv:Body>
<web:remoteAdministrationCall>
<arg0>
<loginId>admin@yellowfin.com.au</loginId>
<password>test</password>
<orgId>1</orgId>
<function>MODIFYGROUP</function>
<group>
<groupName>Supervisors</groupName>
<groupMembers>
<loginId>admin@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:
|
The service will return the below response, according to our SOAP example:
Code Block | ||
---|---|---|
| ||
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
<return>
<errorCode>0</errorCode>
<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
<messages>Web Service Request Complete</messages>
<sessionId>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 | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||
|
Complete Example
Below is a full example of the MODIFYGROUP this function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_modifygroupexcludeusersfromgroup.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user, group members and users to exclude, and the group name according to your environment.
- Run http://<host>:<port>/ws_modifygroupexcludeusersfromgroup.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_modifygroup excludeusersfromgroup.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("MODIFYGROUPEXCLUDEUSERFROMGROUP"); //Specify the client org (if omitted, the default (primary) org groups will be searched): rsr.setOrgRef("org1"); //Set parameters of the new group: AdministrationGroup groupSpecify users to exclude: AdministrationPerson[] ap = new AdministrationPerson[1]; ap[0] = new AdministrationGroupAdministrationPerson(); group.setGroupName("Test Groupap[0].setUserId("john.smith@yellowfin.com.au"); // mandatory. Other parameters are optional.must be an existing Yellowfin user rsr.setPerson(ap); //Add members: AdministrationGroupMember[] member = new AdministrationGroupMember[1]; member[0]Specify which group to exclude from: AdministrationGroup group = new AdministrationGroupMemberAdministrationGroup(); member[0].setLoginId("admin@yellowfin.com.au"); group.setGroupMembers(member);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 |
---|
...
|
...
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function is used to rename a group. Use 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 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 Elementsdefine the user group. Request ParametersThe following parameters The following elements will be passed with this request:
These are the main parameters that you need to set in the AdministrationGroup object the AdministrationPerson object for this function:
These are the main parameters that you need to set in the AdministrationGroup object for this function:
The following SOAP example shows the parameters that you can pass to this call:
ResponseElementsParametersThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of the RENAMEGROUP this function. To use it for yourself, carry out the following the steps:
|
Anchor |
---|
|
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function is used to assign a particular dashboard as the default dashboard for a specified user group. Use the ContentResource object to specify the dashboard and the AdministrationGroup object to identify the user group. Call this web service to delete an existing user group from Yellowfin, by providing the group name.
Request ParametersThe following parameters will be passed with this request:
These are the main parameters that you need to set in the AdministrationGroup object for this function:
These are the main parameters that you need to set in the AdministrationGroup object the ContentResource object for this function:
Request ExampleThe following SOAP example shows the parameters that you can pass to this call:
Response ParametersThe response returned will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of the DELETEGROUP this function. To use it for yourself, carry out the following the steps:
|