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

Error rendering macro 'rw-search'

null

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

 

 

 

 

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

 

 

 

 

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

 

 

 

 

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)

 

 

 

 

 

AdministrationReportGroup Element

Data Type

Description

RoleName

String

The name of the Yellowfin Role

RoleDescription

String

The business description of the Yellowfin Role

RoleCode

String

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

 

 

 

 

AdministrationGroup Element

Data Type

Description

GroupName

String

 

GroupDescription

String

 

GroupId

Integer

 

GroupStatus

String

 

GroupInternalReference

String

 

GroupMembers

Array (AdministrationGroupMember)

An array of AdministrationGroupMember objects. These objects hold group member metadata

 

 

 

 

AdministrationClientOrg Element

Data Type

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. See appendix for valid values.

DefaultOrg

Boolean

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

 

 

 

 

ReportBinaryObject Element

Data Type

Description

Key

String

Unique key used for Binary Object storage

ContentType

String

MIME type for the Binary Object

Data

Array (Byte)

Raw data for Binary Object

 

 

 

 

ContentResource Element

Data Type

ResourceName

String

ResourceDescription

String

ResourceId

Integer

ResourceUUID

Integer

ResourceType

String

ResourceOrgId

Integer

ResourceCode

String

 

 

 

 

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

 

 

 

 

  • No labels