User replication involves synchronising each user in the OEM application with a named user in Yellowfin.
This allows Yellowfin to identify the user who is logged in, and to apply any restrictions that may be required. Synchronisation is usually performed using web service calls from the OEM application to Yellowfin. This can also be managed manually if users in the OEM application are generally static.
This section will outline how to create, manipulate, and delete users via web services. It is assumed that the web service is called to mirror user changes immediately after a user modification is made in the OEM application.
Main Functions
Creates a new user account in Yellowfin.
Here's a basic request to create a new Yellowfin user:
AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("ADDUSER");
If you need to create a new user in a specific client organization, add this to your code
rsr.setOrgRef("org1"); // A new user will be added to the client with "org1" as an organization reference ID
If you do not define the orgRef parameter, the new user will be created in the default (primary) organization.
The ADDUSER function requires AdministrationPerson object where you define the new Yellowfin user details:
AdministrationPerson ap = new AdministrationPerson();
To create a new user, you need to fill these mandatory parameters: UserId, FirstName, LastName, RoleCode, Password, EmailAddress:
ap.setUserId("john.smith@yellowfin.com.au"); // if Yellowfin authentication option is set "email address" ap.setFirstName("John"); ap.setLastName("Smith"); ap.setRoleCode("YFREPORTCONSUMER"); // Yellowfin role codes can be found performing this query against // Yellowfin configuration database: SELECT * FROM OrgRole ap.setPassword("test"); // Password must comply with your Yellowfin password policy ap.setEmailAddress("john.smith@yellowfin.com.au");
Other parameters of AdministrationPerson object are optional.
Pass the 'ap' object to the request:
rsr.setPerson(ap);
Once the request is configured, carry out the call:
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
- Then initialize the Administration web service. Click here to learn how to do this.
The response returned will contain these parameters:
Response Element
Data Type
Description
StatusCode
String
Status of the web service call. Possible values include:
- SUCCESS
- FAILURE
Complete Example of ADDUSER
Following is a full example of this function, that you can use in your code. Follow these steps first:
- Copy the code and save it as ws_adduser.jsp.
- Put the file in the root folder, which is Yellowfin/appserver/webapps/ROOT.
- Adjust host, port, admin user and user to add details according to your environment.
- Run http://<host>:<port>/ws_adduser.jsp from your Internet browser.
<% /* ws_adduser.jsp */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> <% AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); // adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin webservices admin account rsr.setPassword("test"); // change to be the password of the account above rsr.setOrgId(1); rsr.setFunction("ADDUSER"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("john.smith@yellowfin.com.au"); // if Yellowfin authentication option is set "email address" ap.setFirstName("John"); ap.setLastName("Smith"); ap.setRoleCode("YFREPORTCONSUMER"); // Yellowfin role codes can be found performing this query against // Yellowfin configuration database: SELECT * FROM OrgRole ap.setPassword("test"); // Password must comply with your Yellowfin password policy ap.setEmailAddress("john.smith@yellowfin.com.au"); rsr.setPerson(ap); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); } %>
This function creates users in bulk. It works similar to the ADDUSER function, however this requires that you pass an array of AdministrationPerson objects. Note: Ensure that you mention the proper name of this function, which is ADDUSERS.
Complete Example of the ADDUSERS
This example code adds two new Yellowfin users, user1@yellowfin.com.au and user2@yellowfin.com.au, in the default organization. To try it out, follow these steps first:
- Copy the code and save it as ws_addusers.jsp.
- Put the file in the Yellowfin/appserver/webapps/ROOT folder.
- Adjust the host, port, admin user and users to add details according to your environment.
- Run http://<host>:<port>/ws_addusers.jsp from your Internet browser.
<% /* ws_addusers.jsp */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> <% AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); // adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin webservices admin account rsr.setPassword("test"); // change to be the password of the account above rsr.setOrgId(1); rsr.setFunction("ADDUSERS"); AdministrationPerson[] ap = new AdministrationPerson[2]; ap[0] = new AdministrationPerson(); ap[0].setUserId("user1@yellowfin.com.au"); ap[0].setFirstName("user1"); ap[0].setLastName("Lastname1"); ap[0].setRoleCode("YFREPORTCONSUMER"); ap[0].setPassword("test"); ap[0].setEmailAddress("user1@yellowfin.com.au"); ap[1] = new AdministrationPerson(); ap[1].setUserId("user2@yellowfin.com.au"); ap[1].setFirstName("user2"); ap[1].setLastName("Lastname2"); ap[1].setRoleCode("YFREPORTCONSUMER"); ap[1].setPassword("test"); ap[1].setEmailAddress("user2@yellowfin.com.au"); rsr.setPeople(ap); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode() ) ) { out.write("Success"); } else { out.write("Failure"); out.write("Code: " + rs.getErrorCode() ); } %>
This function allows multiple users to be created, without adding duplicates. It works similar to the ADDUSERS function, however in this case, if the login ID or email of a potential new user is already in use, or the password isn't supplied, then a no exceptions error will be generated and the user will not be created. The response will contain an array of AdministrationPerson object with failed users that were not added.
The code for this will be exactly like the ADDUSERS example. However, the function name would differ, as shown here:
rsr.setFunction("ADDUSERSIGNOREDUPLICATES");
Use this command to retrieve failed users:
AdministrationPerson[] failed_users = rs.getPeople();
The response will contain these parameters:
Response Element
Data Type
Description
StatusCode
String
Status of the web service call. Possible values include:
- SUCCESS
- FAILURE
People
AdministrationPerson[]
Failed users whose accounts were not created.
The call will delete a specified user from Yellowfin. Note: To remove a user from a client organization, you should perform the REMOVEUSERACCESS call.
AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("DELETUSER");
The function requires AdministrationPerson object where you provide the user id (email address or Id depending on the Logon ID method) to delete:
AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test@yellowfin.com.au"); // test@yellowfin.com.au should be existing Yellowfin user. rsr.setPerson(ap);
After configuring the request, perform the call:
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
- Then initialize the Administration web service. Click here to learn how to do this.
The response will contain these parameters:
Response Element
Data Type
Description
StatusCode
String
Status of the web service call. Possible values include:
- SUCCESS
- FAILURE
Complete Example of DELETEUSER:
You can use this example to delete a user. To try it out, follow the steps below:
- Copy the below code and save it as ws_deleteuser.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user and user to delete details according to your environment.
- Run http://<host>:<port>/ws_deleteuser.jsp from your Internet browser.
<% /* ws_deleteuser.jsp */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> <% AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); // adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin webservices admin account rsr.setPassword("test"); // change to be the password of the account above rsr.setOrgId(1); rsr.setFunction("DELETEUSER"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("test@yellowfin.com.au"); rsr.setPerson(ap); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode() ) ) { out.write("Success"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode() ); } %>
Retrieving & Validating User Information
Once a user has been created, the user's details can be retrieved using a web service call. The User ID field in the AdministrationPerson object is used to identify the user. As a result, a populated AdministrationPerson object will be returned. For security reasons, passwords will not be returned and will be NULL. User information can also be validated against the application in this section.
This function retrieves an existing Yellowfin user's details. It accepts AdministrationPerson as a parameter where you can provide a user ID (email address or any other ID, depending on the Login ID method) to identify the user. For security reasons, passwords will not be returned and will be NULL.
The response will contain the AdministrationPerson object with full user details.
Following is an example of this request:
AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("GETUSER");
Now provide the user ID via the AdministrationPerson object:
AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("john.smith@yellowfin.com.au"); rsr.setPerson(ap);
Once the request is configured, perform the call:
AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr);
- Then initialize the Administration web service. Click here to learn how to do this.
The response will contain the following parameters:
Response Element
Data Type
Description
StatusCode
String
Status of the web service call. Possible values include:
- SUCCESS
- FAILURE
Person
AdministrationPerson
Object with the user details
To display the retrieved user details, use the following example:
if ("SUCCESS".equals(rs.getStatusCode()) ) { ap = rs.getPerson(); out.write("UserId:" + ap.getUserId() + "<br>"); out.write("Password:" + ap.getPassword() + "<br>"); out.write("FirstName:" + ap.getFirstName() + "<br>"); out.write("LastName:" + ap.getLastName() + "<br>"); out.write("Initial:" + ap.getInitial() + "<br>"); out.write("SalutationCode:" + ap.getSalutationCode() + "<br>"); out.write("RoleCode:" + ap.getRoleCode() + "<br>"); out.write("EmailAddress:" + ap.getEmailAddress() + "<br>"); out.write("LanguageCode:" + ap.getLanguageCode() + "<br>"); out.write("IpId:" + ap.getIpId() + "<br>"); out.write("TimeZoneCode:" + ap.getTimeZoneCode() + "<br>"); out.write("Status:" + ap.getStatus() + "<br>"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); }
A Complete Example of the GETUSER function:
You can follow the steps below to use this example to retrieve user details:
- Copy the code and save it as ws_getuser.jsp.
- Put the file in the root folder: Yellowfin/appserver/webapps/ROOT.
- Adjust the host, port, admin user and user to get details according to your environment.
- Run http://<host>:<port>/ws_getuser.jsp from your Internet browser.
<% /* ws_getuser.jsp */ %> <%@ page language="java" contentType="text/html; charset=UTF-8" %> <%@ page import="com.hof.util.*, java.util.*, java.text.*" %> <%@ page import="com.hof.web.form.*" %> <%@ page import="com.hof.mi.web.service.*" %> <% AdministrationServiceService s_adm = new AdministrationServiceServiceLocator("localhost",8080, "/services/AdministrationService", false); // adjust host and port number AdministrationServiceSoapBindingStub adminService = (AdministrationServiceSoapBindingStub) s_adm.getAdministrationService(); AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); // provide your Yellowfin webservices admin account rsr.setPassword("test"); // change to be the password of the account above rsr.setOrgId(1); rsr.setFunction("GETUSER"); AdministrationPerson ap = new AdministrationPerson(); ap.setUserId("john.smith@yellowfin.com.au"); rsr.setPerson(ap); AdministrationServiceResponse rs = adminService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { ap = rs.getPerson(); out.write("User Id:" + ap.getUserId() + "<br>"); out.write("Password:" + ap.getPassword() + "<br>"); out.write("First Name:" + ap.getFirstName() + "<br>"); out.write("Last Name:" + ap.getLastName() + "<br>"); out.write("Initial:" + ap.getInitial() + "<br>"); out.write("Salutation Code:" + ap.getSalutationCode() + "<br>"); out.write("Role Code:" + ap.getRoleCode() + "<br>"); out.write("Email Address:" + ap.getEmailAddress() + "<br>"); out.write("Language Code:" + ap.getLanguageCode() + "<br>"); out.write("IpId:" + ap.getIpId() + "<br>"); out.write("Time Zone Code:" + ap.getTimeZoneCode() + "<br>"); out.write("Status:" + ap.getStatus() + "<br>"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode() ); } %>
This functions retrieves details of all the users in a specified client organization. The information is retrieved in an array of AdministrationPerson objects. If a client organization is not specified, then all the users will be retrieved. You can use the setParameters() method to specify a searching criteria for users being retrieved. For security reasons, passwords will not be returned and will be NULL.
Here's an example of a request to retrieve users:
AdministrationServiceRequest rsr = new AdministrationServiceRequest(); rsr.setLoginId("admin@yellowfin.com.au"); rsr.setPassword("test"); rsr.setOrgId(1); rsr.setFunction("GETALLUSERS");
- Specify a client organization, otherwise all the client organizations will
The following code will call the Yellowfin web service to retrieve a user’s details via their internal IpId:
AdministrationServiceRequest rsr = new AdminstrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationPerson person = new AdministrationPerson(); Person.setIpId(5); rsr.setLoginId(this.username); rsr.setPassword(this.password); rsr.setOrgId(new Integer(1)); rsr.setFunction("GETUSERBYIP"); rsr.setPerson(person); rs = AdministrationService.remoteAdministrationCall(rsr); if ("SUCCESS".equals(rs.getStatusCode()) ) { out.write("Success"); } else { out.write("Failure"); out.write(" Code: " + rs.getErrorCode()); }
This code will return an AdministrationPerson object with the user’s details and SUCCESS
in the rs.getStatusCode()
, otherwise it will return an error message explaining why the process failed.
This function will retrieve the details of a particular user in Yellowfin by looking up their IP ID. The details in the AdministrationPerson object will be used in the retrieval process.
Request Element | Data Type | Description |
---|---|---|
LoginId | String | Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au |
Password | String | Password of the account used to connect to Yellowfin webservices |
OrgId | Integer | Primary organisation ID within Yellowfin. Always set this to 1. |
Function = “GETUSERBYIP” |
| Web services function |
Person | AdministrationPerson | The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process |
These are the parameters that you need to set in the AdministrationPerson object:
AdministrationPerson Element | Data Type | Description |
---|
IpId|Integer|IP ID of the Yellowfin User|
The response returned will contain these parameters:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
Person | AdministrationPerson | The AdministrationPerson object holding all of the returned user’s details |
This function will retrieve users from Yellowfin based on a specific search string. This string is compared against the user’s first name, last name, and email address.
Request Element | Data Type | Description |
---|---|---|
LoginId | String | Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au |
Password | String | Password of the account used to connect to Yellowfin webservices |
OrgId | Integer | Primary organisation ID within Yellowfin. Always set this to 1. |
Function = “GETUSERSFROMSEARCH” |
| Web services function |
Parameters | Array (String) | Search string to match against Yellowfin users’ first names, last names, and email address |
The response returned will contain these parameters:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
People | Array (AdministrationPerson) | An array of AdministrationPerson objects. These objects hold the returned users’ details that match the search string |
The following code will call the Yellowfin web service to validate a user:
AdministrationServiceRequest rsr = new AdminstrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationPerson person = new AdministrationPerson(); person.setUserId("admin@yellowfin.com.au"); rsr.setLoginId(this.username); rsr.setPassword(this.password); rsr.setFunction("VALIDATEUSER"); rsr.setPerson(person); rs = AdministrationService.remoteAdministrationCall(rsr);
This code will return an AdministrationPerson object of the particular user if successful; otherwise it will return an error message explaining why the user validation process failed.
This function will validate a specified Yellowfin user, checking if the user currently exists within the application. The details in the AdministrationPerson object will be used in the user validation process.
Request Element | Data Type | Description |
---|---|---|
LoginId | String | Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au |
Password | String | Password of the account used to connect to Yellowfin webservices |
OrgId | Integer | Primary organisation ID within Yellowfin. Always set this to 1. |
Function = “VALIDATEUSER” |
| Web services function |
Person | AdministrationPerson | The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process |
These are the parameters that you need to set in the AdministrationPerson object:
AdministrationPerson Element | Data Type | Description |
---|---|---|
UserId | String | User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method |
The response returned will contain these parameters:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
Person | AdministrationPerson | The AdministrationPerson object holding all of the returned user’s details |
The following code will call the Yellowfin web service to validate a user’s password:
AdministrationServiceRequest rsr = new AdminstrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationPerson person = new AdministrationPerson(); person.setUserId("testuser@yellowfin.com.au"); person.setPassword("test"); rsr.setLoginId(this.username); rsr.setPassword(this.password); rsr.setOrgId(new Integer(1)); rsr.setFunction("VALIDATEPASSWORD"); rsr.setPerson(person); rs = AdministrationService.remoteAdministrationCall(rsr);
This code will check if the password is expired and will return FAILURE
in the rs.getStatusCode()
if it is not, otherwise it will return SUCCESS
.
This function will validate a Yellowfin user’s password. The details in the AdministrationPerson object will be used in the password validation process.
Request Element | Data Type | Description |
---|---|---|
LoginId | String | Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au |
Password | String | Password of the account used to connect to Yellowfin webservices |
OrgId | Integer | Primary organisation ID within Yellowfin. Always set this to 1. |
Function = “VALIDATEUSER” |
| Web services function |
Person | AdministrationPerson | The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process |
These are the parameters that you need to set in the AdministrationPerson object:
AdministrationPerson Element | Data Type | Description |
---|---|---|
UserId | String | User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method |
Password | String | Password of the Yellowfin user |
The response returned will contain these parameters:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
Manipulating User Information
A user's details can be modified at a later time using a web service call. The User ID field in the AdministrationPerson object is used to identify the user, so this cannot be changed. The rest of the fields within an AdministrationPerson object are populated with the new changes. For security reasons, the user's password cannot be changed with this web service call, but with a separate CHANGEPASSWORD function (below).
The following code will call the Yellowfin web service to edit a user’s details:
AdministrationServiceRequest rsr = new AdminstrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationPerson person = new AdministrationPerson(); person.setUserId("testuser"); person.setFirstName("John"); person.setLastName("Doe"); person.setInitial("F"); person.setSalutationCode("MR"); person.setRoleCode("YFADMIN"); person.setEmailAddress("testuser@yellowfin.com.au") rsr.setLoginId(this.username); rsr.setPassword(this.password); rsr.setOrgId(new Integer(1)); rsr.setFunction("UPDATEUSER"); rsr.setPerson(person); rs = AdministrationService.remoteAdministrationCall(rsr);
This code will return an AdministrationPerson object with the user’s details and SUCCESS
in the rs.getStatusCode()
, otherwise it will return an error message explaining why the process failed.
This function will update a specified Yellowfin user’s details. The details in the AdministrationPerson object will be used in the update process.
Request Element | Data Type | Description |
---|---|---|
LoginId | String | Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au |
Password | String | Password of the account used to connect to Yellowfin webservices |
OrgId | Integer | Primary organisation ID within Yellowfin. Always set this to 1. |
Function = “UPDATEUSER” |
| Web services function |
Person | AdministrationPerson | The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process |
These are the parameters that you can set in the AdministrationPerson object:
AdministrationPerson Element | Data Type | Description |
---|---|---|
UserId | String | User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method |
Password | String | Password of the Yellowfin user |
FirstName | String | First name of of the Yellowfin user |
LastName | String | Last name of of the Yellowfin user |
Initial | String | Middle name of the Yellowfin user |
SalutationCode | String | Title of the Yellowfin user. Possible values include:
|
RoleCode | String | Yellowfin role. The specified role here can be the Org Reference Code (YFADMIN) or the name of the role (Yellowfin Administrator) |
EmailAddress | String | Email address of the Yellowfin user |
LanguageCode | String | Two letter code for the preferred language |
IpId | Integer | Internal Yellowfin IP ID |
TimeZoneCode | String | The TimeZoneCode of the Yellowfin user. See appendix for valid values. |
Status | String | Indicates a user status. Can be one of the following:
|
The response returned will contain these parameters:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|
Person | AdministrationPerson | The AdministrationPerson object holding all of the updated user’s details |
The following code will call the Yellowfin web service and change the password for the specified Yellowfin user:
AdministrationServiceRequest rsr = new AdministrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationPerson person = new AdministrationPerson(); person.setUserId("test@yellowfin.com.au"); person.setPassword("testtest"); rsr.setLoginId(this.username); rsr.setPassword(this.password); rsr.setOrgId(new Integer(1)); rsr.setFunction("CHANGEPASSWORD"); rsr.setPerson(person); rs = AdministrationService.remoteAdministrationCall(rsr);
The code will return SUCCESS
in rs.getStatusCode()
, otherwise it will return an error explaining why the process failed.
This function will change a specified Yellowfin user’s password.
Request Element | Data Type | Description |
---|---|---|
LoginId | String | Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au |
Password | String | Password of the account used to connect to Yellowfin webservices |
OrgId | Integer | Primary organisation ID within Yellowfin. Always set this to 1. |
Function = “CHANGEPASSWORD” |
| Web services function |
Person | AdministrationPerson | The AdministrationPerson object holding the Yellowfin user’s User ID for the retrieval process |
These are the parameters that you need to set in the AdministrationPerson object:
AdministrationPerson Element | Data Type | Description |
---|---|---|
UserId | String | User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method |
Password | String | New password of the Yellowfin user |
The response returned will contain these parameters:
Response Element | Data Type | Description |
---|---|---|
StatusCode | String | Status of the web service call. Possible values include:
|