Like what you see? Have a play with our trial version.

Error rendering macro 'rw-search'

null

Versions Compared

Old Version 5

changes.mady.by.user user-3484a

Saved on

compared with

New Version 6

changes.mady.by.user user-3484a

Saved on

Key

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

...

Expand
titleAdministrationRole

AdministrationReportGroup Element

Data Type

Description

RoleName

String

The name of the Yellowfin Rolerole

RoleDescription

String

The business description of the Yellowfin Rolerole

RoleCode

String

The internal code for the Yellowfin Role role that is generated and referenced in the database

 

 

...

Expand
titleImportOption

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.

OptionKeyOptionValueTask
SKIP

True

False

Skip an item in the import file.
OPTIONADDImport an item from the import file.
OPTIONREPLACE

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

Note: this requires an existing record to be replaced.

EXISTINGContent UUIDThis 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
titleCodes...
Database SystemDatabase Code
Generic ODBC SourceGENERICODBC
Microsoft AccessMSACCESS
DB2 AS400AS400
Cache DBCACHEDB
Columnar DBCOLUMNAR
DB2DB2
Connection CloudCONNECTIONCLOUD
DerbyDERBY

DIAPRISM

DIAPRISM
FileMaker ProFILEMAKER
FirebirdFIREBIRD
FoxProFOXPROODBC
H2H2
HiveHIVE
HSQLDBHSQLDB
InformixINFORMIX
IngresINGRES
VectorwiseVECTORWISE
InterbaseINTERBASE
LucidLUCIDDB
MonetDBMONETDB
MySQLMYSQL
NetezzaNETEZZA
Lotus NotesNOTES
NouDBNOUDB
Progress OpenEdgeOPENEDGE
OracleORACLE
PervasivePERVASIVE
PostgresSQLPOSTGRESQL
ProgressPROGRESS
SAP HANASAPHANA
SASSASJDBC
SqLiteSQLITE
Microsoft SQL ServerMSSQLSERVER
Sybase ASA / Sybase SQL AnywhereSYBASEASA
Sybase ASESYBASEASE
Sybase IQSYBASEIQ
TeraDataTERADATA
UniverseUNIVERSE
VerticaVERTICA
Override the details of a data source type during import.
DRIVERJDBC Driver classnameOverride the details of a data source host during import.
URLA JDBC URLOverride the details of a data source URL during import.
DATASOURCEXMLA Data SourceOverride the details of an XMLA data source during import.
CATALOGXMLA CatalogOverride the details of an XMLA data source catalog during import.
USERNAMESource UsernameOverride the details of a data source username during import.
PASSWORD1Source Password

Override the details of a data source password during import.

Note: this requires PASSWORD2 to be set as well.

PASSWORD2Password ValidationOverride the details of a data source password during import.
SOURCESOURCE<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.
CACHESOURCESOURCE<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.
CATEGORYCategory CodeAssign a Sub Category code to a parent Category during import.
SOURCESOURCE<SourceId>Assign a report to a source during import. An example of the value might be SOURCE39003 for a source with Id 39003.
VIEWVIEW<ViewId>Assign a report to a view during import. An example of the value might be VIEW39003 for a view with Id 39003.
EXECUTIONOBJECTNAMENameAssign a web service exection object name during import. Provide a name that uniquely identifies this report via web services.
CATEGORYCAT<CategoryCode>Assign a report to an existing report category during import. An example of the value might be CATTUTORIAL for a category with a code of TUTORIAL.
SUBCATEGORYCAT<CategoryCode>Assign a report to an existing report sub category, that's a child of the category specified above, during import. An example of the value might be CATTUTORIAL for a category with a code of TUTORIAL.
CATEGORYIMP<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.
SUBCATEGORYIMP<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
titleAdministrationServiceRequest

 

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

 

Object parameters:

Parameter NameTypeDescription
sessionIdString 
loginIdStringThis refers to a Yellowfin account with the web services role enabled. Must be a Yellowfin default (primary) org user.
passwordStringThis refers to the password of the above account.
ntlmBoolean 
orgIdIntegerThis should always be 1, which signifies the default org ID.
loginSessionIdString 
orgRefString 
queryString 
reportIdInteger 
dashboardTabIdInteger 
functionStringThis refers to the type of the call.
personAdministrationPerson 
groupAdministrationGroup 
reportAdministrationReport 
clientAdministrationClientOrg 
reportGroupAdministrationReportGroup 
favouritePersonFavourite 
contentResourcesContentResource[] 
importOptionsImportOption[] 
roleAdministrationRole 
retrospectiveDaysInteger 
binaryDatabyte[] 
peopleAdministrationPerson[] 
datasourceAdministrationDataSource 
sourceClientLinkAdministrationDataSourceClientLink 
sourceIdInteger 
scheduleAdministrationSchedule 

 

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

Code Block
languagejava
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.

 

Expand
titleAdministrationServiceResponse

 

This object is returned by the web service.

 

Parameters of this object:

Parameter nameType
ReportId Integer
StatusCode String
ErrorCode Integer
Messages String[]
SessionId String
LoginSessionId String
person AdministrationPerson
peopleAdministrationPerson[]
group AdministrationGroup
groups AdministrationGroup[]
roles AdministrationRole[]
reports AdministrationReport[]
reportGroups AdministrationReportGroup[]
report AdministrationReport
clients AdministrationClientOrg[]
client AdministrationClientOrg
personfavourites PersonFavourite[]
binaryAttachments ReportBinaryObject[]
contentResources 

ContentResource[]

importIssues ImportIssue[]
EntityIdInteger
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
languagejava
AdministrationServiceResponse ssr = doWebserviceCall(sr);

String statusCode = ssr.getStatusCode();