Error rendering macro 'rw-search'

null

Page History

Versions Compared

Old Version 6

changes.mady.by.user user-3484a

Saved on 06 Feb, 2018

compared with

New Version 7

changes.mady.by.user user-3484a

Saved on 11 Feb, 2018

Key

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

Following are the object specific to the Administration web services:

Anchor

	AdminServiceRequest
	AdminServiceRequest

Expand

title	AdministrationServiceRequest

This object defines the type of call being made to the web service.

Object parameters:

Parameter Name	Type	Description
sessionId	String
loginId	String	This refers to a Yellowfin account with the web services role enabled. Must be a Yellowfin default (primary) org user.
password	String	This refers to the password of the above account.
ntlm	Boolean
orgId	Integer	This should always be 1, which signifies the default org ID.
loginSessionId	String
orgRef	String
query	String
reportId	Integer
dashboardTabId	Integer
function	String	This refers to the type of the call.
person	AdministrationPerson
group	AdministrationGroup
report	AdministrationReport
client	AdministrationClientOrg
reportGroup	AdministrationReportGroup
favourite	PersonFavourite
contentResources	ContentResource[]
importOptions	ImportOption[]
role	AdministrationRole
retrospectiveDays	Integer
binaryData	byte[]
people	AdministrationPerson[]
datasource	AdministrationDataSource
sourceClientLink	AdministrationDataSourceClientLink
sourceId	Integer
schedule	AdministrationSchedule

All parameters have corresponding “get” and “set” methods. For instance:

Code Block

language	java

AdministrationServiceRequest sr = new AdministrationServiceRequest();
sr.setSessionId(savedSessionID);

It is not necessary to define all the parameters; each web service call has a list of the required parameters. Unspecified parameters will have a null value by default.

There are, however, mandatory parameters for any request, listed below:

loginId
password
orgId
function

Other parameters will be required depending on the function value.

Each request must contain the web service user details, that is who can call Yellowfin web services. This must be an existing user with the “Web services” role enabled, and these details should be specified as loginId, password, orgId.

Anchor

	AdminServiceResponse
	AdminServiceResponse

Expand

title	AdministrationServiceResponse

This object is returned by the web service.

Parameters of this object:

Parameter name	Type
ReportId	Integer
StatusCode	String
ErrorCode	Integer
Messages	String[]
SessionId	String
LoginSessionId	String
person	AdministrationPerson
people	AdministrationPerson[]
group	AdministrationGroup
groups	AdministrationGroup[]
roles	AdministrationRole[]
reports	AdministrationReport[]
reportGroups	AdministrationReportGroup[]
report	AdministrationReport
clients	AdministrationClientOrg[]
client	AdministrationClientOrg
personfavourites	PersonFavourite[]
binaryAttachments	ReportBinaryObject[]
contentResources	ContentResource[]
importIssues	ImportIssue[]
EntityId	Integer
parentDashboard	ParentDashboard
parentDashboards	ParentDashboard[]
parentReportGroups	ParentReportGroup[]
binaryData	String
contentType	String
fileName	String
queryResults	ReportRow[]
datasources	AdministrationDataSource[]
loadedDataSource	AdministrationDataSource
schedule	AdministrationSchedule

All parameters have corresponding “get” and “set” methods. For instance:

Code Block

language	java

AdministrationServiceResponse ssr = doWebserviceCall(sr);

String statusCode = ssr.getStatusCode();

Anchor

	AdminPerson
	AdminPerson

Expand

title	AdministrationPerson

This object is used to define a Yellowfin user involved in a function.

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.
Status	String	User status. One of ACTIVE INACTIVE INACTIVEWITHEMAIL

...

All parameters have corresponding “get” and “set” methods. For instance:

Expand

title	ImportOption

ImportOption Element	Data Type	Description
ItemIndex	Integer	The index of the item that this option is attached too.
OptionKey	String	The type of option.
OptionValue	String	A value associated with this option.

OptionKey

OptionValue

Task

SKIP

True

False

Skip an item in the import file.

OPTION

ADD

Import an item from the import file.

OPTION

REPLACE

Replace an existing item with an item from the import file.

Note: this requires an existing record to be replaced.

EXISTING

Content UUID

This requries the internal ID of the content you are replacing. For example, if the item is a View, then this value will be an existing ViewId. If the item is a Category or Sub Category it will be the CategoryCode rather than an ID.

DATABASETYPECODE

Expand

title	Codes...

Database System	Database Code
Generic ODBC Source	GENERICODBC
Microsoft Access	MSACCESS
DB2 AS400	AS400
Cache DB	CACHEDB
Columnar DB	COLUMNAR
DB2	DB2
Connection Cloud	CONNECTIONCLOUD
Derby	DERBY
DIAPRISM	DIAPRISM
FileMaker Pro	FILEMAKER
Firebird	FIREBIRD
FoxPro	FOXPROODBC
H2	H2
Hive	HIVE
HSQLDB	HSQLDB
Informix	INFORMIX
Ingres	INGRES
Vectorwise	VECTORWISE
Interbase	INTERBASE
Lucid	LUCIDDB
MonetDB	MONETDB
MySQL	MYSQL
Netezza	NETEZZA
Lotus Notes	NOTES
NouDB	NOUDB
Progress OpenEdge	OPENEDGE
Oracle	ORACLE
Pervasive	PERVASIVE
PostgresSQL	POSTGRESQL
Progress	PROGRESS
SAP HANA	SAPHANA
SAS	SASJDBC
SqLite	SQLITE
Microsoft SQL Server	MSSQLSERVER
Sybase ASA / Sybase SQL Anywhere	SYBASEASA
Sybase ASE	SYBASEASE
Sybase IQ	SYBASEIQ
TeraData	TERADATA
Universe	UNIVERSE
Vertica	VERTICA

Override the details of a data source type during import.

DRIVER

JDBC Driver classname

Override the details of a data source host during import.

URL

A JDBC URL

Override the details of a data source URL during import.

DATASOURCE

XMLA Data Source

Override the details of an XMLA data source during import.

CATALOG

XMLA Catalog

Override the details of an XMLA data source catalog during import.

USERNAME

Source Username

Override the details of a data source username during import.

PASSWORD1

Source Password

Override the details of a data source password during import.

Note: this requires PASSWORD2 to be set as well.

PASSWORD2

Password Validation

Override the details of a data source password during import.

SOURCE

SOURCE<SourceId>

Attach a view to another source. An example of the value might be SOURCE39003 for a source with Id 39003.

CACHEVIEW

True

False

Toggle whether a cached view is still cached on import.

CACHESOURCE

SOURCE<SourceId>

Select a source to cache the view against on import. An example of the value might be SOURCE39003 for a source with Id 39003.

CATEGORY

IMP<CategoryCode>

Assign a report to a category within the same export file during import. An example of the value might be IMPTUTORIAL for a category with a code of TUTORIAL.

SUBCATEGORY

IMP<CategoryCode>

Assign a report to an existing report sub category within the same export file, that's a child of the category specified above, during import. An example of the value might be IMPTUTORIAL for a category with a code of TUTORIAL.

Expand

title	AdministrationServiceRequest

This object defines the type of call being made to the web service.

Object parameters:

person

Parameter Name	Type	Description
sessionId	String
loginId	String	This refers to a Yellowfin account with the web services role enabled. Must be a Yellowfin default (primary) org user.
password	String	This refers to the password of the above account.
ntlm	Boolean
orgId	Integer	This should always be 1, which signifies the default org ID.
loginSessionId	String
orgRef	String
query	String
reportId	Integer
dashboardTabId	Integer
function	String	This refers to the type of the call.	AdministrationPerson

group

AdministrationGroup

report

AdministrationReport

client

AdministrationClientOrg

reportGroup

AdministrationReportGroup

favourite

PersonFavourite

contentResources

ContentResource[]

importOptions

ImportOption[]

role

AdministrationRole

retrospectiveDays

Integer

binaryData

byte[]

people

AdministrationPerson[]

datasource

AdministrationDataSource

sourceClientLink

AdministrationDataSourceClientLink

sourceId

Integer

schedule

AdministrationSchedule

Code Block

language	java

AdministrationServiceRequest sr = new AdministrationServiceRequest();
sr.setSessionId(savedSessionID);

It is not necessary to define all the parameters; each web service call has a list of the required parameters. Unspecified parameters will have a null value by default.

There are, however, mandatory parameters for any request, listed below:

loginId
password
orgId
function

Other parameters will be required depending on the function value.

Expand

title	AdministrationServiceResponse

This object is returned by the web service.

Parameters of this object:

Parameter name	Type
ReportId	Integer
StatusCode	String
ErrorCode	Integer
Messages	String[]
SessionId	String
LoginSessionId	String
person	AdministrationPerson
people	AdministrationPerson[]
group	AdministrationGroup
groups	AdministrationGroup[]
roles	AdministrationRole[]
reports	AdministrationReport[]
reportGroups	AdministrationReportGroup[]
report	AdministrationReport
clients	AdministrationClientOrg[]
client	AdministrationClientOrg
personfavourites	PersonFavourite[]
binaryAttachments	ReportBinaryObject[]
contentResources	ContentResource[]
importIssues	ImportIssue[]
EntityId	Integer
parentDashboard	ParentDashboard
parentDashboards	ParentDashboard[]
parentReportGroups	ParentReportGroup[]
binaryData	String
contentType	String
fileName	String
queryResults	ReportRow[]
datasources	AdministrationDataSource[]
loadedDataSource	AdministrationDataSource
schedule	AdministrationSchedule

All parameters have corresponding “get” and “set” methods. For instance:

Code Block

language	java

AdministrationServiceResponse ssr = doWebserviceCall(sr); String statusCode = ssr.getStatusCode();

Content

Space Tools

Page History

Versions Compared

Old Version 6

New Version 7

Key