Page History

...

Expand
title ADDUSER
The following code will call the Yellowfin web service to create a user: Code Block AdministrationServiceRequest rsr = new AdminstrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationPerson person = new AdministrationPerson(); person.setUserId("test@yellowfin.com.au"); person.setPassword("test"); person.setFirstName("Simple"); person.setLastName("Simon"); person.setInitial("S"); person.setSalutationCode("MR"); person.setRoleCode("YFADMIN"); person.setEmailAddress("test@yellowfin.com.au"); rsr.setLoginId(this.username); rsr.setPassword(this.password); rsr.setOrgId(new Integer(1)); rsr.setFunction("ADDUSER"); 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 SUCCESS in rs.getStatusCode(), otherwise it will return an error message explaining why the user creation process failed. This function will create a user in Yellowfin. The details in the AdministrationPerson object will be used in the user creation 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 = "ADDUSER"   Web services function Person AdministrationPerson The AdministrationPerson object holding all of the new user's details for the user creation 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 new user. This can be the user ID or the email address, depending on the Logon ID method Password String Password of the new user FirstName String First name of of the new user LastName String Last name of of the new user Initial String Middle name of the new user SalutationCode String Title of the new user. Possible values include: DR MISS MR MRS MS 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 new user 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

Expand
title DELUSER / DELETEUSER
The following code will call the Yellowfin web service to

...

delete a user: Code Block AdministrationServiceRequest rsr = new AdminstrationServiceRequest(); AdministrationServiceResponse rs = null; AdministrationPerson person = new AdministrationPerson(); person.setUserId("test@yellowfin.com.au"); rsr.setLoginId(this.username); rsr.setPassword(this.password); rsr.setOrgId(new Integer(1)); rsr.setFunction("DELUSER"); 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 SUCCESS in rs.getStatusCode(), otherwise it will return an error message explaining why the user

...

deletion process failed. This function will delete a user from Yellowfin. The details in the AdministrationPerson object will be used in the user deletion 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 = "DELUSER" or "DELETEUSER"   Web services function Person AdministrationPerson The AdministrationPerson object holding all of the user's details for the user creation 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

Retrieving & Validating User Information

...