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: Response ElementsThe service will return the below response, according to our SOAP example:
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 LISTROLES function. To use it for yourself, carry out the following the steps:
|
...
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:
|
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:
These are the main parameters that you need to set in the AdministrationFunction object for this web service:
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 SAVEROLE function. To use it for yourself, carry out the following the steps:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | ||
---|---|---|
| ||
This function deletes a specified user role. You can identify this role by providing the Role Code in the AdministrationRole object. |
...
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 |
.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". |
Role | AdministrationRole | This object contains details of the role to be deleted. See table below. |
Anchor | ||||
---|---|---|---|---|
|
These are the main parameters that you need to set in the AdministrationRole object for this function:
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. |
Anchor | ||
---|---|---|
|
These are the main parameters that you need to set in the AdministrationFunction object for this web servicethe AdministrationRole object:
AdministrationFunction AdministrationRole Element | Data Type | Description |
---|---|---|
FunctionCodeRoleCode | String | To specify the internal 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. |
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> <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:
|
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> <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:
|
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 | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
| |||||||||||||||||
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>
|
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.
Code Block | ||||
---|---|---|---|---|
| ||||
<% <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:
title | Step-by-step instructions |
---|
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.) |
Role Name is mandatory even when modifying an existing role, otherwise the call will set the role name to blank:
Code Block | ||
---|---|---|
| ||
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:
|
*/
%>
<%@ 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 | ||||
---|---|---|---|---|
|
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:
Complete Example Below is a full example of the SAVEROLE function. To use it for yourself, carry out the following the steps:
|
...
Response ElementsThe response returned will contain these parameters:
|
...
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 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:
| ||
Groups | 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 | ||
---|---|---|
| ||
<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:
|
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/"><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 | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
|
|
Complete Example
Below is a full example of the DELETEROLE LISTGROUPS function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_deleterolelistgroups.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user , and role code values details according to your environment.
- Run http://<host>:<port>/ws_deleterolelistgroups.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* 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 | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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 LISTGROUPS GETGROUP function. To use it for yourself, carry out the following the steps:
|
Anchor |
---|
...
|
...
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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:
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 callThe service will return the below response, according to our SOAP example:
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 CREATEGROUP 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.)
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 CREATEGROUP MODIFYGROUP 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.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:
Anchor | | modgroupmembsap |
String | Description of the group. |
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>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:
|
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>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 | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||
|
Complete Example
Below is a full example of the MODIFYGROUP RENAMEGROUP function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_modifygrouprenamegroup.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user, group members and group name ID according to your environment.
- Run http://<host>:<port>/ws_modifygrouprenamegroup.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* 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 |
---|
...
|
...
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Call this web service to delete an existing user group from Yellowfin, by providing the group name. Request ParametersThe 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 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:
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 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. 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 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 the DELETEGROUP this function. To use it for yourself, carry out the following the steps:
|
Anchor | ||
---|---|---|
|
...
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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:
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:
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:
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 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 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 will be passed with this request:
These are the main parameters that you need to set in the AdministrationPerson object for this function:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
Anchor | | incgrpaps |
Anchor | ||||
---|---|---|---|---|
|
These are the main parameters that you need to set in the AdministrationGroup object for this function:
AdministrationGroup Element | Data Type | Description |
---|---|---|
GroupName | String | 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 | ||
---|---|---|
| ||
<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 |
---|
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. |
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>c15a0993df4f37f4dbff9b3244f41ea2</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
These are the main parameters that you need to set in the AdministrationGroup object for this function:
AdministrationGroup Element | Data Type | Description |
---|---|---|
GroupName | String | 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:
|
Instructions
See below for step-by-step instructions on how to perform this call, using a Java example:
Expand | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||
|
Complete Example
Below is a full example of this function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_includeusersingroupexcludeuserfromgroup.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user, existing usersuser to exclude, and the group name according to your environment.
- Run http://<host>:<port>/ws_includeusersingroupexcludeuserfromgroup.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* 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 | ||
---|---|---|
|
...
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 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 ParametersResponse ParametersThe response returned will contain these parameters:
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:
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:
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 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 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 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:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response ParametersThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
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:
Anchor | | excluseraps | excluseraps |
AdministrationPerson Element | Data Type | Description |
---|---|---|
UserId | String | Existing Yellowfin user to exclude them from the group. This could be a user ID or an email address, depending on the Logon method. |
These are the main parameters that you need to set in the AdministrationGroup object for this function:
AdministrationGroup Element | Data Type | Description |
---|---|---|
GroupName | String | 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:
|
Instructions
See below for step-by-step instructions on how to perform this call, using a Java example:
Expand | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
|
Complete Example
Below is a full example of this function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_excludeusersfromgroupdeluserfromgroup.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user, users user to excluderemove, and the group name according to your environment.
- Run http://<host>:<port>/ws_excludeusersfromgroupdeluserfromgroup.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* 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 |
---|
...
|
...
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 ParametersThe following parameters will be passed with this request:
These are the main parameters that you need to set in the AdministrationPerson object 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 Example
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:
|