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

Versions Compared

Key

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

...

Expand
titleContentResource


ContentResource Element

Data Type

Description

ResourceName

String

 

ResourceDescription

String

 

ResourceId

Integer

 

ResourceUUID

Integer

 

ResourceType

String

Mandatory parameter. The resource type for each of the content types:
  • RPTCATEGORY (Report category)
  • RPTSUBCATEGORY (Report subcategory)
  • DATASOURCE (Data source)
  • VIEW (View)
  • GROUP (Dashboard)
  • REPORT (Report)
  • ETLPROCESS (Transformation flow)

ResourceOrgId

Integer

 

ResourceCode

String

 Mandatory parameter. (Found in Yellowfin's database.)

 

 

Anchor
importOption
importOption

...

Expand
titleAdministrationDataSource


SourceDescription
Parameter

Request Element

Data Type

Description

AccessLevelCode

 String Description of data source.
SourceId Integer Unique Yellowfin ID for the data source.
SourceName String Name of the data source.

String

To specify the permission/access level of this database.

ClientSources

AdministrationDataSourceClientLink


ConnectionDriver

String

Driver used to connect to data source.

ConnectionPath

String


ConnectionString

String

Data source's connection string.

ConnectionTimeout

Integer

This is specified in seconds.

ConnectionType

String

Type of the connection. Example includes, JDBC, etc.

ConnectionTypeCode

String


InheritChildSourceFilters

Boolean


LogFile

String


MaxRows

Integer

Max number of data rows retrieved.

MaxmimumConnections

Integer


MinimumConnections

Integer


RefreshTime

Integer

This is specified in hours.

SourceDescription

String

Description of data source.

SourceId

Integer

Unique Yellowfin ID for the data source. This must be specified when editing an existing data source, because if not provided, a new data source will be created.

SourceName

String

 Name of the data source.

SourceOptions

AdministrationDataSourceOption


SourceType

String

Type of data source. Example includes,

SourceType String Type of data source. Example includes,

MySQL, Oracle, etc.

Timezone

 

String

 


UserName

String

 

Username for the data source account. 

UserPassword

String

Password of the above account.

ConnectionDriverStringDriver used to connect to

The password will be encrypted automatically when saving the data source.

ConnectionString




 

StringData source's connection string.
ConnectionTimeoutInteger 
ConnectionTypeStringType of the connection. Example includes, JDBC, etc.
ConnectionTypeCodeString 
AccessLevelCodeStringCode for the access level.
InheritChildSourceFiltersString 

Anchor
AdminDataSourceOption
AdminDataSourceOption

Expand
titleAdministrationDataSourceOption


Parameter

Type

OptionKey

String

OptionValue

String

ValueDataType

String



 

Anchor
adminDataSournceClientLink
adminDataSournceClientLink

 
Expand
titleAdministrationDataSourceClientLink


Parameter

Type

clientOrgId

Integer

clientOrgRef

String

sourceId

Integer

MaxRowsIntegerMax number of data rows retrieved.
MaxmimumConnectionsInteger 
MinimumConnectionsInteger 
RefreshTimeInteger 



 

Anchor
adminSchedule
adminSchedule

...