Page History

Versions Compared

Key

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

...

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	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:* 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 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. T he

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

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

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

|| Description ||| LoginId | String |

	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 |

	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 |

	Description
StatusCode	String	Status of the web service call. Possible values include:* SUCCESS* FAILURE

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.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 |

	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 = "GETUSERREPORTS"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. 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 |

	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 |

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

Request Element

	Data Type

	Description


LoginId

String

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 = "GETUSERREPORTS"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. 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 |

	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 |

	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.This function will return all commented reports in Yellowfin that are accessible by the specified Yellowfin user.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "GETREPORTSWITHCOMMENTS"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. 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 |

	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 |

	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 |

	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 = "GETFAVOURITES" or "GETFAVORITES"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. 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 |

	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 |

	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 |

	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 = "GETINBOX"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. 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 |

	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 |

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

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "GETUSERTABS"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. 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 |

	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 |

	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 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.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 |

	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 = "GETUSERTABSWITHREPORTS"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. 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 |

	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 |

	Description
StatusCode	String Status of the web service call. Possible values include:

SUCCESS

FAILURE

title	LISTROLES

The following code will call the Yellowfin web service and return all available roles within Yellowfin:

Code Block

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

rsr.setOrgId(new Integer(1));
rsr.setFunction("LISTROLES");

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return an Array of AdministrationRole objects in rs.getRoles() and SUCCESS in rs.getStatusCode().This function will return all the available roles within Yellowfin.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "LISTROLES"

String

Web services function

|The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Roles

AdministrationRole

An array of AdministrationRole objects. These objects hold Yellowfin Role metadata.

Expand

title	LISTGROUPS

The following code will call the Yellowfin web service and return all available groups within Yellowfin:

Code Block

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

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

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return an Array of AdministrationGroup objects in rs.getGroups() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.This function will return all the available user groups within Yellowfin.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "LISTGROUPS"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.

|The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Groups

AdministrationGroup

An array of AdministrationGroup objects. These objects hold Yellowfin user group metadata.

Expand

title	GETGROUP

The following code will call the Yellowfin web service and return the specified group with its members in Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();

group.setGroupName("Group Name");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("GETGROUP");
rsr.setGroup(group);

rs = AdministrationService.remoteAdministrationCall(rsr);
group = rs.getGroup();

AdministrationGroupMember[] groupMembers = group.getGroupMembers();

The code will return an AdministrationGroup object in rs.getGroup(), an Array of AdministrationGroupMembers in rs.getGroup().getGroupMembers(), and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.This function will return a specified Yellowfin group with a list of its members.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "GETGROUP"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.

Group

AdministrationGroup

The AdministrationGroup object holding the Yellowfin user group's name for the retrieval process

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

AdministrationGroup Element

	Data Type

|| Description ||| GroupName | String |

	Description
GroupName	String	Name of the specified Yellowfin Group

|The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Group

AdministrationGroup

An array of AdministrationGroup objects holding group metadata. The group members are also loaded into this object's GroupMembers() parameter.

Expand

title	CREATEGROUP

The following code will call the Yellowfin web service and create the specified group in Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();

group.setGroupName("Group Name");
group.setGroupDescription("Group Description");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to create the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("CREATEGROUP");
rsr.setGroup(group);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.Note: you can also put existing Yellowfin users into this newly created group at the same time by populating an AdministrationGroupMember array of AdministrationPerson objects. Each AdministrationPerson object only needs the LoginId variable set, and the AdministrationGroupMember array is saved at group.setGroupMembers().This function will create a Yellowfin group. Note that you are able to save existing Yellowfin users into the new group in this function as well.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "CREATEGROUP"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.

Group

AdministrationGroup

The AdministrationGroup object holding the Yellowfin user group's name for the retrieval process

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

AdministrationGroup Element

	Data Type

|| Description ||| GroupName | String |

	Description
GroupName	String	Name of the specified Yellowfin group

GroupDescription

String

Business description of the specified Yellowfin group

GroupMembers

Array (AdministrationPerson)

An array of AdministrationPerson objects. This is an optional parameter where you can set to save existing Yellowfin users into this group. Each AdministrationPerson object in this scenario only needs to have its UserId parameter set.

|The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	INCLUDEUSERINGROUP

The following code will call the Yellowfin web service and include a specified user into a specified group in Yellowfin:

Code Block

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

group.setGroupName("Group Name");
person.setUserId("test@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 you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("INCLUDEUSERINGROUP");
rsr.setGroup(group);
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 include a specified Yellowfin user into a specified group.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "INCLUDEUSERINGROUP"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.

Group

AdministrationGroup

The AdministrationGroup object holding the Yellowfin user group's name for the retrieval process

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 AdministrationGroup and AdministrationPerson objects:||

AdministrationGroup Element

	Data Type

|| Description ||| GroupName | String |

	Description
GroupName	String	Name of the specified Yellowfin group

|||

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 |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	EXCLUDEUSERINGROUP

The following code will call the Yellowfin web service and exclude a specified user from a specified group in Yellowfin.Note: this user is not deleted from the group but merely excluded from the group definition. An example of why this would be useful is when:* John Doe is a member of Group A* Group A is a member of Group B* John Doe shouldn't be a member of Group B, therefore he should be excluded from Group B

Code Block

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

group.setGroupName("Group Name");
person.setUserId("test@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 you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("EXCLUDEUSERINGROUP");
rsr.setGroup(group);
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 exclude a specified Yellowfin user from a specified group. Note that this user is not deleted from the group but merely excluded from the group definition. An example of why this would be useful is when:* John Doe is a member of Group A* Group A is a member of Group B* John Doe shouldn't be a member of Group B, therefore he is to be excluded from Group B||

Request Element

	Data Type

	Description


LoginId

String

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 = "EXCLUDEUSERINGROUP"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.

Group

AdministrationGroup

The AdministrationGroup object holding the Yellowfin user group's name for the retrieval process

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 AdministrationGroup and AdministrationPerson objects:||

AdministrationGroup Element

	Data Type

|| Description ||| GroupName | String |

	Description
GroupName	String	Name of the specified Yellowfin group

|||

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 |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	DELETEUSERFROMGROUP

The following code will call the Yellowfin web service and delete a specified user from a specified group in Yellowfin:

Code Block

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

group.setGroupName("Group Name");
person.setUserId("test@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 you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("DELUSERFROMGROUP");
rsr.setGroup(group);
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 delete a specified Yellowfin user from a specified group. Note that this scenario is different from the one in EXCLUDEUSERINGROUP - in this function a user will be permanently removed from the group.|| 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 = "DELUSERFROMGROUP" | String | Web services function || OrgRef | String | Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional. || Group | AdministrationGroup | The AdministrationGroup object holding the Yellowfin user group's name for the retrieval process || 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 AdministrationGroup and AdministrationPerson objects:|| AdministrationGroup Element || Data Type || Description ||| GroupName | String | Name of the specified Yellowfin group ||| 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 |

Expand

title	MODIFYGROUP

The following code will call the Yellowfin web service and modify the specified group in Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();

group.setGroupName("Group Name");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("MODIFYGROUP");
rsr.setGroup(group);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.Note: you can also put existing Yellowfin users into this modified group at the same time by populating an AdministrationGroupMember array of AdministrationPerson objects. Each AdministrationPerson object only needs the LoginId variable set, and the AdministrationGroupMember array is saved at group.setGroupMembers().This function will modify the details for a specified group in Yellowfin. Note that you are able to save existing Yellowfin users into the new group in this function as well. ||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "MODIFYGROUP"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.

Group

AdministrationGroup

The AdministrationGroup object holding the Yellowfin user group's name for the retrieval process

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

AdministrationGroup Element

	Data Type

|| Description ||| GroupName | String |

	Description
GroupName	String	Name of the specified Yellowfin group

GroupDescription

String

Business description of the specified Yellowfin group

GroupMembers

Array (AdministrationPerson)

|The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	DELETEGROUP

The following code will call the Yellowfin web service and delete the specified group in Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationGroup group = new AdministrationGroup();

group.setGroupName("Group Name");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
rsr.setOrgId(new Integer(1));
// uncomment line below and set Client Reference ID if you wish to get the group in a client organisation
// rsr.setOrgRef("CLIENTREFERENCEIDHERE");
rsr.setFunction("DELETEGROUP");
rsr.setGroup(group);

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 delete a specified group from Yellowfin.||

Request Element

	Data Type

	Description


LoginId

String

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 = "DELETEGROUP"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. The parameter is optional.

Group

AdministrationGroup

The AdministrationGroup object holding the Yellowfin user group's name for the retrieval process

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

AdministrationGroup Element

	Data Type

|| Description ||| GroupName | String |

	Description
GroupName	String	Name of the specified Yellowfin group

|The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Client Organisation Functionality

...

Expand

title	LISTCLIENTS

The following code will call the Yellowfin web service and list all client organisations within Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("LISTCLIENTS");

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return an Array of AdministrationClientOrg objects and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.This function will list all client organisations available within Yellowfin.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "LISTCLIENTS"

String

| Web services function |The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	GETCLIENT

The following code will call the Yellowfin web service and get the specified client organisation within Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();

aco.setClientReferenceId("CLIENTREFERENCEIDHERE");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETCLIENT");
rsr.setClient(aco);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return an AdministrationClientOrg object in rs.getClient() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.
This function will retrieve details for a specified client organisation within Yellowfin.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "GETCLIENT"

	String

Web services function

Client

AdministrationClientOrg

The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process

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

AdministrationClientOrg Element

	Data Type

|| Description ||| ClientReferenceId | Integer |

	Description
ClientReferenceId	Integer	Client Reference ID for the specified client organisation

|The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	CREATECLIENT

The following code will call the Yellowfin web service and create the specified client organisation within Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();

aco.setClientName("CLIENTNAME");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
aco.setTimeZoneCode("AUSTRALIA/SYDNEY");
aco.setDefaultOrg(false);

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("CREATECLIENT");
rsr.setClient(aco);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.The function will create the specified client organisation in Yellowfin.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "CREATECLIENT"

String

Web services function

Client

AdministrationClientOrg

The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process

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

AdministrationClientOrg Element

	Data Type

|| Description ||| ClientName | String |

	Description
ClientName	String	Name of the client organisation

ClientReferenceID

String

Client Reference ID which is the unique ID used to identify a client

TimeZoneCode

String

A client organisation's local time zone code.

DefaultOrg

Boolean

Boolean value that returns true if this organisation is the primary organisation

|The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:* SUCCESS* FAILURE

Expand

title	DELETECLIENT

The following code will call the Yellowfin web service and delete the specified client organisation within Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();

aco.setClientReferenceId("CLIENTREFERENCEIDHERE");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETECLIENT");
rsr.setClient(aco);

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 delete the specified client organisation in Yellowfin.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "DELETECLIENT"

String

Web services function

Client

AdministrationClientOrg

The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process

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

AdministrationClientOrg Element

	Data Type

|| Description ||| ClientReferenceId | Integer |

	Description
ClientReferenceId	Integer	Client Reference ID for the specified client organisation

|The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	UPDATECLIENT

The following code will call the Yellowfin web service and update the specified client organisation within Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();

aco.setClientName("CLIENTNAME");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");
aco.setTimeZoneCode("AUSTRALIA/SYDNEY");
aco.setDefaultOrg(false);

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("UPDATECLIENT");
rsr.setClient(aco);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.The following code will call the Yellowfin webservice and update the specified client organisation within Yellowfin.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "UPDATECLIENT"

String

Web services function

Client

AdministrationClientOrg

The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process

|These are the parameters that you can set in the AdministrationClientOrg object:||

AdministrationClientOrg Element

	Data Type

|| Description ||| ClientName | String |

	Description
ClientName	String	Name of the client organisation

ClientReferenceId

Integer

Client Reference ID for the specified client organisation. Note that this is used for the initial retrieval process, and cannot be modified during the usage of this function

TimeZoneCode

String

A client organisation's local time zone code.

DefaultOrg

Boolean

Boolean value that returns true if this organisation is the primary organisation

|The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:* SUCCESS* FAILURE

Expand

title	LISTUSERSATCLIENT

The following code will call the Yellowfin web service and list all users belonging to the specified client organisation within Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg aco = new AdministrationClientOrg();
AdministrationPerson[] people = null;

aco.setClientReferenceId("CLIENTREFERENCEIDHERE");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("LISTUSERSATCLIENT");
rsr.setClient(aco);

rs = AdministrationService.remoteAdministrationCall(rsr);
people = rs.getPeople();

The code will return an Array of AdministrationPerson objects in rs.getPeople() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.This function will list all Yellowfin users belonging to the specified client organisation in Yellowfin.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "LISTUSERSATCLIENT"

String

Web services function

Client

AdministrationClientOrg

The AdministrationClientOrg object holding the Yellowfin client reference ID for the retrieval process

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

AdministrationClientOrg Element

	Data Type

|| Description ||| ClientReferenceId | Integer |

	Description
ClientReferenceId	Integer	Client Reference ID for the specified client organisation

|The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

People

Array (AdministrationPerson)

Array of AdministrationPerson objects. Each object holds Yellowfin user metadata.

Expand

title	GETUSERACCESS

The following code will call the Yellowfin web service and list all client organisations accessible by a specified user within Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
AdministrationClientOrg[] clients = null;
AdministrationPerson person = new AdministrationPerson();

person.setUserId("test@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETUSERACCESS");
rsr.setPerson(person);

rs = AdministrationService.remoteAdministrationCall(rsr);
clients = rs.getClients();

The code will return an Array of AdministrationClientOrg objects in rs.getClients() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.||

Request Element

	Data Type

	Description


LoginId

String

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 = "GETUSERACCESS"

String

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 AdministrationClientOrg object:||

AdministrationPersonElement

	Data Type

|| Description ||| UserId | String |

	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 |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Clients

Array (AdministrationClientOrg)

Array of AdministrationClientOrg objects. Each object holds Yellowfin client organisation metadata

Expand

title	ADDUSERACCESS

The following code will call the Yellowfin web service and add access to a specified client organisation for a specified user within Yellowfin:

Code Block

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

person.setUserId("test@yellowfin.com.au");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("ADDUSERACCESS");
rsr.setPerson(person);
rs.setClient(aco);

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 add access to a specified client organisation for a specified user win Yellowfin.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "ADDUSERACCESS"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.

Person

AdministrationPerson

The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process

Client

AdministrationClientOrg

The AdministrationClientOrg object holding the Yellowfin client organisation's Client Reference ID for the retrieval process

|These are the parameters that you need to set in the AdministrationPerson and AdministrationClientOrg objects:||

AdministrationPerson Element

	Data Type

|| Description ||| UserId | String |

	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

|||

AdministrationClientOrg Element

	Data Type

	Description


ClientReferenceId

Integer

Client Reference ID for the specified client organisation

||The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	REMOVEUSERACCESS

The following code will call the Yellowfin web service and remove access to a specified client organisation for a specified user within Yellowfin:

Code Block

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

person.setUserId("test@yellowfin.com.au");
aco.setClientReferenceId("CLIENTREFERENCEIDHERE");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("REMOVEUSERACCESS");
rsr.setPerson(person);
rs.setClient(aco);

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 remove access to a specified client organisation for a specified user in Yellowfin.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "REMOVEUSERACCESS"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.

Person

AdministrationPerson

The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process

Client

AdministrationClientOrg

The AdministrationClientOrg object holding the Yellowfin client organisation's Client Reference ID for the retrieval process

|These are the parameters that you need to set in the AdministrationPerson and AdministrationClientOrg objects:||

AdministrationPerson Element

	Data Type

|| Description ||| UserId | String |

	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

|||

AdministrationClientOrg Element

	Data Type

	Description


ClientReferenceId

Integer

Client Reference ID for the specified client organisation

||The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	ADDTOFAVOURITES / ADDTOFAVORITES

The following code will call the Yellowfin web service and add a specified report to a specified user's favourites list:

Code Block

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

person.setUserId("test@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("ADDTOFAVOURITES");
rsr.setPerson(person);
rs.setReportId(12345);

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 add a specified report to a specified user's report favourites list.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "ADDTOFAVOURITES" OR "ADDTOFAVORITES"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.

Person

AdministrationPerson

The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process

ReportId

Integer

Unique ID for the report

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

AdministrationPerson Element

	Data Type

|| Description ||| UserId | String |

	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 |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	REMOVEFAVOURITES / REMOVEFAVORITES

The following code will call the Yellowfin web service and remove a specified report to a specified user's favourites list:

Code Block

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

person.setUserId("test@yellowfin.com.au");

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("REMOVEFAVOURITE");
rsr.setPerson(person);
rs.setReportId(12345);

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 remove a specified report to a specified user's report favourites list.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "REMOVETOFAVOURITES" OR "REMOVETOFAVORITES"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.

Person

AdministrationPerson

The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process

ReportId

Integer

Unique ID for the report

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

AdministrationPerson Element

	Data Type

|| Description ||| UserId | String |

	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 |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

FAILURE

...

Expand

title	GEOMETRYFLUSH

The following code will call the Yellowfin web service and clear the geometry cache in Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin View ID
String[] parameters ={
"48910"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GEOMETRYFLUSH");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.The function will clear the geometry cache in Yellowfin.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "GEOMETRYFLUSH"

String

Web services function

Parameters

Array (String)

The list of View IDs from which the geometry objects are cached with

|The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	REMOVEVIEW

The following code will call the Yellowfin web service and remove a view's cache in Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin View ID
String[] parameters ={
"49283"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("REMOVEVIEW");
rsr.setParameters(parameters);

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 remove a view's cache in Yellowfin.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "REMOVEVIEW"

String

Web services function

Parameters

Array (String)

The list of View IDs

|The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	FLUSHREPORT

The following code will call the Yellowfin web service and remove a report's cached definitions in Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin Report ID
String[] parameters ={
"11111"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("FLUSHREPORT");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.||

Request Element

	Data Type

	Description


LoginId

String

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 = "FLUSHREPORT"

String

Web services function

Parameters

Array (String)

The list of Report IDs

||The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	FLUSHTAB

The following code will call the Yellowfin web service and remove a dashboard's cached definitions in Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin Dashboard Tab ID
String[] parameters ={
"12345"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("FLUSHTAB");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.||

Request Element

	Data Type

	Description


LoginId

String

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 = "FLUSHTAB"

String

Web services function

Parameters

Array (String)

The list of Tab IDs

||The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	DELETEREPORT

The following code will call the Yellowfin web service and delete a report in Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin Report UUID
String[] parameters ={
"7368e6d4-6167-4a16-ba52-ffa2440a5c8c"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETEREPORT");
// If the report ID is not set, then the code will look for the UUID in parameters
rsr.setReportId(12345);
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.||

Request Element

	Data Type

	Description


LoginId

String

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 = "DELETEREPORT"

String

Web services function

Parameters

Array (String)

The UUID of the Yellowfin Report. Note, you do not need to set this if ReportId is set

ReportId

Integer

The Yellowfin Report ID. Note, you do not need to set this if the UUID is set in the Parameter array

||The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	DELETEVIEW

The following code will call the Yellowfin web service and delete a view in Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This example has a Yellowfin View UUID. The parameter value here can be either the UUID
// or the Yellowfin View ID
String[] parameters ={
"7368e6d4-6167-4a16-ba52-ffa2440a5c8c"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETEVIEW");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.||

Request Element

	Data Type

	Description


LoginId

String

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 = "DELETEVIEW"

String

Web services function

Parameters

Array (String)

Either the Yellowfin View ID or UUID can be set here

||The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	DELETESOURCE

The following code will call the Yellowfin web service and delete a data source in Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is the Yellowfin Data Source ID
String[] parameters ={
"23456"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETESOURCE");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return {SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.||

Request Element

	Data Type

	Description


LoginId

String

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 = "DELETESOURCE"

String

Web services function

Parameters

Array (String)

Either the Yellowfin Data Source ID or UUID can be set here

||The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	DELETETAB

The following code will call the Yellowfin web service and delete a dashboard tab in Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is the Yellowfin Dashboard Tab UUID
String[] parameters ={
"7368e6d4-6167-4a16-ba52-ffa2440a5c8c"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("DELETETAB");
rsr.setDashboardTabId(11223);
// If the Dashboard Tab ID is not set, then the code will look for the UUID in parameters
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.||

Request Element

	Data Type

	Description


LoginId

String

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 = "DELETETAB"

String

Web services function

Parameters

Array (String)

UUID of the Yellowfin Dashboard Tab. Note that this does not need to be set if the DashboardTabId parameter is set

DashboardTabId

Integer

Dashboard Tab ID

||The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	RELOADLICENCE

The following code will call the Yellowfin web service and reload the licence definitions in Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("RELOADLICENCE");

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.||

Request Element

	Data Type

	Description


LoginId

String

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 = "RELOADLICENCE"

String

Web services function

||The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	CLOSECONNECTIONPOOL

The following code will call the Yellowfin web service and close the specified data source's connection pool in Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin Data Source ID
String[] parameters ={
"11111"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("CLOSECONNECTIONPOOL");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.||

Request Element

	Data Type

	Description


LoginId

String

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 = "CLOSECONNECTIONPOOL"

String

Web services function

Parameters

Array (String)

Yellowfin Data Source ID

||The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	FLUSHCACHEDFILTERCACHE

The following code will call the Yellowfin web service and flush the specified filter's filter cache in Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// This is a Yellowfin Filter ID
String[] parameters ={
"12345"
};

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("FLUSHCACHEDFILTERCACHE");
rsr.setParameters(parameters);

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.||

Request Element

	Data Type

	Description


LoginId

String

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 = "FLUSHCACHEDFILTERCACHE"

String

Web services function

Parameters

Array (String)

Filter ID

||The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	APPROVEREPORT

The following code will call the Yellowfin web service and approve a report in Yellowfin via the expert approval process:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("APPROVEREPORT");
rsr.setReportId(12345)

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.||

Request Element

	Data Type

	Description


LoginId

String

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 = "APPROVEREPORT"

String

Web services function

ReportId

Integer

Report ID

||The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Expand

title	GETCONTENT

The following code will call the Yellowfin web service and obtain all exportable content within Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
ContentResource[] cr = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETCONTENT");

rs = AdministrationService.remoteAdministrationCall(rsr);
cr = rs.getContentResources();

The code will return an Array of ContentResource objects in rs.getContentResources() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.||

Request Element

	Data Type

	Description


LoginId

String

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 = "GETCONTENT"

String

Web services function

||The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

ContentResources

Array (ContentResource)

Array of Content Resource objects. Each ContentResource object holds export metadata for all exportable content in Yellowfin.

Expand

title	GETEXPORTDEPENDENCIES

The following code will call the Yellowfin web service and obtain dependencies for a specific Yellowfin artifact:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
ContentResource[] cr = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETEXPORTDEPENDENCIES");

rs = AdministrationService.remoteAdministrationCall(rsr);
cr = rs.getContentResources();

The code will return an Array of ContentResource objects in rs.getContentResources() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.This function will obtain dependencies for a specific Yellowfin artifact. Note, you can execute the GETCONTENT webservices call to retrieve all exportable content metadata first. This comes in the form of an array of ContentResource objects which can be then used in this function call to retrieve their respective dependencies.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "GETEXPORTDEPENDENCIES"

String

Web services function

ContentResources

Array (ContentResource)

Array of ContentResource objects. These objects will hold specific Yellowfin artifact metadata

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

ContentResource Element

	Data Type

|||


ResourceName

String

ResourceDescription

String

ResourceType

String

ResourceOrgId

Integer

ResourceCode

String

|The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

ContentResources

Array (ContentResource)

Array of ContentResource objects. These objects will hold dependency metadata

Expand

title	EXPORTCONTENT

The following code will call the Yellowfin web service and export the specified artifacts within Yellowfin:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;

// It is advisable to run a GETCONTENT web service call beforehand to retrieve the necessary ContentResource objects
// This list can be copied over to the exportList array below
ContentResource[] exportList;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("EXPORTCONTENT");
rsr.setContentResources(exportList);

rs = AdministrationService.remoteAdministrationCall(rsr);
rbo = rs.getBinaryAttachments();

The code will return an Array of ReportBinaryObjects objects in rs.getBinaryAttachments() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.This function will export the specified artifacts within Yellowfin. Note, you can execute the GETCONTENT webservices call to retrieve all exportable content metadata first.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "EXPORTCONTENT"

String

Web services function

ContentResources

Array (ContentResource)

Array of ContentResource objects. These objects will hold specific Yellowfin artifact metadata

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

ContentResource Element

	Data Type

|||


ResourceName

String

ResourceDescription

String

ResourceType

String

ResourceOrgId

Integer

ResourceCode

String

|The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

BinaryAttachments

Array(ReportBinaryObjects)

Array of ReportBinaryObject objects. These objects will hold the XML for exported artifacts.

Expand

title	GETIMPORTCONTENT

The following code will call the Yellowfin web service and read a Yellowfin import file, returning the objects to be imported:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
Byte[] data = <XML import file>;
ContentResource[] cr = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("GETIMPORTCONTENT");
rsr.setParameters( new String[] { Base64.encodeBytes(data) } );

rs = AdministrationService.remoteAdministrationCall(rsr);
cr = rs.getContentResources();

The code will return an Array of ContentResource objects in rs.getContentResources() and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.Refer to ws_admin_import.jsp in your Yellowfin web services directory Yellowfindevelopmentexamplesweb services for a more detailed example of how this function would work.This function will read a Yellowfin XML import file and return a list of objects that can be imported into the application. This function will be expecting a Base64 encoded XML file as input.|| Request Element ||

Data Type

|| Description ||| LoginId | String |

	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 = "GETIMPORTCONTENT"

String

Web services function

Parameters

Array (String)

Array of Base64 encoded chunks of the XML import file.

|The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

ContentResources

Array (ContentResource)

Array of ContentResource objects. These objects will hold specific Yellowfin artifact metadata

Expand

title	TESTIMPORTCONTENT

The following code will call the Yellowfin web service and validate the Yellowfin import objects. This function usually follows after the GETIMPORTCONTENT web services call:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
Byte[] data = <XML import file>;
ImportIssue[] ii = null;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("TESTIMPORTCONTENT");
rsr.setParameters( new String[] { Base64.encodeBytes(data) } );

rs = AdministrationService.remoteAdministrationCall(rsr);
ii = rs.getImportIssues();

The code will return an Array of ImportIssue objects in rs.getImportIssues() if there are issues with the import file and SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.Refer to ws_admin_import.jsp in your Yellowfin web services directory Yellowfindevelopmentexamplesweb services for a more detailed example of how this function would work.This function will validate a list of Yellowfin import objects. This function usually follows after the GETIMPORTCONTENT webservices call, where it reads a Yellowfin XML import file and returns a list of objects that can be imported into the application. In this function, it performs a validation process for every object in that list. Any issues encountered during the validation process is returned as ImportIssue objects in the response.||

Request Element

	Data Type

|| Description ||| LoginId | String |

	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 = "TESTIMPORTCONTENT"

String

Web services function

Parameters

Array (String)

An array of Base64 encoded chunks of the XML import file

ImportOptions

Array(ImportOption)

An array of ImportOption objects that controls how content is imported.

|The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

ImportIssues

Array (ImportIssue)

Array of ImportIssue objects. These objects will contain error messages returned from the validation process

Expand

title	IMPORTCONTENT

The following code will call the Yellowfin web service and import the specified Yellowfin import objects into the application:

Code Block

AdministrationServiceRequest rsr = new AdministrationServiceRequest();
AdministrationServiceResponse rs = null;
Byte[] data = <XML import file>;

rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organisation
rsr.setOrgId(new Integer(1));
rsr.setFunction("IMPORTCONTENT");
rsr.setParameters( new String[] { Base64.encodeBytes(data) } );

rs = AdministrationService.remoteAdministrationCall(rsr);

The code will return SUCCESS in rs.getStatusCode(), otherwise it will return an error explaining why the process failed.Refer to ws_admin_import.jsp in your Yellowfin web services directory Yellowfindevelopmentexamplesweb services for a more detailed example of how this function would work.||

Request Element

	Data Type

	Description


LoginId

String

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 = "IMPORTCONTENT"

String

Web services function

Parameters

Array (String)

An array of Base64 encoded chunks of the XML import file

ImportOptions

Array(ImportOption)

An array of ImportOption objects that controls how content is imported.

||The response returned will contain these parameters:||

Response Element

	Data Type

|| Description ||| StatusCode | String |

	Description
StatusCode	String	Status of the web service call. Possible values include:

SUCCESS

FAILURE

Object Definitions

Styleclass

Class	topLink

top

Expand
title AdministrationPerson
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 initial of the Yellowfin user
SalutationCode
String
Title of the Yellowfin 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 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.

Expand
title AdministrationReport
AdministrationReport Element
Data Type
ReportName
String
ReportDescription
String
ReportId
Integer
ExecutionObject
String
ReportCategory
String
ReportSubCategory
String
BirtData
String
SourceName
String
SourceId
Integer
AuthoringMode
String
ReportTemplate
String
DataOutput
String
DashboardEnabled
Boolean
ViewId
Integer
ViewName
String
ViewDescription
String
LastModifierName
String
LastModifierId
Integer
LastModifiedDate
Date
PublishDate
Date
DeliveryMode
String
LastRunTime
Integer
AverageRunTime
Integer
RoleCode
String
ChartTypeCode
String
Usage
Integer

Expand
title AdministrationReportGroup
AdministrationReportGroup Element
Data Type
Description
ReportGroupName
String

ReportGroupDescription
String

ReportGroupId
Integer

ReportGroupStatus
String

ReportGroupType
String

ReportGroupInternalReference
String

GroupReports
Array (AdministrationReports)
Array of AdministrationReport objects which hold report metadata. These are the reports that make up the portlets within the dashboard tab
AssociatedReports
Array (Integer)

...

Content

Space Tools

Page History

Versions Compared

Old Version 14

New Version 15

Key

Retrieving Objects Belonging to a User

ExpandtitleLOADTABREPORTSThis 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 organisation 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

Client Organisation Functionality

ExpandtitleISREPORTFAVOURITEThis function will check if a specified report is in a specified user's favourites list in Yellowfin.

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 = "ISUSERFAVOURITE"

String

Web services function

OrgRef

String

Client Reference ID if this function is to be applied for a particular client organisation. This parameter is optional.

Person

AdministrationPerson

The AdministrationPerson object holding the Yellowfin user's User ID for the retrieval process

ReportId

Integer

Unique ID for the report

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

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.

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

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

Description
StatusCode
String Status of the web service call. Possible values include:

Expand
title ISREPORTFAVOURITE
This function will check if a specified report is in a specified user's favourites list in Yellowfin.

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

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

Description
StatusCode
String
Status of the web service call. Possible values include:

Expand
title GETAVATARS
This function will return all avatar images of specified users within Yellowfin:

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

Description
StatusCode
String
Status of the web service call. Possible values include:

Expand
title SETAVATARIMAGE
This function will set the avatar image of the specified user's profile within Yellowfin:

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