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:
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. 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:
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 DELETEROLE function. To use it for yourself, carry out the following the steps:
|
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:
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:
|
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 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:
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 LISTROLES 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 |
...
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 access level code must be 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 to create a new role:
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 AdministrationPerson object array for this function:
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: Expand | | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Existing Yellowfin user to exclude them from the group. This could be a user ID or an email address, depending on the Logon method. |
Anchor | ||||
---|---|---|---|---|
|
These are the main parameters that you need to set in the AdministrationGroup object
Displayed below is a basic requestfor this function:
codeAdministrationGroup 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 | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
java | AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("SAVEROLE"); Then define a role:
|
Complete Example
Below is a full example of the SAVEROLE this function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_saveroleexcludeusersfromgroup.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user details , users to exclude, and the group name according to your environment.
- Run http://<host>:<port>/ws_saveroleexcludeusersfromgroup.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_saverole 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("EXCLUDEUSERFROMGROUP"); //Specify the client org (if omitted, the default (primary) org groups will // change to the password of the account above rsr.setOrgId(1);be searched): rsr.setFunctionsetOrgRef("SAVEROLEorg1"); //defineSpecify users ato roleexclude: AdministrationRoleAdministrationPerson[] roleap = new AdministrationRole(); role.setRoleCode("NEWROLE"); role.setRoleName("New Role"); role.setRoleDescription("testing"); AdministrationFunction[] f = new AdministrationFunction[2]; f[0]AdministrationPerson[1]; ap[0] = new AdministrationPerson(); ap[0].setUserId("john.smith@yellowfin.com.au"); // must be an existing Yellowfin user rsr.setPerson(ap); //Specify which group to exclude from: AdministrationGroup group = new AdministrationFunctionAdministrationGroup(); f[0].setFunctionCodegroup.setGroupName("MIREPORTAdministrators"); // mandatory f[0].setAccessLevelCode("R" must be an existing user group rsr.setGroup(group); f[1]AdministrationServiceResponse rs = new AdministrationFunction(); f[1].setFunctionCode("ACTIVITYSTREAM"); f[1].setAccessLevelCode("CRUD"); //Feed the security functions to the role: role.setFunctions(f); rsr.setRole(role); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %> |
...
|
Anchor | ||||
---|---|---|---|---|
|
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 | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||
This function deletes a user role, which is specified using the AdministrationRole object, by providing the Role Code. Displayed below is a basic request for this function:
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 the DELETEROLE function. To use it for yourself, carry out the following the steps:
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:
|
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
The LISTGROUPS function returns all the 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. Displayed below is a basic request for this function
| |||||||||||||||||||||||||||||||||||||||||||||
Groups | AdministrationGroup[] | List of groups |
Complete Example
Below is a full example of the LISTGROUPS this function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_listgroupsdeluserfromgroup.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user details , user to remove, and the group name according to your environment.
- Run http://<host>:<port>/ws_listgroupsdeluserfromgroup.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_listgroups deluserfromgroup.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 toset the password of the above account rsr.setOrgId(1); rsr.setFunction("LISTGROUPSDELUSERFROMGROUP"); //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() ); } */ } }Specify the client org (if omitted, the default (primary) org groups will be searched): rsr.setOrgRef("org1"); //Specify a user to remove from a group: AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("john.smith@yellowfin.com.au"); // must be an existing Yellowfin use rsr.setPerson(ap); //Specify which group to remove user 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Use this This function to retrieve is used to assign a particular dashboard as the default dashboard for a specified user group with its members. Group name should be provided to the request. Client org reference Id can be passed to manipulate with the client content otherwise default (primary) org will be searched. Displayed below is a basic request for this function:
Include a Client Org ID to list groups specific to that client. (If not included, then the default (that is, the Primary Org) groups will be displayed).
Once the request is configured, perform the call:
Initialize the Administration web service. Click here to learn how to do this. . Use the ContentResource object to specify the dashboard and the AdministrationGroup object to 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 AdministrationGroup object for this function:
The response returned will contain these parameters: Response
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Group | AdministrationGroup[] | Group with members |
group that is to be assigned a default dashboard. | ||
GroupId | Integer | Unique ID of the user group. |
Anchor | ||||
---|---|---|---|---|
|
These are the main parameters that you need to set in the ContentResource object for this function:
ContentResource Element | Data Type | Description |
---|---|---|
ResourceId | Integer | ID of the dashboard. |
ResourceType | String | This must be set to the fixed value "GROUP". Any elements which do not have this value set correctly will be ignored. |
Request Example
The following SOAP example shows the parameters that you can pass to this call:
Code Block | ||
---|---|---|
| ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/">
<soapenv:Header/>
<soapenv:Body>
<web:remoteAdministrationCall>
|
Code Block | ||
---|---|---|
| ||
AdministrationGroupMember[] members = rs.getGroup().getGroupMembers();
|
Tip |
---|
You can use AdministrationGroupMember.getInternalId() to get the IpId of the Yellowfin account. Then pass it to a GETUSERBYIP call to retrieve the AdministrationPerson object for the user. |
Complete Example
Below is a full example of the GETGROUP function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_getgroup.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user and group name according to your environment.
- Run http://<host>:<port>/ws_getgroup.jsp from your Internet browser.
Code Block | ||
---|---|---|
| ||
<% /* <arg0> <loginId>admin@yellowfin.com.au</loginId> ws_getgroup.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>ASSIGNDEFAULTDASHBOARD</function> <group> <groupName>Administrators</groupName> // adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); <groupId>11950</groupId> </group> // provide your<contentResources> Yellowfin web services admin account rsr.setPassword("test"); <resourceId>61251</resourceId> <ResourceType>GROUP</ResourceType> // change to the password of the account above rsr.setOrgId(1); rsr.setFunction("GETGROUP"); //rsr.setOrgRef("org1"); </contentResources> </arg0> // provide org reference ID if required. Default org will be searched otherwise AdministrationGroup group = new AdministrationGroup(); group.setGroupName("Administrators"); rsr.setGroup(group); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success.<br>"); group = rs.getGroup(); out.write("<br>"); out.write("<br>Group Name: " + group.getGroupName()); out.write("<br>Group Id: " + group.getGroupId()); out.write("<br>Group Description: " + group.getGroupDescription()); out.write("<br>Group Status: " + group.getGroupStatus()); out.write("<br>Group Internal Reference: " + group.getGroupInternalReference()); // display the members: out.write("<br>Members:<br>Login Id | Internal Id "); for (AdministrationGroupMember member: group.getGroupMembers()){ out.write("<br>" + member.getLoginId() + " | " + member.getInternalId() ); } } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %> |
title | CREATEGROUP |
---|
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> |
Response Parameters
The response returned will contain these parameters:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
Response Example
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>7b5510bf9919823f6067747b5d305984</sessionId>
<statusCode>SUCCESS</statusCode>
</return>
</ns2:remoteAdministrationCallResponse>
</S:Body>
</S:Envelope> |
Instructions
See below for step-by-step instructions on how to perform this call, using a Java example:
Expand | ||
---|---|---|
| ||
|
Creates a new user group in the client org provided. If the client reference Id is omitted, the group will be created in default (primary) org. The call requires AdministrationGroup object where you provide new group details. If you supply new group members via AdministrationGroupMember, the members will be added to the created group (this must be existing Yellowfin users).
Client org reference Id can be passed to manipulate with the client content otherwise default (primary) org will be used.
Displayed below is
|
|
|
Code Block | ||
---|---|---|
| ||
rsr.setOrgRef("org1");
|
|
|
|
|
language | java |
---|
|
|
|
|
|
|
|
|
|
|
Response Element
Data Type
Description
StatusCode
String
Status of the web service call. Possible values include:
|
Complete Example
Below is a full example of the CREATEGROUP this function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_creategroupassigndefaultdashboard.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user, group members and user to remove, and the group name according to your environment.
- Run http://<host>:<port>/ws_creategroupassigndefaultdashboard.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_creategroupassigndefaultdashboard.jsp */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> <% AdministrationServiceService s_adm AdministrationServiceResponse rs = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false)null; AdministrationServiceSoapBindingStubAdministrationServiceRequest adminServicersr = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationServicenew AdministrationServiceRequest(); AdministrationServiceRequestAdministrationServiceService rsrts = new AdministrationServiceRequest(); rsr.setLoginIdAdministrationServiceServiceLocator("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("CREATEGROUP"); //Specify client org (if omitted, the group will be created in the default (primary) org): rsr.setOrgRef("org1"); //Set parameters of the new group: AdministrationGroup group = new AdministrationGroup(); group.setGroupName("Test Group"); // mandatory. Other parameters are optional. //Add members: AdministrationGroupMember[] member = new AdministrationGroupMember[2]; member[0] = new AdministrationGroupMember(); member[0].setLoginId("admin@yellowfin.com.au"); member[1] = new AdministrationGroupMember(); member[1].setLoginId("john.smith@yellowfin.com.au"); group.setGroupMembers(member); rsr.setGroup(group); AdministrationServiceResponse rs = adminServicelocalhost", 8080, "/services/AdministrationService", false); AdministrationServiceSoapBindingStub rssbs = (AdministrationServiceSoapBindingStub) ts.getAdministrationService(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(new Integer(1)); rsr.setFunction("ASSIGNDEFAULTDASHBOARD"); // This is the group AdministrationGroup administrationGroup = new AdministrationGroup(); administrationGroup.setGroupName("Administrators"); administrationGroup.setGroupId(11950); rsr.setGroup(administrationGroup); // This is the Dashboard ContentResource dashboardContentResource = new ContentResource(); dashboardContentResource.setResourceId(61195); dashboardContentResource.setResourceType("GROUP"); rsr.setContentResources(new ContentResource[] { dashboardContentResource }); rs = rssbs.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCodetoString() ); } %> |