The primary objects used extensively by the web services examples in this document include:

(1)

Web Services

Web Services are used for managing communication between the OEM application and Yellowfin. The Web Services are XML based and independent of the programming language used to develop the OEM application.

When developing against Yellowfin Web Services, it is possible to generate functional stubs against our WSDL definitions. The Yellowfn Web Services WSDL definitions can be found at http://<yellowfin-server>:<port>/services i.e http://localhost:8080/services

The functional stubs will allow developers to make standard function calls in their native programming language which will directly communicate with the web services provided by Yellowfin. The process of creating functional stubs should also generate any objects required by the web service.

The primary objects used extensively by the web services examples in this document include:

 AdministrationServiceRequest: An object that defines the type of call being made to the web service.

 AdministrationServiceResponse: An object returned by the web service.

Yellowfin Web Services API

Yellowfin ships with a JAR file called yfws.jar. This is located in the development directory within the Yellowfin installation directory.

The Yellowfin Web Service API has pre-generated functional stubs for the Yellowfin Web Services. This can be used directly in applications that are developed in Java, or other languages that support Java integration such as Cold Fusion and Lotus Script. This makes integration slightly simpler as it doesn't require each request to be manually generated, as most of the Web Services are wrapped by a standard Java function.

A Java web service request is of the form:

AdministrationServiceRequest rsr = new AdminstrationServiceRequest();

AdministrationServiceResponse rs = null;

AdministrationPerson person = new AdministrationPerson();

rsr.setLoginId(this.username);

rsr.setPassword(this.password);

rsr.setOrgId(new Integer(1));

rsr.setFunction(“GETUSER”);

rs = AdministrationService.remoteAdministrationCall(rsr);

The yfws.jar also contains Java documentation that outlines the functions that are available.

Administration Service

User Replication and Management Overview

User replication involves synchronising each user in the OEM application with a named user in Yellowfin.

This allows Yellowfin to identify the user who is logged in, and to apply any restrictions that may be required. Sychronisation is usually performed using web service calls from the OEM application to Yellowfin. This can also be managed manually if users in the OEM application are generally static.

This section will outline how to create, manipulate and delete users via web services. It is also assumed that the web service is called to mirror user changes immediately after a user modification is made in the OEM application.

Functions ADDUSER

(2)

This function will create a user in Yellowfin. The details in the AdministrationPerson object will be used in the user creation process.

Request Element Data Type Description Setting Code

LoginId String Login ID of the account used to

connect to Yellowfin webservices i.e

[email protected]

setLoginId()

Password String Password of the account used

to connect to Yellowfin webservices

setPassword()

OrgId Integer Primary Organization ID within

Yellowfin. Always set this to 1.

setOrgId()

Function = “ADDUSER” Web services function setFunction()

Person AdministrationPerson The AdministrationPerson

object holding all of the new user’s details for the user creation process

setPerson()

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

AdministrationPerson Element Data Type Description Setting Code

UserId String User ID of the new user. This

can be the user ID or the email address, depending on the Logon ID method

setUserId()

Password String Password of the new user setPassword()

FirstName String First name of of the new user setFirstName()

LastName String Last name of of the new user setLastName()

Initial String Middle name of the new user setInitial()

SalutationCode String Title of the new user. Possible

values include:

 DR

 MISS

 MR

 MRS

 MS

setSalutationCode()

RoleCode String Yellowfin role. The specified

role here can be the Org Reference Code (YFADMIN) or the name of the role (Yellowfin Administrator)

setRoleCode()

EmailAddress String Email address of the new user setEmailAddress()

The response returned will contain these parameters:

Response Element Data Type Description Retrieval Code

StatusCode String Status of the web service call.

Possible values include:

 SUCCESS

 FAILURE

getStatusCode()

DELUSER/DELETEUSER

This function will delete a user from Yellowfin. The details in the AdministrationPerson object will be used in the user deletion process.

[email protected]

setLoginId()

Password String Password of the account used setPassword()

(3)

setOrgId() Function = “DELUSER” or

“DELETEUSER”

Web services function setFunction()

object holding all of the user’s details for the user creation process

setPerson()

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

UserId String User ID of the Yellowfin user.

This can be the user ID or the email address, depending on the Logon ID method

setUserId()

 SUCCESS

 FAILURE

getStatusCode()

Retrieving and Validating User Information

Once a user has been created, the user’s details can be retrieved using a web service call. The User Id field in the AdministrationPerson object is used to identify the user. As a result, a populated AdministrationPerson object will be returned. For security reasons, passwords will not be returned and will be null. User information can also be validated against the application in this section.

GETUSER

This function will retrieve the details of a particular user in Yellowfin. The details in the AdministrationPerson object will be used in the retrieval process.

connect to Yellowfin webservices i.

[email protected]

setLoginId()

setPassword()

setOrgId()

Function = “GETUSER” Web services function setFunction()

object holding the Yellowfin user’s User ID for the retrieval process

setPerson()

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

setUserId()

(4)

 SUCCESS

 FAILURE

getStatusCode()

object holding all of the returned user’s details

getPerson()

GETUSERBYIP

This function will retrieve the details of a particular user in Yellowfin by looking up their IP ID. The details in the AdministrationPerson object will be used in the retrieval process.

[email protected]

setLoginId()

setPassword()

setOrgId()

Function = “GETUSERBYIP” Web services function setFunction()

object holding all of the new user’s details for the user creation process

setPerson()

IpId Integer IP ID of the Yellowfin user setIpId()

 SUCCESS

 FAILURE

getStatusCode()

getPerson()

GETUSERSFROMSEARCH

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.

[email protected]

setLoginId()

(5)

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

setPassword()

setOrgId() Function =

“GETUSERSFROMSEARCH”

String Web services function setFunction()

Parameters Array (String) Search string to match against

Yellowfin users’ first names, last names, and email address

setParameters()

 SUCCESS

 FAILURE

getStatusCode()

People Array (AdministrationPerson) An array of

AdministrationPerson objects.

These objects hold the returned users’ details that match the search string

getPeople()

VALIDATEUSER

This function will validate a specified Yellowfin user, checking if the user currently exists within the application . The details in the AdministrationPerson object will be used in the user validation process.

[email protected]

setLoginId()

setPassword()

setOrgId()

Function = “VALIDATEUSER” Web services function setFunction()

setPerson()

setUserId()

 SUCCESS

 FAILURE

getStatusCode()

getPerson()

(6)

VALIDATEPASSWORD

This function will validate a Yellowfin user’s password. The details in the AdministrationPerson object will be used in the password validation process.

[email protected]

setLoginId()

setPassword()

setOrgId()

Function = “VALIDATEUSER” Web services function setFunction()

setPerson()

setUserId()

Password String Password of the Yellowfin user setPassword()

 SUCCESS

 FAILURE

getStatusCode()

Manipulating User Information

A user’s details can be modified at a later time using a web service call. The User Id field in the AdministrationPerson object is used to identify the user, so this cannot be changed. The rest of the fields within an AdministrationPerson object is populated with the new changes. For security reasons, the user’s password cannot be changed with this webservice call, but with a separate CHANGEPASSWORD function.

UPDATEUSER

This function will update a specified Yellowfin user’s details. The details in the AdministrationPerson object will be used in the update process.

[email protected]

setLoginId()

setPassword()

(7)

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

setOrgId()

Function = “UPDATEUSER” Web services function setFunction()

setPerson()

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

AdministrationPerson Element

Data Type Description Retrieval Code

UserId String User ID of the Yellowfin user. This can be the user

ID or the email address, depending on the Logon ID method

setUserId()

Password String Password of the Yellowfin user setPassword()

FirstName String First name of of the Yellowfin user setFirstName()

LastName String Last name of of the Yellowfin user setLastName()

Initial String Middle name of the Yellowfin user setInitial()

SalutationCode String Title of the Yellowfin user. Possible values include:

 DR

 MISS

 MR

 MRS

 MS

setSalutationCode()

RoleCode String Yellowfin role. The specified role here can be the Org Reference Code (YFADMIN) or the name of the role (Yellowfin Administrator)

setRoleCode()

EmailAddress String Email address of the Yellowfin user setEmailAddress()

LanguageCode String Two letter code for the preferred language setLanguageCode()

IpId Integer Internal Yellowfin IP ID setIpId()

TimeZoneCode String The TimeZoneCode of the Yellowfin user.

 AFRICA/ABIDJAN

 AFRICA/ACCRA

 AFRICA/ADDIS_ABABA

 AFRICA/ALGIERS

 AFRICA/ASMERA

 AFRICA/BANGUI

 AFRICA/BANJUL

 AFRICA/BISSAU

 AFRICA/BLANTYRE

 AFRICA/BUJUMBURA

 AFRICA/CAIRO

 AFRICA/CASABLANCA

 AFRICA/CONAKRY

 AFRICA/DAKAR

 AFRICA/DAR_ES_SALAAM

 AFRICA/DJIBOUTI

 AFRICA/DOUALA

 AFRICA/FREETOWN

 AFRICA/GABORONE

 AFRICA/HARARE

 AFRICA/JOHANNESBURG

 AFRICA/KAMPALA

 AFRICA/KHARTOUM

 AFRICA/KIGALI

 AFRICA/KINSHASA

 AFRICA/LAGOS

 AFRICA/LIBREVILLE

 AFRICA/LOME

 AFRICA/LUANDA

 AFRICA/LUBUMBASHI

 AFRICA/LUSAKA

setTimeZoneCode()

(8)

 AFRICA/MALABO

 AFRICA/MAPUTO

 AFRICA/MASERU

 AFRICA/MBABANE

 AFRICA/MOGADISHU

 AFRICA/MONROVIA

 AFRICA/NAIROBI

 AFRICA/NDJAMENA

 AFRICA/NIAMEY

 AFRICA/NOUAKCHOTT

 AFRICA/OUAGADOUGOU

 AFRICA/PORTO-NOVO

 AFRICA/SAO_TOME

 AFRICA/TIMBUKTU

 AFRICA/TRIPOLI

 AFRICA/TUNIS

 AFRICA/WINDHOEK

 AMERICA/ADAK

 AMERICA/ANCHORAGE

 AMERICA/ANGUILLA

 AMERICA/ANTIGUA

 AMERICA/ARUBA

 AMERICA/ASUNCION

 AMERICA/BARBADOS

 AMERICA/BELIZE

 AMERICA/BOGOTA

 AMERICA/BUENOS_AIRES

 AMERICA/CARACAS

 AMERICA/CAYENNE

 AMERICA/CAYMAN

 AMERICA/CHICAGO

 AMERICA/COSTA_RICA

 AMERICA/CUIABA

 AMERICA/CURACAO

 AMERICA/DAWSON_CREEK

 AMERICA/DENVER

 AMERICA/DOMINICA

 AMERICA/EDMONTON

 AMERICA/EL_SALVADOR

 AMERICA/FORTALEZA

 AMERICA/GODTHAB

 AMERICA/GRAND_TURK

 AMERICA/GRENADA

 AMERICA/GUADELOUPE

 AMERICA/GUATEMALA

 AMERICA/GUAYAQUIL

 AMERICA/GUYANA

 AMERICA/HALIFAX

 AMERICA/HAVANA

 AMERICA/INDIANAPOLIS

 AMERICA/JAMAICA

 AMERICA/LA_PAZ

 AMERICA/LIMA

 AMERICA/LOS_ANGELES

 AMERICA/MANAGUA

 AMERICA/MANAUS

 AMERICA/MARTINIQUE

 AMERICA/MAZATLAN

 AMERICA/MEXICO_CITY

 AMERICA/MIQUELON

 AMERICA/MONTEVIDEO

 AMERICA/MONTREAL

 AMERICA/MONTSERRAT

 AMERICA/NASSAU

 AMERICA/NEW_YORK

 AMERICA/NORONHA

 AMERICA/PANAMA

 AMERICA/PARAMARIBO

(9)

 AMERICA/PHOENIX

 AMERICA/PORT_OF_SPAIN

 AMERICA/PORT-AU-PRINCE

 AMERICA/PORTO_ACRE

 AMERICA/PUERTO_RICO

 AMERICA/REGINA

 AMERICA/RIO_BRANCO

 AMERICA/SANTIAGO

 AMERICA/SANTO_DOMINGO

 AMERICA/SAO_PAULO

 AMERICA/SCORESBYSUND

 AMERICA/ST_JOHNS

 AMERICA/ST_KITTS

 AMERICA/ST_LUCIA

 AMERICA/ST_THOMAS

 AMERICA/ST_VINCENT

 AMERICA/TEGUCIGALPA

 AMERICA/THULE

 AMERICA/TIJUANA

 AMERICA/TORTOLA

 AMERICA/VANCOUVER

 AMERICA/WINNIPEG

 ANTARCTICA

 ANTARCTICA/CASEY

 ANTARCTICA/DUMONTDURVILLE

 ANTARCTICA/MCMURDO

 ANTARCTICA/PALMER

 ASIA/ADEN

 ASIA/ALMATY

 ASIA/AMMAN

 ASIA/ANADYR

 ASIA/AQTAU

 ASIA/AQTOBE

 ASIA/ASHGABAT

 ASIA/ASHKHABAD

 ASIA/BAGHDAD

 ASIA/BAHRAIN

 ASIA/BAKU

 ASIA/BANGKOK

 ASIA/BEIRUT

 ASIA/BISHKEK

 ASIA/BRUNEI

 ASIA/CALCUTTA

 ASIA/COLOMBO

 ASIA/DACCA

 ASIA/DAMASCUS

 ASIA/DHAKA

 ASIA/DUBAI

 ASIA/DUSHANBE

 ASIA/HONG_KONG

 ASIA/IRKUTSK

 ASIA/JAKARTA

 ASIA/JAYAPURA

 ASIA/JERUSALEM

 ASIA/KABUL

 ASIA/KAMCHATKA

 ASIA/KARACHI

 ASIA/KATMANDU

 ASIA/KRASNOYARSK

 ASIA/KUALA_LUMPUR

 ASIA/KUWAIT

 ASIA/MACAO

 ASIA/MAGADAN

 ASIA/MANILA

 ASIA/MUSCAT

 ASIA/NICOSIA

 ASIA/NOVOSIBIRSK

 ASIA/PHNOM_PENH

(10)

 ASIA/PYONGYANG

 ASIA/QATAR

 ASIA/RANGOON

 ASIA/RIYADH

 ASIA/SAIGON

 ASIA/SEOUL

 ASIA/SHANGHAI

 ASIA/SINGAPORE

 ASIA/TAIPEI

 ASIA/TASHKENT

 ASIA/TBILISI

 ASIA/TEHRAN

 ASIA/THIMBU

 ASIA/THIMPHU

 ASIA/TOKYO

 ASIA/UJUNG_PANDANG

 ASIA/ULAANBAATAR

 ASIA/ULAN_BATOR

 ASIA/VIENTIANE

 ASIA/VLADIVOSTOK

 ASIA/YAKUTSK

 ASIA/YEKATERINBURG

 ASIA/YEREVAN

 ATLANTIC/AZORES

 ATLANTIC/BERMUDA

 ATLANTIC/CANARY

 ATLANTIC/CAPE_VERDE

 ATLANTIC/FAEROE

 ATLANTIC/JAN_MAYEN

 ATLANTIC/REYKJAVIK

 ATLANTIC/SOUTH_GEORGIA

 ATLANTIC/ST_HELENA

 ATLANTIC/STANLEY

 AUSTRALIA/ADELAIDE

 AUSTRALIA/BRISBANE

 AUSTRALIA/BROKEN_HILL

 AUSTRALIA/DARWIN

 AUSTRALIA/HOBART

 AUSTRALIA/LORD_HOWE

 AUSTRALIA/PERTH

 AUSTRALIA/SYDNEY

 EUROPE/AMSTERDAM

 EUROPE/ANDORRA

 EUROPE/ATHENS

 EUROPE/BELGRADE

 EUROPE/BERLIN

 EUROPE/BRUSSELS

 EUROPE/BUCHAREST

 EUROPE/BUDAPEST

 EUROPE/CHISINAU

 EUROPE/COPENHAGEN

 EUROPE/DUBLIN

 EUROPE/GIBRALTAR

 EUROPE/HELSINKI

 EUROPE/ISTANBUL

 EUROPE/KALININGRAD

 EUROPE/KIEV

 EUROPE/LISBON

 EUROPE/LONDON

 EUROPE/LUXEMBOURG

 EUROPE/MADRID

 EUROPE/MALTA

 EUROPE/MINSK

 EUROPE/MONACO

 EUROPE/MOSCOW

 EUROPE/OSLO

 EUROPE/PARIS

 EUROPE/PRAGUE

(11)

 EUROPE/RIGA

 EUROPE/ROME

 EUROPE/SAMARA

 EUROPE/SIMFEROPOL

 EUROPE/SOFIA

 EUROPE/STOCKHOLM

 EUROPE/TALLINN

 EUROPE/TIRANE

 EUROPE/VADUZ

 EUROPE/VIENNA

 EUROPE/VILNIUS

 EUROPE/WARSAW

 EUROPE/ZURICH

 GMT

 INDIAN/ANTANANARIVO

 INDIAN/CHAGOS

 INDIAN/CHRISTMAS

 INDIAN/COCOS

 INDIAN/COMORO

 INDIAN/KERGUELEN

 INDIAN/MAHE

 INDIAN/MALDIVES

 INDIAN/MAURITIUS

 INDIAN/MAYOTTE

 INDIAN/REUNION

 PACIFIC/APIA

 PACIFIC/AUCKLAND

 PACIFIC/CHATHAM

 PACIFIC/EASTER

 PACIFIC/EFATE

 PACIFIC/ENDERBURY

 PACIFIC/FAKAOFO

 PACIFIC/FIJI

 PACIFIC/FUNAFUTI

 PACIFIC/GALAPAGOS

 PACIFIC/GAMBIER

 PACIFIC/GUADALCANAL

 PACIFIC/GUAM

 PACIFIC/HONOLULU

 PACIFIC/KIRITIMATI

 PACIFIC/KOSRAE

 PACIFIC/MAJURO

 PACIFIC/MARQUESAS

 PACIFIC/NAURU

 PACIFIC/NIUE

 PACIFIC/NORFOLK

 PACIFIC/NOUMEA

 PACIFIC/PAGO_PAGO

 PACIFIC/PALAU

 PACIFIC/PITCAIRN

 PACIFIC/PONAPE

 PACIFIC/PORT_MORESBY

 PACIFIC/RAROTONGA

 PACIFIC/SAIPAN

 PACIFIC/TAHITI

 PACIFIC/TARAWA

 PACIFIC/TONGATAPU

 PACIFIC/TRUK

 PACIFIC/WAKE

 PACIFIC/WALLIS

getStatusCode()

(12)

 SUCCESS

 FAILURE

object holding all of the updated user’s details

getPerson()

CHANGEPASSWORD

This function will change a specified Yellowfin user’s password.

[email protected]

setLoginId()

setPassword()

“CHANGEPASSWORD”

Web services function setFunction()

setPerson()

AdministrationPerson Element Data Type Description Retrieval Code

setUserId()

Password String New password of the Yellowfin

user

setPassword()

 SUCCESS

 FAILURE

getStatusCode()

Retrieving objects belonging to a user

Objects belonging to a user in a primary or client organization can be retrieved with various web service calls. The objects returned in the response will be dependent on the type of call made in the request.

GETUSERREPORTS

This function will return all reports with a webservice name that are accessible for the specified Yellowfin user.

connect to Yellowfin

setLoginId()

(13)

webservices i.

[email protected]

setPassword()

setOrgId()

Function = “GETUSERREPORTS” String Web services function setFunction()

OrgRef String Client Reference ID if this

function is to be applied for a particular client organization.

This parameter is optional.

setOrgRef()

setPerson()

setUserId()

 SUCCESS

 FAILURE

getStatusCode()

Reports AdministrationReport An array of

AdministrationReport objects.

These objects hold report metadata.

getReports()

GETALLUSERREPORTS

This function will return all reports that are accessible for the particular user:

[email protected]

setLoginId()

setPassword()

“GETALLUSERREPORTS”

setOrgRef()

setPerson()

(14)

setUserId()

 SUCCESS

 FAILURE

getStatusCode()

getReports()

GETREPORTSWITHCOMMENTS

This function will return all commented reports in Yellowfin that are accessible by the specified Yellowfin user.

[email protected]

setLoginId()

setPassword()

“GETREPORTSWITHCOMMENTS”

setOrgRef()

setPerson()

setUserId()

 SUCCESS

 FAILURE

getStatusCode()

These objects hold report

getReports()

(15)

metadata.

GETFAVOURITES / GETFAVORITES

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

[email protected]

setLoginId()

setPassword()

setOrgId() Function = “GETFAVOURITES”

or “GETFAVORITES”

setOrgRef()

setPerson()

setUserId()

 SUCCESS

 FAILURE

getStatusCode()

getReports()

GETINBOX

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

[email protected]

setLoginId()

setPassword()

OrgId Integer Primary Organization ID within setOrgId()

(16)

Function = “GETINBOX” String Web services function setFunction()

setOrgRef()

setPerson()

setUserId()

 SUCCESS

 FAILURE

getStatusCode()

getReports()

GETUSERTABS

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

[email protected]

setLoginId()

setPassword()

setOrgId()

Function = “GETUSERTABS” String Web services function setFunction()

setOrgRef()

setPerson()

setUserId()

(17)

 SUCCESS

 FAILURE

getStatusCode()

ReportGroups AdministrationReportGroup An array of

AdministrationReportGroup objects. These objects hold dashboard metadata.

getReportsGroups()

GETUSERTABSWITHREPORTS

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.

[email protected]

setLoginId()

setPassword()

“GETUSERTABSWITHREPORTS”

setOrgRef()

setPerson()

setUserId()

 SUCCESS

 FAILURE

getStatusCode()

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

getReportsGroups()

(18)

parameter.

LOADTABREPORTS

This function will return a list of reports contained within a specified dashboard tab, that is accessible by a specified user in Yellowfin.

[email protected]

setLoginId()

setPassword()

setOrgId()

Function = “LOADTABREPORTS” String Web services function setFunction()

setPerson()

ReportGroup AdministrationReportGroup The

AdministrationReportGroup object holding the Dashboard Tab ID for the retrieval process

setReportGroup()

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

setUserId()

AdministrationReportGroup Element

ReportGroupId String Dashboard Tab ID seReportGroupId()

 SUCCESS

 FAILURE

getStatusCode()

ReportGroups AdministrationReportGroup This array holds one AdministrationReportGroup object which contains dashboard metadata. For this particular function, the reports’

metadata is also loaded into this object’s GroupReports() parameter.

getReportsGroups()

Group and Role Administration

Groups and roles can be created and modified with a web service call. The objects returned in the response is dependent on the type of call made in the request.

(19)

Note: If Client Organisation functionality is turned on in the Configuration page, a client organization can also be specified where applicable for certain types of calls.

LISTROLES

This function will return all the available roles within Yellowfin.

[email protected]

setLoginId()

setPassword()

setOrgId()

Function = “LISTROLES” String Web services function setFunction()

 SUCCESS

 FAILURE

getStatusCode()

Roles AdministrationRole An array of AdministrationRole

objects. These objects hold Yellowfin Role metadata.

getReportsGroups()

LISTGROUPS

This function will return all available user groups in Yellowfin.

[email protected]

setLoginId()

setPassword()

setOrgId()

Function = “LISTGROUPS” String Web services function setFunction()

setOrgRef()

 SUCCESS

 FAILURE

getStatusCode()

Groups AdministrationGroup An array of

AdministrationGroup objects.

These objects hold Yellowfin user group metadata.

getGroups()

(20)

GETGROUP

This function will return a specified Yellowfin group with a list of its members.

[email protected]

setLoginId()

setPassword()

setOrgId()

Function = “GETGROUP” String Web services function setFunction()

setOrgRef()

Group AdministrationGroup The AdministrationGroup

object holding the Yellowfin user group’s name for the retrieval process

setGroup()

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

AdministrationGroup Element Data Type Description Retrieval Code

GroupName String Name of the specified Yellowfin

Group

setGroupName()

 SUCCESS

 FAILURE

getStatusCode()

object holding group metadata.

The group members are also loaded into this object’s GroupMembers() parameter.

getGroup()

CREATEGROUP

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.

[email protected]

setLoginId()

setPassword()

setOrgId()

Function = “CREATEGROUP” String Web services function setFunction()

(21)

OrgRef String Client Reference ID if this function is to be applied for a particular client organization.

setOrgRef()

setGroup()

group

setGroupName()

GroupDescription String Business description of the

specified Yellowfin group

setGroupDescription() GroupMembers Array (AdministrationPerson) An array of

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.

setGroupMembers()

 SUCCESS

 FAILURE

getStatusCode()

INCLUDEUSERINGROUP

This function will include a specified Yellowfin user into a specified group.

[email protected]

setLoginId()

setPassword()

“INCLUDEUSERINGROUP”

setOrgRef()

setGroup()

setPerson()

(22)

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

group

setGroupName()

setUserId()

 SUCCESS

 FAILURE

getStatusCode()

EXCLUDEUSERINGROUP

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

[email protected]

setLoginId()

setPassword()

“EXCLUDEUSERINGROUP”

setOrgRef()

setGroup()

setPerson()

group

setGroupName()

(23)

setUserId()

 SUCCESS

 FAILURE

getStatusCode()

DELUSERFROMGROUP

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.

[email protected]

setLoginId()

setPassword()

“DELUSERFROMGROUP”

setOrgRef()

setGroup()

setPerson()

group

setGroupName()

setUserId()

 SUCCESS

 FAILURE

getStatusCode()

(24)

MODIFYGROUP

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.

[email protected]

setLoginId()

setPassword()

setOrgId()

Function = “MODIFYGROUP” String Web services function setFunction()

setOrgRef()

setGroup()

group

setGroupName()

GroupDescription String Business description of the

specified Yellowfin group

setGroupDescription() GroupMembers Array (AdministrationPerson) An array of

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 LoginId parameter set.

setGroupMembers()

 SUCCESS

 FAILURE

getStatusCode()

DELETEGROUP

This function will delete a specified group from Yellowfin.

setLoginId()

(25)

[email protected]

setPassword()

setOrgId()

Function = “DELETEGROUP” String Web services function setFunction()

setOrgRef()

setGroup()

group

setGroupName()

 SUCCESS

 FAILURE

getStatusCode()

LOADBIRTREPORT

Client Organisation Functionality

Yellowfin features functionality called “Client Organisations” which allows multiple virtual instances of Yellowfin to reside in the same server instance.

This allows content to be created and segregated from other organisations logging onto the same Yellowfin server. Client Organisation functionality operates on a two-tier basis. The top tier, known as the Primary Organisation (default), can have content that is shared between all Client Organisations. Content created at the second-tier will not be visible to any other second-tier instances of Yellowfin.

Users can be given access to log in to the default organisation and/or one or more client organisations. Content such as data sources, reports, and dashboards can belong to either the default organisation or one of the client organisations. When a user logs in to an organisation (default or client), any content they create “belongs” to that organisation.

Client Organisation functionality can be managed with the available web service calls listed below:

LISTCLIENTS

This function will list all client organizations available within Yellowfin.

[email protected]

setLoginId()

Password String Password of the account used setPassword()

(26)

setOrgId()

Function = “LISTCLIENTS” String Web services function setFunction()

setOrgRef()

 SUCCESS

 FAILURE

getStatusCode()

GETCLIENT

This function will retrieve details for a specified client organization within Yellowfin:

[email protected]

setLoginId()

setPassword()

setOrgId()

Function = “GETCLIENT” String Web services function setFunction()

setOrgRef()

Client AdministrationClientOrg The AdministrationClientOrg

object holding the Yellowfin client reference ID for the retrieval process

setClient()

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

AdministrationClientOrg Element

ClientReferenceId Integer Client Reference ID for the

specified client organization

setClientReferenceId

 SUCCESS

 FAILURE

getStatusCode()

CREATECLIENT

(27)

The function will create the specified client organization in Yellowfin.

[email protected]

setLoginId()

setPassword()

setOrgId()

Function = “CREATECLIENT” String Web services function setFunction()

setOrgRef()

object holding the Yellowfin client reference ID for the creation process

setClient()

ClientName String Name of the client organization getClientName()

ClientReferenceID String Client Reference ID which is the

unique ID used to identify a client

getClientReferenceId()

TimeZoneCode String A client organization’s local

time zone code. Possible values include:

getTimeZoneCode()

DefaultOrg Boolean Boolean value that returns true

if this organization is the primary organization

getDefaultOrg()

 SUCCESS

 FAILURE

getStatusCode()

DELETECLIENT

This function will delete the specified client organization in Yellowfin.

[email protected]

setLoginId()

setPassword()

setOrgId()

Function = “DELETECLIENT” String Web services function setFunction()

setOrgRef()

(28)

object holding the Yellowfin client reference ID for the retrieval process

setClient()

 SUCCESS

 FAILURE

getStatusCode()

UPDATECLIENT

The following code will call the Yellowfin webservice and update the specified client organization within Yellowfin:

[email protected]

setLoginId()

setPassword()

setOrgId()

Function = “UPDATECLIENT” String Web services function setFunction()

setOrgRef()

object holding the Yellowfin client reference ID for the update process

setClient()

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

ClientName String Name of the client organization getClientName()

specified client organization.

Note that this is used for the initial retrieval process, and cannot be modified during the usage of this function

TimeZoneCode String A client organization’s local

time zone code. Possible values include:

getTimeZoneCode()

DefaultOrg Boolean Boolean value that returns true

if this organization is the primary organization

getDefaultOrg()

(29)

 SUCCESS

 FAILURE

getStatusCode()

LISTUSERSATCLIENT

This function will list all Yellowfin users belonging to the specified client organization in Yellowfin.

[email protected]

setLoginId()

setPassword()

“LISTUSERSATCLIENT”

setOrgRef()

object holding the Yellowfin client reference ID for the update process

setClient()

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

 SUCCESS

 FAILURE

getStatusCode()

People Array (AdministrationPerson) Array of AdministrationPerson objects. Each object holds Yellowfin user metadata

getPeople()

GETUSERACCESS

This function will list all client organizations accessible by a specified user in Yellowfin.