Page History

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

...

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.ausetLoginId()
Password	String	Password of the account used to connect to Yellowfin webservicessetPassword()
OrgId	Integer	Primary Organization ID within Yellowfin. Always set this to 1.setOrgId()
Function = "ADDUSER"		Web services functionsetFunction()
Person	AdministrationPerson	The AdministrationPerson object holding all of the new user's details for the user creation processsetPerson()

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	DescriptionSetting Code
UserId	String	User ID of the new user. This can be the user ID or the email address, depending on the Logon ID methodsetUserId()
Password	String	Password of the new user	setPassword()
FirstName	String	First name of of the new usersetFirstName()
LastName	String	Last name of of the new usersetLastName()
Initial	String	Middle name of the new usersetInitial()
SalutationCode	String	Title of the new user. Possible values include: DR MISS MR MRS MS	setSalutationCode()
RoleCode	String	Yellowfin role. The specified role here can be the Org Reference Code (YFADMIN) or the name of the role (Yellowfin Administrator)setRoleCode()
EmailAddress	String	Email address of the new user	setEmailAddress()

The response returned will contain these parameters:

Response Element

Data Type

Description

Retrieval Code

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

getStatusCode()

Expand

title	DELUSER / DELETEUSER

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");

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 creation 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	DescriptionSetting Code
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.ausetLoginId()
Password	String	Password of the account used to connect to Yellowfin webservicessetPassword()
OrgId	Integer	Primary Organization ID within Yellowfin. Always set this to 1.	setOrgId()
Function = "DELUSER" or "DELETEUSER"		Web services functionsetFunction()
Person	AdministrationPerson	The AdministrationPerson object holding all of the user's details for the user creation process	setPerson()

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	DescriptionSetting Code
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID methodsetUserId()

The response returned will contain these parameters:

Response Element

Data Type

DescriptionRetrieval Code

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

getStatusCode()

Retrieving & Validating User Information

...

Expand

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	DescriptionSetting Code
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.ausetLoginId()
Password	String	Password of the account used to connect to Yellowfin webservices	setPassword()
OrgId	Integer	Primary Organization ID within Yellowfin. Always set this to 1.setOrgId()
Function = "GETUSER"		Web services function	setFunction()
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process	setPerson()

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	Description	Setting Code
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID methodsetUserId()

The response returned will contain these parameters:

Response Element

Data Type

DescriptionRetrieval Code

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

getStatusCode()

Person

AdministrationPerson

The AdministrationPerson object holding all of the returned user's detailsgetPerson()

Expand

title	GETUSERBYIP

The following code will call the Yellowfin web service to retrieve a user's details via their internal IpId:

Code Block

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	DescriptionSetting Code
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.ausetLoginId()
Password	String	Password of the account used to connect to Yellowfin webservicessetPassword()
OrgId	Integer	Primary Organization ID within Yellowfin. Always set this to 1.	setOrgId()
Function = "GETUSERBYIP"		Web services functionsetFunction()
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval processsetPerson()

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	DescriptionSetting Code

IpId|Integer|IP ID of the Yellowfin User|setIprId()|

The response returned will contain these parameters:

Response Element

Data Type

Description

Retrieval Code

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

getStatusCode()

Person

AdministrationPerson

The AdministrationPerson object holding all of the returned user's details

getPerson()

Expand
title GETUSERFROMSEARCH
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

...

Setting Code

LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au

...

setLoginId()

Password
String
Password of the account used to connect to Yellowfin webservices

...

OrgId
Integer
Primary Organization ID within Yellowfin. Always set this to 1.

...

Function = "GETUSERSFROMSEARCH"

String
Web services function

...

Parameters
Array (String)
Search string to match against Yellowfin users' first names, last names, and email address

...

setParameters()

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

...

getStatusCode()

People
Array (AdministrationPerson)
An array of AdministrationPerson objects. These objects hold the returned users' details that match the search string

...

getPeople()

Expand

title	VALIDATEUSER

The following code will call the Yellowfin web service to validate a user:

Code Block

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	DescriptionSetting Code
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.ausetLoginId()
Password	String	Password of the account used to connect to Yellowfin webservicessetPassword()
OrgId	Integer	Primary Organization ID within Yellowfin. Always set this to 1.setOrgId()
Function = "VALIDATEUSER"		Web services function	setFunction()
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval processsetPerson()

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	Description	Setting Code
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method	setUserId()

The response returned will contain these parameters:

Response Element

Data Type

Description

Retrieval Code

StatusCodeStatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

getStatusCode()

Person

AdministrationPerson

The AdministrationPerson object holding all of the returned user's detailsgetPerson()

Expand

title	VALIDATEPASSWORD

The following code will call the Yellowfin web service to validate a user's password:

Code Block

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	DescriptionSetting Code
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.ausetLoginId()
Password	String	Password of the account used to connect to Yellowfin webservicessetPassword()
OrgId	Integer	Primary Organization ID within Yellowfin. Always set this to 1.setOrgId()
Function = "VALIDATEUSER"		Web services functionsetFunction()
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process	setPerson()

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	DescriptionSetting Code
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID methodsetUserId()
Password	String	Password of the Yellowfin usersetPassword()

The response returned will contain these parameters:

Response Element

Data Type

DescriptionRetrieval Code

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

getStatusCode()

Manipulating User Information

...

Expand

title	UPDATEUSER

The following code will call the Yellowfin web service to edit a user's details:

Code Block

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	DescriptionSetting Code
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.au	setLoginId()
Password	String	Password of the account used to connect to Yellowfin webservices	setPassword()
OrgId	Integer	Primary Organization ID within Yellowfin. Always set this to 1.	setOrgId()
Function = "UPDATEUSER"		Web services functionsetFunction()
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval processsetPerson()

These are the parameters that you can set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	DescriptionRetrieval Code
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID method	setUserId()
Password	String	Password of the Yellowfin usersetPassword()
FirstName	String	First name of of the Yellowfin user	setFirstName()
LastName	String	Last name of of the Yellowfin usersetLastName()
Initial	String	Middle name of the Yellowfin usersetInitial()
SalutationCode	String	Title of the Yellowfin user. Possible values include: DR MISS MR MRS MS setSalutationCode()
RoleCode	String	Yellowfin role. The specified role here can be the Org Reference Code (YFADMIN) or the name of the role (Yellowfin Administrator)setRoleCode()
EmailAddress	String	Email address of the Yellowfin usersetEmailAddress()
LanguageCode	String	Two letter code for the preferred language	setLanguageCode()
IpId	Integer	Internal Yellowfin IP IDsetIpId()
TimeZoneCode	String	The TimeZoneCode of the Yellowfin user. See appendix for valid values.	setTimeZoneCode()

The response returned will contain these parameters:

Response Element

Data Type

Description

Retrieval Code

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

getStatusCode()

Person

AdministrationPerson

The AdministrationPerson object holding all of the updated user's detailsgetPerson()

Expand

title	CHANGEPASSWORD

The following code will call the Yellowfin web service and change the password for the specified Yellowfin user:

Code Block

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	DescriptionSetting Code
LoginId	String	Login ID of the account used to connect to Yellowfin webservices eg. admin@yellowfin.com.ausetLoginId()
Password	String	Password of the account used to connect to Yellowfin webservicessetPassword()
OrgId	Integer	Primary Organization ID within Yellowfin. Always set this to 1.setOrgId()
Function = "CHANGEPASSWORD"		Web services functionsetFunction()
Person	AdministrationPerson	The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval processsetPerson()

These are the parameters that you need to set in the AdministrationPerson object:

AdministrationPerson Element	Data Type	Description	Retrieval Code
UserId	String	User ID of the Yellowfin user. This can be the user ID or the email address, depending on the Logon ID methodsetUserId()
Password	String	New password of the Yellowfin usersetPassword()

The response returned will contain these parameters:

Response Element

Data Type

DescriptionRetrieval Code

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

getStatusCode()

Retrieving Objects Belonging to a User

...

Expand

title	GETUSERREPORTS / GETALLUSERREPORTS

The following code will call the Yellowfin web service and return all reports with a Web Services Name that are accessible for the particular user:

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));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETUSERREPORTS");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

This code will return an Array of AdministrationReport objects in rs.getReports() and SUCCESS in rs.getStatusCode(), otherwise it will return an error message explaining why the process failed.

...

title	GETALLUSERREPORTS

...

This function will return all reports with a webservice name that are accessible for the

...

specified Yellowfin user.
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 Organization ID within Yellowfin. Always set this to 1.
Function = "GETUSERREPORTS"
String
Web services function
OrgRef
String
Client Reference ID if this function is to be applied for a particular client organization. This parameter is optional.
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
Reports
AdministrationReport
An array of AdministrationReport objects. These objects hold report metadata.

Expand

title	GETALLUSERREPORTS

The following code will call the Yellowfin web service and return all reports that are accessible for the particular user:

Code Block


AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationPerson person = new AdministrationPerson();

Person.setUserId("testuser@yellowfin.

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));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETALLUSERREPORTS");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

This code will return an Array of AdministrationReport objects in rs.getReports() and SUCCESS in rs.getStatusCode(), otherwise it will return an error message explaining why the process failed.

...

title	GETREPORTSWITHCOMMENTS

The following code will call the Yellowfin web service and return all commented reports that are accessible for the particular user:

...

com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("

...

GETALLUSERREPORTS");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

This code will return an Array of AdministrationReport objects in rs.getReports() and SUCCESS in rs.getStatusCode(), otherwise it will return an error message explaining why the process failed.

...

Expand

title	GETFAVOURITES / GETFAVORITES

The following code will call the Yellowfin web service and return all report favourites that are accessible for the particular user:

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));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETFAVOURITES");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

This code will return an Array of AdministrationReport objects in rs.getReports() and SUCCESS in rs.getStatusCode(), otherwise it will return an error message explaining why the process failed.

...

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 Organization ID within Yellowfin. Always set this to 1.
Function = "GETUSERREPORTS"
String
Web services function
OrgRef
String
Client Reference ID if this function is to be applied for a particular client organization. This parameter is optional.
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
Reports
AdministrationReport
An array of AdministrationReport objects. These objects hold report metadata.

Expand
title GETREPORTSWITHCOMMENTS

...

The following code will call the Yellowfin web service and return all commented reports that are

...

accessible for the particular user

...

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));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("

...

GETREPORTSWITHCOMMENTS");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

This code will return an Array of AdministrationReport objects in rs.getReports() and SUCCESS in rs.getStatusCode(), otherwise it will return an error message explaining why the process failed.

Expand

title	GETUSERTABS

The following code will call the Yellowfin web service and return all dashboard tabs without reports that are accessible for that particular user:

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));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETUSERTABS");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

This code will return an Array of AdministrationReportGroup objects in rs.getReportGroups() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.

...

title	GETUSERTABSWITHREPORTS

The following code will call the Yellowfin web service and return all dashboard tabs with reports that are accessible for that particular user:

...

This function will return all commented reports in Yellowfin that are accessible by the specified Yellowfin user.
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 Organization ID within Yellowfin. Always set this to 1.
Function = "GETREPORTSWITHCOMMENTS"
String
Web services function
OrgRef
String
Client Reference ID if this function is to be applied for a particular client organization. This parameter is optional.
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
Reports
AdministrationReport
An array of AdministrationReport objects. These objects hold report metadata.

Expand

title	GETFAVOURITES / GETFAVORITES

The following code will call the Yellowfin web service and return all report favourites that are accessible for the particular user:

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));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction(

...

"GETFAVOURITES");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

This code will return an Array of AdministrationReport objects in rs.getReports() and SUCCESS in rs.getStatusCode(), otherwise it will return an error message explaining why the process failed.

This function will return all the favourite reports of a specified Yellowfin user.

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 Organization ID within Yellowfin. Always set this to 1.
Function = "GETFAVOURITES" or "GETFAVORITES"	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organization. This parameter is optional.
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

Reports

AdministrationReport

An array of AdministrationReport objects. These objects hold report metadata.

Expand

title	GETINBOX

The following code will call the Yellowfin web service and return all reports that are in the particular user's inbox:

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));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETINBOX");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

This code will return an Array of AdministrationReport objects in rs.getReports() and SUCCESS in rs.getStatusCode(), otherwise it will return an error message explaining why the process failed.

This function will return the reports that are in the inbox of a specified Yellowfin user.

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 Organization ID within Yellowfin. Always set this to 1.
Function = "GETINBOX"	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organization. This parameter is optional.
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

Reports

AdministrationReport

An array of AdministrationReport objects. These objects hold report metadata.

Expand

title	GETUSERTABS

The following code will call the Yellowfin web service and return all dashboard tabs without reports that are accessible for that particular user:

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));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETUSERTABS");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

This function will return a list of dashboard tabs that are accessible by the specified Yellowfin user.

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 Organization ID within Yellowfin. Always set this to 1.
Function = "GETUSERTABS"	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organization. This parameter is optional.
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

ReportsGroups

AdministrationReportGroup

An array of AdministrationReportGroup objects. These objects hold dashboard metadata.

Expand

title	GETUSERTABSWITHREPORTS

The following code will call the Yellowfin web service and return all dashboard tabs with reports that are accessible for that particular user:

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));
// uncomment line below and set Client Reference ID if user belongs to a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETUSERTABS");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);

This function will return a list of dashboard tabs that are accessible by the specified Yellowfin user, with the reports' metadata loaded as well. The metadata for every report in the dashboard tab is contained within the AdministrationReportGroup object.

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 Organization ID within Yellowfin. Always set this to 1.
Function = "GETUSERTABSWITHREPORTS"	String	Web services function
OrgRef	String	Client Reference ID if this function is to be applied for a particular client organization. This parameter is optional.
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

ReportsGroups

AdministrationReportGroup

An array of AdministrationReportGroup objects. These objects hold dashboard metadata. For this particular function, the reports' metadata is also loaded into this object's GroupReports() parameter.

Expand
title LOADTABREPORTS
This function will return a list of reports contained within a specified dashboard tab, that is accessible by a specified user in Yellowfin.
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 Organization ID within Yellowfin. Always set this to 1.
Function = "LOADTABREPORTS"
String
Web services function
Person
AdministrationPerson
The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process
ReportGroup
AdministrationReportGroup
The AdministrationReportGroup object holding the Dashboard Tab ID for the retrieval process
These are the parameters that you need to set in the AdministrationPerson and AdministrationReportGroup 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
AdministrationReportGroup Element
Data Type
Description
ReportGroupId
String
Dashboard Tab ID
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
ReportGroups
AdministrationReportGroup
An array of AdministrationReportGroup objects. These objects hold dashboard metadata. For this particular function, the reports' metadata is also loaded into this object's GroupReports() parameter.

...

Group & Role Administration

...

Content

Space Tools

Versions Compared

Old Version 4

New Version 5

Key

Retrieving & Validating User Information

Expand
title GETUSERFROMSEARCH
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 Organization ID within Yellowfin. Always set this to 1.

Function = "GETUSERSFROMSEARCH"

String
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:
SUCCESS
FAILURE

People
Array (AdministrationPerson)
An array of AdministrationPerson objects. These objects hold the returned users' details that match the search string

Manipulating User Information

Retrieving Objects Belonging to a User

This function will return all reports with a webservice name that are accessible for the

com.au"); rsr.setLoginId(this.username); rsr.setPassword(this.password); rsr.setOrgId(new Integer(1)); // uncomment line below and set Client Reference ID if user belongs to a client organisation // rsr.setOrgRef("CLIENTREFERENCEIDHERE"); rsr.setFunction("

Expand
title GETREPORTSWITHCOMMENTS

The following code will call the Yellowfin web service and return all commented reports that are

accessible for the particular user

Group & Role Administration

Content

Space Tools

Page History

Versions Compared

Old Version 4

New Version 5

Key

Retrieving & Validating User Information

ExpandtitleGETUSERFROMSEARCHThis 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 ElementData TypeDescription

LoginIdStringLogin ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au

PasswordStringPassword of the account used to connect to Yellowfin webservices

OrgIdIntegerPrimary Organization ID within Yellowfin. Always set this to 1.

Function = "GETUSERSFROMSEARCH" StringWeb services function

ParametersArray (String)Search string to match against Yellowfin users' first names, last names, and email address

The response returned will contain these parameters:Response ElementData TypeDescription

StatusCodeStringStatus of the web service call. Possible values include:SUCCESSFAILURE

PeopleArray (AdministrationPerson)An array of AdministrationPerson objects. These objects hold the returned users' details that match the search string

Manipulating User Information

Retrieving Objects Belonging to a User

This function will return all reports with a webservice name that are accessible for the

com.au"); rsr.setLoginId(this.username); rsr.setPassword(this.password); rsr.setOrgId(new Integer(1)); // uncomment line below and set Client Reference ID if user belongs to a client organisation // rsr.setOrgRef("CLIENTREFERENCEIDHERE"); rsr.setFunction("

GETALLUSERREPORTS"); rsr.setPerson(person); rs = AdministrationService.remoteAdministrationCall(rsr); This code will return an Array of AdministrationReport objects in rs.getReports() and SUCCESS in rs.getStatusCode(), otherwise it will return an error message explaining why the process failed.

ExpandtitleGETREPORTSWITHCOMMENTS

The following code will call the Yellowfin web service and return all commented reports that are

accessible for the particular user

Group & Role Administration

Expand
title GETUSERFROMSEARCH
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 Organization ID within Yellowfin. Always set this to 1.

Function = "GETUSERSFROMSEARCH"

String
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:
SUCCESS
FAILURE

People
Array (AdministrationPerson)
An array of AdministrationPerson objects. These objects hold the returned users' details that match the search string

Expand
title GETREPORTSWITHCOMMENTS