Page History
...
Expand | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||
Creates a new user account in Yellowfin.
Here's a basic request to create a new Yellowfin user:
Complete Example of ADDUSERFollowing is a full example of this function, that you can use in your code. Follow these steps first:
|
...
Expand | |||||
---|---|---|---|---|---|
| |||||
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 ADDUSERSThis 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:
|
Anchor | ||||
---|---|---|---|---|
|
Expand | ||
---|---|---|
| ||
This function allows bulk user creation multiple users to be created, without adding duplicates. It works similar to the ADDUSERS function, however in this case, this time if a user-to-add login Id in use or email is in use or password is not supplied, there will be no exceptions 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 containing with failed users that was were not added.
|
|
Anchor | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||
The call will delete a specified user from Yellowfin. Note: To remove a user from a client organization, you should perform the REMOVEUSERACCESS call.
| |||||||||||||||||||
Expand | |||||||||||||||||||
| |||||||||||||||||||
The following code will call the Yellowfin web service to delete a user:
This code will return This function will delete a user from Yellowfin. The details in the AdministrationPerson object will be used in the user deletion process. Request
| |||||||||||||||||||
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 = “DELUSER” or “DELETEUSER” |
| Web services function | |||||||||||||||||
Person | AdministrationPerson | The AdministrationPerson object holding all of the user’s details for the user creation process |
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:
|
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.
...
title | GETUSER |
---|
The following code will call the Yellowfin web service to retrieve a user’s details:
Code Block |
---|
AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();
Person.setUserId("testuser@yellowfin.com.au");
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETUSER");
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. 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 = “GETUSER” |
| 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:
- SUCCESS
- FAILURE
...
Person
...
AdministrationPerson
Complete Example of DELETEUSER: You can use this example to delete a user. To try it out, follow the steps below:
|
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.
Expand | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||
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.
A Complete Example of the GETUSER function:You can follow the steps below to use this example to retrieve user details:
|
...
Expand | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
The following code will call the Yellowfin web service to retrieve a user’s details via their internal IpId:
This code will return an AdministrationPerson object with the user’s details and 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.
These are the parameters that you need to set in the AdministrationPerson object:
IpId|Integer|IP ID of the Yellowfin User| The response returned will contain these parameters:
|
...