Page History

Versions Compared

Key

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

...

Expand
title GETUSERFROMSEARCH
This function will retrieve users from Yellowfin based on a specific search string. This string is compared against the user's first name, last name, and email address.
Request Element
Data Type
Description
LoginId
String
Login ID of the account used to connect to Yellowfin webservices i.e admin@yellowfin.com.au
Password
String
Password of the account used to connect to Yellowfin webservices
OrgId
Integer
Primary organisation ID within Yellowfin. Always set this to 1.
Function = "GETUSERSFROMSEARCH"

String
Web services function
Parameters
Array (String)
Search string to match against Yellowfin users' first names, last names, and email address
The response returned will contain these parameters:
Response Element
Data Type
Description
StatusCode
String
Status of the web service call. Possible values include:
SUCCESS
FAILURE
People
Array (AdministrationPerson)
An array of AdministrationPerson objects. These objects hold the returned users' details that match the search string

...

Expand

title	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	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	Client Reference ID for the specified client organisation

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	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	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	Client Reference ID for the specified client organisation

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	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	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	Client Reference ID for the specified client organisation

The response returned will contain these parameters:

Response Element

Data Type

Description

StatusCode

String

Status of the web service call. Possible values include:

SUCCESS
FAILURE

People

Array (AdministrationPerson)

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

Clients

Array (AdministrationClientOrg)

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

...

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

Versions Compared

Old Version 9

New Version 10

Key