Page History
User groups and roles can be created and modified with the web service calls discussed in this section.
Note: If the Client Org functionality is switched on in the Configuration page, a Client Org can also be specified where applicable for certain types of calls.
User Role Functions
These web services are specific to Yellowfin user roles.
Note |
---|
When using LDAP authentication, any web services that return a role, will return the role that the LDAP user last logged in with successfully. (This role is updated every time an LDAP user logs in.) |
Anchor | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||
This function returns all the user roles available in Yellowfin. The response contains an array of AdministrationRole objects displaying available roles. Request ElementsThe following elements will be passed with this request:
Request ExampleThe following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response returned will contain these parameters:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example: Expand | | |||||||||||||||||||||||||||||
|
Code Block | |||
---|---|---|---|
| java
| ||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("LISTROLES"); |
Code Block | ||
---|---|---|
| ||
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
|
Initialize the Administration web service. Click here to learn how to do this.
The response returned will contain these parameters:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
Roles | AdministrationRole[] | List of roles |
Complete Example
Below is a full example of the LISTROLES function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_listroles.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user details according to your environment.
- Run http://<host>:<port>/ws_listroles.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<%<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/"> <return> <errorCode>0</errorCode> <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages> <messages>Web Service Request Complete</messages> <roles> /* <functions> ws_listroles.jsp *<accessLevelCode>CRUD</accessLevelCode> %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> <% AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); <functionCode>ACTIVITYSTREAM</functionCode> // adjust host and<functionDescription>Allows portusers number AdministrationServiceSoapBindingStubto adminServiceaccess =the (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au");activity stream.</functionDescription> <functionName>Activity Stream<//functionName> provide your Yellowfin webservices admin account rsr.setPassword("test"); </functions> <functions> // change to be the password of the account above rsr.setOrgId(1); rsr.setFunction("LISTROLES"); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success.<br>Available Roles:"); AdministrationRole[] roles = rs.getRoles(); for (AdministrationRole role: roles){ out.write("<br>"); out.write("<br>Role Name: " + role.getRoleName()); out.write("<br>Role Code: " + role.getRoleCode()); out.write("<br>Role Description: " + role.getRoleDescription()); <accessLevelCode>CRUD</accessLevelCode> <functionCode>TIMELINE</functionCode> <functionDescription>Allows users to access their timeline.</functionDescription> // uncomment to display all the security functions: /* out.write("<br>Function Name | Code | Description | TypeCode | AccessLevelCode"); for (AdministrationFunction f: role.getFunctions()){ out.write("<br>" + f.getFunctionName() + " | " + f.getFunctionCode() + " | " + f.getFunctionDescription() + " | " + f.getFunctionTypeCode() + " | " + f.getAccessLevelCode()); } */ } } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %> |
...
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function creates a new role and/or updates a role's functions. The request must contain an AdministrationRole object to specify the role details, and an array of AdministrationFunction for the role. Whether this function is used to update a role, or create a new one, it should be noted that every Yellowfin role requires a mandatory function, Report Access (function code: MIREPORT). MIREPORT must have its access level code set to at least R (read). Each time this function is called, the security functions will be overwritten.
Request ElementsThe following elements will be passed with this request:
Anchor | | saveroleap | saveroleap |
AdministrationRole Element | Data Type | Description |
---|---|---|
RoleCode | String | To specify the internal code of an existing role. This parameter must be included if you want to update a role that already exists. If unspecified, a new role will be created, even if one with the same name already exists. |
RoleName | String | Name of the new or existing role. This is mandatory even when modifying an existing role, otherwise the call will set the role name to blank. |
RoleDescription | String | Description of the role. |
Functions | AdministrationFunction | This object contains a list of security functions. These will be overwritten every time the Save Role function is called. The function Report Access is mandatory. See table below for more details. |
These are the main parameters that you need to set in the AdministrationFunction object for this web service:
AdministrationFunction Element | Data Type | Description |
---|---|---|
FunctionCode | String | To specify the code of a security function. For example, to include the function Report Access, specify it with its code MIREPORT. |
AccessLevelCode | String | The access level of the function. For example, R means read. |
The following SOAP example shows the parameters that you can pass to this call:
Code Block | ||
---|---|---|
| ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/"> <soapenv:Header/> <soapenv:Body> <web:remoteAdministrationCall> <arg0><functionName>Timeline</functionName> </functions> <functions> <accessLevelCode>CRUD</accessLevelCode> <functionCode>BROADCASTSUBSCRIBE</functionCode> <functionDescription>Allows users to subscribe to report broadcasts.</functionDescription> <functionName>Subscribe to Broadcast</functionName> </functions> <functions> <accessLevelCode>R</accessLevelCode> <functionCode>STORYBOARD</functionCode> <functionDescription>Allows users to view, create, edit or delete Storyboards.</functionDescription> <functionName>Storyboard</functionName> </functions> <functions> <accessLevelCode>R</accessLevelCode> <functionCode>DASHPUBLIC</functionCode> <functionDescription>Allows users to create and edit Public dashboards.</functionDescription> <functionName>Public Dashboards</functionName> </functions> <functions> <accessLevelCode>CRUD</accessLevelCode> <functionCode>TASKPERSONAL</functionCode> <functionDescription>Allow users to create and assign tasks to themselves.</functionDescription> <functionName>Personal Tasks</functionName> </functions> . . . <roleCode>YFADMIN</roleCode> <roleDescription>This user has the widest range of access to the system, and as such you should have a very limited number of people assigned this role. They can do everything from create content through to managing system tasks.</roleDescription> <roleName>System Administrator</roleName> </roles> <sessionId>4f86f0e30e30bf4b07dea21267de0a74</sessionId> <statusCode>SUCCESS</statusCode> <loginId>admin@yellowfin.com.au</loginId></return> <password>test</password></ns2:remoteAdministrationCallResponse> <orgId>1</orgId> <function>SAVEROLE</function> <role> <roleCode>REPORTWRITER</roleCode> <roleName>Report Content Writer</roleName> <roleDescription>This role can generate reports.</roleDescription> <functions> <functionCode>MIREPORT</functionCode> <accessLevelCode>R</accessLevelCode> </functions> </role></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 LISTROLES function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_listroles.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user details according to your environment.
- Run http://<host>:<port>/ws_listroles.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% /* ws_listroles.jsp </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:
*/
%>
<%@ page language="java" contentType="text/html; charset=UTF-8" %>
<%@ page import="com.hof.util.*, java.util.*, java.text.*" %>
<%@ page import="com.hof.web.form.*" %>
<%@ page import="com.hof.mi.web.service.*" %>
<%
AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); // adjust host and port number
AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService();
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin webservices admin account
rsr.setPassword("test"); // change to be the password of the account above
rsr.setOrgId(1);
rsr.setFunction("LISTROLES");
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
if ("SUCCESS".equals(rs.getStatusCode()) ) {
out.write("Success.<br>Available Roles:");
AdministrationRole[] roles = rs.getRoles();
for (AdministrationRole role: roles){
out.write("<br>");
out.write("<br>Role Name: " + role.getRoleName());
out.write("<br>Role Code: " + role.getRoleCode());
out.write("<br>Role Description: " + role.getRoleDescription());
// uncomment to display all the security functions:
/*
out.write("<br>Function Name | Code | Description | TypeCode | AccessLevelCode");
for (AdministrationFunction f: role.getFunctions()){
out.write("<br>" + f.getFunctionName() + " | "
+ f.getFunctionCode() + " | "
+ f.getFunctionDescription() + " | "
+ f.getFunctionTypeCode() + " | "
+ f.getAccessLevelCode());
}
*/
}
} else {
out.write("Failure");
out.write(" Code: " + rs.getErrorCode());
}
%>
|
Anchor | ||||
---|---|---|---|---|
|
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:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
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.
</arg0>
</web:remoteAdministrationCall>
</soapenv:Body>
</soapenv:Envelope> Response ElementsThe response returned will contain these parameters:
The service will return the below response, according to our SOAP example:
Then feed the security functions to the role:
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 SAVEROLE 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 GETGROUP function. To use it for yourself, carry out the following the steps:
|
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||
This function deletes a specified user role. You can identify this role by providing the Role Code in the AdministrationRole object.
Request ElementsThe following elements will be passed with this request:
Anchor | | delroleap | delroleap |
AdministrationRole Element | Data Type | Description |
---|---|---|
RoleCode | String | To specify the internal code of an existing role that is to be deleted. |
The following SOAP example shows the parameters that you can pass to this call:
Code Block | ||
---|---|---|
| ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.web.mi.hof.com/"> <soapenv:Header/> <soapenv:Body> <web:remoteAdministrationCall> */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> <% AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); // adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin web services admin account rsr.setPassword("test"); // change to the password of the account above rsr.setOrgId(1); rsr.setFunction("GETGROUP"); //rsr.setOrgRef("org1"); <arg0> // provide org <loginId>admin@yellowfin.com.au</loginId> <password>test</password> <orgId>1</orgId> <function>DELETEROLE</function> <role> <roleCode>REPORTWRITER</roleCode> </role> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope> |
Response Elements
The response returned will contain these parameters:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
The service will return the below response, according to our SOAP example:
Code Block | ||
---|---|---|
| ||
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:remoteAdministrationCallResponse xmlns:ns2="http://webservices.web.mi.hof.com/">
<return>
<errorCode>0</errorCode>
<messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>
<messages>Web Service Request Complete</messages>
<roles>
<roleCode>REPORTWRITER</roleCode>
</roles>
<sessionId>6c494a263bb684c1082317d0e1d695eb</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 |
---|
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());
}
%>
|
Anchor | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Use this function to retrieve the all user groups which a user belongs to. It accepts AdministrationPerson as a parameter to identify the user. The response will contain an array of AdministrationGroup objects. Request ElementsThe following elements will be passed with this request:
Set either one of these parameters in the AdministrationPerson object:
If both are set, IpId will be used by default. Request ExampleThe following SOAP example shows the parameters that you can pass to this call:
Once the request is configured, perform the call:
Initialize the Administration web service. Click here to learn how to do this. The response returned will contain these parameters:
Complete Example Below is a full example of the DELETEROLE function. To use it for yourself, carry out the following the steps:
|
User Group Functions
Web services related to user groups are defined below:
...
Response ElementsThe response returned will contain these parameters:
|
...
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:
Response ExampleThe service will return the below response, according to our SOAP exampleThe 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: Expand | | |||||||||||||||||||||||||||||||||||||||||
|
Code Block | ||
---|---|---|
| ||
AdministrationServiceRequest rsr = new AdministrationServiceRequest();
rsr.setLoginId("admin@yellowfin.com.au");
rsr.setPassword("test");
rsr.setOrgId(1);
rsr.setFunction("LISTGROUPS"); |
Include a Client Org ID to list groups specific to that client. (If not included, then the default (that is, the Primary Org) groups will be displayed).
Code Block | ||
---|---|---|
| ||
rsr.setOrgRef("org1");
|
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:
|
Groups | AdministrationGroup[] | List of groups |
You can retrieve members of each group by using AdministrationGroup.getGroupMembers(). This will retrieve an array of AdministrationGroupMember. Keep in mind that if the group has a user role as a member, it will not be retrieved. Only user accounts will be retrieved via getGroupMembers().
Complete Example
Below is a full example of the LISTGROUPS function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_listgroups.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user details according to your environment.
- Run http://<host>:<port>/ws_listgroups.jsp from your Internet browser.
Code Block | ||||
---|---|---|---|---|
| ||||
<% </messages> <parentDashboard xsi:type="ns2:ParentDashboard" xsi:nil="true"/> <parentDashboards xsi:type="ns2:ArrayOfParentDashboard" xsi:nil="true"/> <parentReportGroups xsi:type="soapenc:Array" xsi:nil="true"/> <people xsi:type="ns2:ArrayOfAdministrationPerson" xsi:nil="true"/> <person xsi:type="ns2:AdministrationPerson" xsi:nil="true"/> <personfavourites xsi:type="ns2:ArrayOfPersonFavourite" /*xsi:nil="true"/> <queryResults ws_listgroups.jsp xsi:type="ns2:ArrayOfReportRow" xsi:nil="true"/> */ %> <%@ 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);<report xsi:type="ns2:AdministrationReport" xsi:nil="true"/> <reportGroups xsi:type="ns2:ArrayOfAdministrationReportGroup" xsi:nil="true"/> // adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au");<reportId xsi:type="xsd:int" xsi:nil="true"/> <reports xsi:type="ns2:ArrayOfAdministrationReport" // provide your Yellowfin web services admin account rsr.setPassword("test"); xsi:nil="true"/> <roles xsi:type="ns2:ArrayOfAdministrationRole" xsi:nil="true"/> <schedule xsi:nil="true"/> <schedules xsi:type="ns3:ArrayOfAdministrationSchedule" xsi:nil="true" xmlns:ns3="http:// change to the password of the above account rsr.setOrgId(1); rsr.setFunction("LISTGROUPS"); //rsr.setOrgRef("org1");schedule.service.web.mi.hof.com"/> <sessionId xsi:type="xsd:string">974c65a870699f6f4059ba54c15ddc6c</sessionId> <statusCode xsi:type="xsd:string">SUCCESS</statusCode> <//multiRef> 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()); } %> |
...
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:
Anchor | | getgrpap | getgrpap |
AdministrationGroup Element | Data Type | Description |
---|---|---|
GroupName | String | Specify name of the user group to retrieve its details and member list. |
The following SOAP example shows the parameters that you can pass to this call:
Code Block | ||
---|---|---|
| ||
<soapenv:Envelope xmlns:soapenv<multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns4:AdministrationGroup" xmlns:ns4="http://service.web.mi.hof.com" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"> <groupDescription xsi:type="xsd:string">This group contains all users with the Admin role.</groupDescription> <groupId xsi:type="xsd:int">11950</groupId> <groupInternalReference xsi:type="xsd:string" xsi:nil="true"/> <groupMembers soapenc:arrayType="ns4:AdministrationGroupMember[1]" xsi:type="soapenc:Array"> <groupMembers href="#id2"/></groupMembers> <groupName xsi:type="xsd:string">Administrators</groupName> <groupStatus xsi:type="xsd:string" xsi:nil="true"/> </multiRef> <multiRef id="id2" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/envelope/encoding/" xsi:type="ns5:AdministrationGroupMember" xmlns:webns5="http://webservicesservice.web.mi.hof.com/"> <soapenv:Header/ xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"> <soapenv:Body> <web:remoteAdministrationCall> <internalId xsi:type="xsd:int">5</internalId> <arg0> <loginId>admin@yellowfin<loginId xsi:type="xsd:string">admin@yellowfin.com.au</loginId> <password>test</password></multiRef> <orgId>1</orgId> <function>GETGROUP</function> <group> <groupName>Administrators</groupName> </group> </arg0> </web:remoteAdministrationCall> </soapenv:Body> </soapenv:Envelope> |
Response Elements
</soapenv:Body>
</soapenv:Envelope>
|
Instructions
See below for step-by-step instructions on how to perform this call, using a Java example:
Expand | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||
|
- SUCCESS
- FAILURE
Group
Group details with a list of its members.
|
Complete Example
Below is a full example of the GETUSERGROUPS function. To use it for yourself, carry out the following the steps:
- Copy the code and save it as ws_getusergroups.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user details according to your environment.
- Run http://<host>:<port>/ws_getusergroups.jsp from your Internet browser.
Code Block | ||
---|---|---|
| ||
<%
/* |
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> <group> <groupDescription>This group contains all users with the Admin role.</groupDescription> <groupId>11950</groupId> <groupMembers> <internalId>5</internalId> <loginId>admin@yellowfin.com.au</loginId> </groupMembers> <groupMembers> ws_getusergroups.jsp <internalId>13000<*/internalId> %> <%@ page contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.mi.web.service.AdministrationGroup" %> <%@ page import="com.hof.mi.web.service.AdministrationGroupMember" %> <%@ page import="com.hof.mi.web.service.AdministrationPerson" %> <%@ <loginId>binish.sheikh@yellowfin.com.au</loginId> </groupMembers> <groupName>Administrators</groupName> <groupStatus>OPEN</groupStatus> </group> <messages>Successfully Authenticated User: admin@yellowfin.com.au</messages>page import="com.hof.mi.web.service.AdministrationServiceRequest" %> <%@ page import="com.hof.mi.web.service.AdministrationServiceResponse" %> <%@ page import="com.hof.mi.web.service.AdministrationServiceService" %> <%@ page import="com.hof.mi.web.service.AdministrationServiceServiceLocator" %> <%@ page import="com.hof.mi.web.service.AdministrationServiceSoapBindingStub" %> <% // Adjust host and port number AdministrationServiceService adminServiceService = new AdministrationServiceServiceLocator( <messages>Web Service Request Complete</messages>"localhost", 8080, <sessionId>54c5cf263f323b439c5834d1f6d8b645</sessionId>"/services/AdministrationService", <statusCode>SUCCESS</statusCode>false </return>); AdministrationServiceSoapBindingStub </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 | ||||
---|---|---|---|---|
| ||||
Code Block | ||||
| ||||
Displayed below is a basic request for this function: Code Block | | |||
|
Code Block | ||
---|---|---|
| ||
rsr.setOrgRef("org1");
|
Code Block | ||
---|---|---|
| ||
AdministrationGroup group = new AdministrationGroup();
group.setGroupName("Administrators");
rsr.setGroup(group); |
Once the request is configured, perform the call:
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:
|
Group | AdministrationGroup[] | Group with members |
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.
<% /* ws_getgroup.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); // Provide org reference if required. Default org groups will be retrieved otherwise // rsr.setOrgRef("org1"); // Provide userId or ipId of the user AdministrationPerson ap = new AdministrationPerson(); // Set one of userId and ipId. If both are set, ipId will be used by default. // ap.setUserId("admin@yellowfin.com.au"); ap.setIpId(1); rsr.setPerson(ap); // Set the first item in the parameters array as "true" or "false" (String, case insensitive) to indicate // whether to include AdministrationGroupMember objects in the returned AdministrationGroup objects. // If true, the returned groups will contain the information of all their members. rsr.setParameters(new String[]{"TRUE"}); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode())) { out.write("Success.<br><br>Groups which the user belongs to:"); AdministrationGroup[] groups = rs.getGroups(); //for adjust(AdministrationGroup hostgroup and: portgroups) number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au");{ out.write("<br>"); out.write("<br>Group Name: " + group.getGroupName()); // provide your Yellowfin web services admin account rsr.setPassword("test"); out.write("<br>Group Id: " + group.getGroupId()); out.write("<br>Group Description: " + group.getGroupDescription()); // change to the password of the account above rsr.setOrgId(1); rsr.setFunction("GETGROUP"); //rsr.setOrgRef("org1"); out.write("<br>Group Status: " + group.getGroupStatus()); out.write("<br>Group Internal Reference: " + group.getGroupInternalReference()); // provide org reference ID if required. Default// orgUncomment willto bedisplay searchedthe otherwisemembers: AdministrationGroup group = new AdministrationGroup(); group.setGroupName("Administrators"); rsr.setGroup(group); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success.<br><br><br>Members:<br>Login Id | Internal Id "); group = rs.getGroup(); for (AdministrationGroupMember member : group.getGroupMembers()) { out.write("<br>"); out.write("<br>Group Name: + member.getLoginId() + " | " + groupmember.getGroupNamegetInternalId()); out.write("<br>Group Id: " + group.getGroupId()); out.write("<br>Group Description: " + group.getGroupDescription()); out.write("<br>Group Status: " + group.getGroupStatus()); } } } else { out.write("Failure"); out.write("<br>Group Internal ReferenceCode: " + grouprs.getGroupInternalReferencegetErrorCode()); // display the members: out.write("<br>Members:<br>Login Id | Internal Id "); for (AdministrationGroupMember member: group.getGroupMembers()){ <br><br>Messages:"); for (String msg : rs.getMessages()) { out.write("<br>"); + member.getLoginId() + " | " + member.getInternalId() ); } } else { out.write("Failure"msg); out.write(" Code: " + rs.getErrorCode()); } %> |
}
}
%> |
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 this function. To use it for yourself, carry out the following the steps:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This function is used to add a specific multiple users to a specific user group, but with an "exclude" tag. Note that these users are not actually removed from the group, but will exist as an excluded members. This request will require the AdministrationPerson object array to specify the users, and the AdministrationGroup object to define the user group. Request ParametersThe following parameters will be passed with this request:
These are the main parameters that you need to set in the AdministrationPerson object array for this function:
These are the main parameters that you need to set in the AdministrationGroup object for this function:
Response ParametersThe response returned will contain these parameters:
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 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:
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 assign a particular dashboard as the default dashboard for a specified user group. Use the ContentResource object to specify the dashboard and the AdministrationGroup object to identify the user group.
Request ParametersThe following parameters will be passed with this request:
These are the main parameters that you need to set in the AdministrationGroup object for this function:
These are the main parameters that you need to set in the ContentResource object for this function:
Request ExampleThe following SOAP example shows the parameters that you can pass to this call:
Response ParametersThe response returned will contain these parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this function. To use it for yourself, carry out the following the steps:
|