This documentation corresponds to a historical version of Yellowfin

Icon

Access the latest release, or view a list of available versions of the documentation.

Skip to end of metadata
Go to start of metadata

Functions

 PDF

The PDF request runs a specified report and returns it in PDF form. The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

ReportId

Integer

ID of the specified report

getReportId()

ReportName

String

Name of the specified report

getReportName()

HitCount

Integer

Number of times the specified report has been accessed

getHitCount()

FormatCode

String

Format code of the specified report

getFormatCode()

BinaryData

String

Base64 encoded binary chunk of PDF

getBinaryData()

ContentType

String

MIME Content Type of this object. Value will be “application/pdf”

getContentType()

 CSV

The CSV request runs a specified report and returns it in CSV form. The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

ReportId

Integer

ID of the specified report

getReportId()

ReportName

String

Name of the specified report

getReportName()

HitCount

Integer

Number of times the specified report has been accessed

getHitCount()

FormatCode

String

Format code of the specified report

getFormatCode()

BinaryData

String

Base64 encoded binary chunk of CSV

getBinaryData()

ContentType

String

MIME Content Type of this object. Value will be “text/comma-separated-values”

getContentType()

 XLS

The XLS request runs a specified report and returns it in XLS form. The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

ReportId

Integer

ID of the specified report

getReportId()

ReportName

String

Name of the specified report

getReportName()

HitCount

Integer

Number of times the specified report has been accessed

getHitCount()

FormatCode

String

Format code of the specified report

getFormatCode()

BinaryData

String

Base64 encoded binary chunk of XLS

getBinaryData()

ContentType

String

MIME Content Type of this object. Value will be “application/xls”

getContentType()

 TEXT

The TEXT request runs a specified report and returns it in TEXT form. The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

ReportId

Integer

ID of the specified report

getReportId()

ReportName

String

Name of the specified report

getReportName()

HitCount

Integer

Number of times the specified report has been accessed

getHitCount()

FormatCode

String

Format code of the specified report

getFormatCode()

BinaryData

String

Base64 encoded binary chunk of XLS

getBinaryData()

ContentType

String

MIME Content Type of this object. Value will be “text/tab-separated-values”

getContentType()

 RTF

The RTF request runs a specified report and returns it in RTF form. The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

ReportId

Integer

ID of the specified report

getReportId()

ReportName

String

Name of the specified report

getReportName()

HitCount

Integer

Number of times the specified report has been accessed

getHitCount()

FormatCode

String

Format code of the specified report

getFormatCode()

BinaryData

String

Base64 encoded binary chunk of XLS

getBinaryData()

ContentType

String

MIME Content Type of this object. Value will be “application/rtf”

getContentType()

 DOC

The DOC request runs a specified report and returns it in DOC form. The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

ReportId

Integer

ID of the specified report

getReportId()

ReportName

String

Name of the specified report

getReportName()

HitCount

Integer

Number of times the specified report has been accessed

getHitCount()

FormatCode

String

Format code of the specified report

getFormatCode()

BinaryData

String

Base64 encoded binary chunk of XLS

getBinaryData()

ContentType

String

MIME Content Type of this object. Value will be “application/vnd.ms-word”

getContentType()

 SCHEMA

The SCHEMA request returns schematic information of the specified report, which includes metadata for report columns and filters as well. The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

ReportId

Integer

ID of the specified report

getReportId()

StatusCode

String

Status of the web service request

getStatusCode()

FormatCode

String

Format code of the specified report

getFormatCode()

ReportType

String

Report type of the specified report

getReportType()

LastRunStatus

String

Status code of last report run

getLastRunStatus()

LastRunTime

Decimal

Last report run time in the format of YYYYMMDDHHMMSS

getLastRunTime()

ReportName

String

Name of the specified report

getReportName()

BinaryData

String

Base64 encoded binary chunk of image, HTML, CSV, or PDF

getBinaryData()

ViewName

String

Name of view that the report depends on

getViewName()

HitCount

Integer

Number of times the specified report has been accessed

getHitCount()

DrillCode

String

Drill type if available on the report

getDrillCode()

Private

 

Determines if the report is a private or a public one

getPrivate()

Results

Array (ReportRow)

Array of ReportRow objects that contain results in the report result set (see ReportRow)

getResults()

ContentType

String

MIME ContentType of the returned object. Possible values include:

  • “text/html”
  • “text/comma-separated-values”
  • “image/png”
  • “application/pdf”

getContentType()

Messages

Array (String)

Array of Strings that show debug information as the report is run on the server. Used for debugging and tracing errors

getMessages()

Charts

Array (ReportChart)

Array of ReportChart objects that contains multiple chart bitmaps when attached to a HTML report response (see ReportChart)

getCharts()

Columns

Array (ReportSchema)

Array of ReportSchema objects that contain information on each column in the report result set, and whether the report requires user prompt filter data to be passed to it (see ReportSchema)

getColumns()

 HTML / HTMLCHARTONLY / HTMLTABLEONLY

The HTML request will return a HTML representation of the report. The HTML document will be Base64 encoded, with the charts/images being stored in the Charts array field. These artefacts will need to be manually decoded by the client system, and the URL request string is used to embed the URL within the HTML for decoding the Base64 images.

The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

Chart

Array (ReportChart)

Array of ReportChart objects that contains multiple chart bitmaps when attached to a HTML report response (see ReportChart)

getCharts()

ReportBinaryObject

Array (ReportBinaryObject)

Array of ReportBinaryObject objects that contain BLOBs and CLOBs (see ReportBinaryObject)

getBinaryObjects()

ReportStyles

String

CSS styles

getReportStyles()

Breadcrumbs

Array (Breadcrumb)

Array of Breadcrumb objects

getBreadcrumbs()

SeriesSelection

Array (SeriesSelection)

Array of SeriesSelection objects

getSeriesSelections()

TimeAggregationSelection

Array (TimeAggregationSelection)

Array of TimeAggregationSelection objects

getTimeAggregationSelection()

ReportTabSelection

Array (ReportTabSelection)

Array of ReportTabSelection objects

getReportTabSelection()

ReportPageSelection

Array (ReportPageSelection)

Array of ReportPageSelection objects

getReportPageSelection()

TimeSliderSelection

Array (TimeSliderSelection)

Array of TimeSliderSelection objects

getTimeSliderSelection()

SortableColumns

Array (SortableTableColumn)

Array of SortableTableColumn objects

getSortableColumns()

SelectedSortColumn

Integer

Column used for sorting. The index here applies to the column index within the report

getSelectedSortColumn()

SelectedSortOrder

Integer

The sort order of the column used for sorting (0 for ascending and 1 for descending)

getSelectedSortOrder()

DrillCode

String

Drill type if available on the report

getDrillCode()

RelatedReports

Array (RelatedReport)

Array of RelatedReport objects. These are reports that are tabbed/codisplayed to the main report

getRelatedReports()

BinaryData

String

Base64 encoded binary chunk of the HTML document

getBinaryData()

Private

 

Determines if the report is a private or a public one

getPrivate()

ContentType

String

MIME ContentType of the returned object. Value will be “text/html”

getContentType()

CanDrill

Boolean

If the report is able to drill or not

getCanDrill()

GoogleMaps

Array (GMap)

Array of GMap objects

getGoogleMaps()

 FILTEROPTIONS

The FILTEROPTIONS request will return the filter values available for a particular report’s filter.

The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

Results

Array (ReportRow)

Array of ReportRow objects that contain filter values (see ReportRow)

getResults()

 RESULTSET

The RESULTSET request will return the result data set for a particular report. This result will be stored in an array of ReportRow objects, with each ReportRow object representing a row in the report data set. The ReportRow object will also consist of an array of strings that represents the data in each column in the data set.

It is up to the web services client to convert this data from the string representation into the data type for each particular column. The data types for each column can be obtained with the SCHEMA request function call.

The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

Results

Array (ReportRow)

Array of ReportRow objects that contain results in the report result set (see ReportRow)

getResults()

 EXPIRESESSION

The EXPIRESESSION request will cause a specified Yellowfin session to expire.

The following code will accomplish this:

 GETCOMMENTS

The GETCOMMENTS request will retrieve all comments for a particular report.

The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

Comments

Array (ReportComment)

Array of ReportComment objects that contain the report’s comments (see ReportComment)

getComments()

 LEAVECOMMENT

The LEAVECOMMENT request will create a comment/response to a comment in a particular report.

The following code will accomplish this:

 DELETECOMMENT

The DELETECOMMENT request will delete the particular comment from a report.

The following code with accomplish this:

 COMMENTSTATUS

The COMMENTSTATUS request will set the status of a particular comment.

The following code will accomplish this:

 DISTRIBUTEINBOX

The DISTRIBUTEINBOX request will distribute a report to the inboxes of a list of recipients.

The following code will accomplish this:

 GETDISPLAYEDREPORTID

The GETDISPLAYEDREPORTID request will return the report ID of the currently displayed report.

The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

DisplayedReportId

Integer

Report ID of the currently displayed report

getDisplayedReportId()

 GETKPI

The GETKPI request will return you the KPI object for a particular KPI report. This function request is usually utilised within the mobile application.

The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

KPI

KPI object

This is a custom KPI object which holds the actual, target, and variance values for a particular KPI metric (see KPI)

getKPI()

 GETDRILLANYWHEREMENU

The GETDRILLANYWHEREMENU request will return you the Drill Anywhere menu that is available for the selected report column. This function request is usually utilized within the mobile application.

The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

DrillAnywhereCategories

Array (String)

Array of Strings

getDrillAnywhereCategories()

DrillAnywhereTargets

Array (DrillAnywhereTarget)

Array of DrillAnywhereTarget objects that lists the drill anywhere targets for a drill anywhere category (see DrillAnywhereTarget)

getDrillAnywhereTargets()

 SUBSCRIBEDETAILS

The SUBSCRIBEDETAILS request will return the schedule record for a particular report.

The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

ScheduleRecord

ScheduleRecord object

ScheduleRecord object which contains subscription details and conditions (see ScheduleRecord)

getSchedule()

 SUBSCRIBE

The SUBSCRIBE request will create/modify a subscription to a specified report for a specified user. This function request is usually called after SUBSCRIBEDETAILS to retrieve a current subscription first, otherwise a ScheduleRecord object must be created and populated appropriately (refer to ScheduleRecord) for this function call.

The following code will accomplish this:

 UNSUBSCRIBE

The UNSUBSCRIBE request will unsubscribe a specified user from a specified report.

The following code will accomplish this:

 LOADDASHBOARDTAB

The LOADDASHBOARDTAB request will load a specified dashboard tab and its metadata.

The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

DashboardDefinition

DashboardDefinition object

DashboardDefinition object which contains dashboard tab metadata (see DashboardDefinition)

getDashboard()

 APPLYDASHBOARDFILTERS

The following code will accomplish this:

 GETDASHBOARDREPORTFILTERVALUES

The GETDASHBOARDREPORTFILTERVALUES request will return filter metadata for a particular report on a dashboard tab.

The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

ReportFilters

Array (ReportFilter)

Array of Filter objects containing metadata for each filter (see ReportFilter)

getReportFilters()

 RUNDASHBOARDREPORT

The RUNDASHBOARDREPORT request will run and export a specified report on a dashboard tab. The response will include Base64 encoded generated html, including charts, GIS maps, and CSS styles.

The following code will accomplish this:

The returned ReportServiceResponse object consists of:

Response Element

Data Type

Description

Retrieval Code

BinaryData

String

Base64 encoded binary chunk of HTML

getBinaryData()

Charts

Array (ReportChart)

Array of ReportChart objects (see ReportChart)

getCharts()

ReportStyle

String

CSS styles

GetReportStyle()

Breadcrumbs

Array (Breadcrumb)

Array of Breadcrumb objects

getBreadcrumbs()

GoogleMaps

Array (GMap)

Array of GoogleMaps objects if the report’s chart uses it

getGoogleMaps()

GisMap

Array (GISMap)

Array of GISMap objects if the report’s chart uses it

getGisMap()

Object Definitions

 ReportComment

ReportComment Element

Data Type

Description

Retrieval Code

CommentId

Integer

ID of comment

getCommentId()

AuthorId

Integer

ID of comment author

getAuthorId()

Comment

String

Comment value

getComment()

ReportId

Integer

Report ID of which the comment resides on

getReportId()

ParentCommentId

Integer

Main ID of comment it is connected to. This applies if the particular comment is a reply to a parent comment

getParentCommentId()

StatusCode

String

Comment status

getStatusCode()

CommentDate

DateTime

Date and time value for comment creation

getCommentDate()

LastActivityDate

DateTime

Date and time value for the most current update to that particular comment

getLastActivityDate()

 ReportRow

ReportRow Element

Data Type

Description

Retrieval Code

DataValue

Array (String)

Array of Strings with data for each column in the report result set

getDataValue()

 ReportChart

ReportChart Element

Data Type

Description

Retrieval Code

ReportIndex

Integer

Index of image in the embedded delivered HTML

getReportIndex()

Content Type

String

MIME Content Type of this chart. Possible values include:

  • “image/png”
  • “image/jpg”

getContentType()

Data

String

Base64 binary image data

getData()

Filename

String

Filename of embedded file in HTML

getFilename()

 ReportSchema

ReportSchema Element

Data Type

Description

Retrieval Code

ColumnName

String

Column Name

getColumnName()

DisplayName

String

Display name of column

getDisplayName()

FieldId

Integer

Field Id of column

getFieldId()

DataType

String

Data type of column

getDataType()

ColumnLength

String

Column length

getColumnLength()

Hidden

Boolean

Whether the column is displayed in the report or not

getHidden()

Prompt

Boolean

Whether the column is a prompt field or not

getPrompt()

FilterId

Integer

Filter Id if the column is a filter

getFilterId()

FilterType

String

Determines the filter type and what data would have to be posted to engage the prompt

getFilterType()

AllowPrompt

Boolean

 

getAllowPrompt()

FilterOmittable

Boolean

 

getFilterOmittable()

ParentFilterId

Integer

Filter Id of parent filter if a filter dependency is in place

getParentId()

DefaultValue1

 

First default value for filter if set

getDefaultValue1()

DefaultValue2

 

Second default value for filter if set

getDefaultValue2()

ValueUnitCode

 

Time units for the filter if set

getValueUnitCode()

FilterDisplayType

 

Filter Display Type if the column is a filter

getFilterDisplayType()

MinimumValue

 

Minimum value for filter if set

getMinimumValue()

MaximumValue

 

Maximum value for filter if set

getMaximumValue()

 ReportBinaryObject

ReportBinaryObject Element

Data Type

Description

Retrieval Code

ContentType

String

MIME Content Type

getContentType()

Data

String

Base64 binary data

getData()

Key

String

Key of the ReportBinaryObject object

getKey()

 KPI

KPI Element

Data Type

Description

Retrieval Code

Actual

String

The actual value for a KPI metric

getActual()

Target

String

The target value for a KPI metric

getTarget()

Variance

String

The variance value for a KPI metric

getVariance()

 DrillAnywhereTarget

DrillAnywhereTarget Element

Data Type

Description

Retrieval Code

ParentCategory

String

Parent Category value

getParentCategory()

Targets

Array (String)

Array of String values which are the targets for a particular parent category

getTargets()

 ScheduleRecord

ScheduleRecord Element

Data Type

Description

Retrieval Code

Recipient

Integer

ID of recipient of the subscription

getRecipient()

Subject

String

Subscription subject

getSubject()

BodyText

String

Subscription message

getBodyText()

FrequencyTypeCode

String

Subscription frequency. Values include:

  • MINUTES
  • DAILY
  • WEEKLY
  • FORTNIGHTLY
  • MONTHLY
  • QUARTERLY
  • BIANNUAL
  • ANNUAL
  • ENDOFMONTH

getFrequencyTypeCode()

FrequencyCode

String

Additional frequency codes depending on the frequency type code

getFrequencyCode()

FrequencyUnit

String

Additional frequency units depending on the frequency type code

getFrequencyCode()

Format

String

Subscription File Type. Values include:

  • PDF
  • HTML
  • CSV
  • DOC
  • XLS
  • RTF

getFormat()

ConditionList

Array (Condition)

Array of Condition objects that store delivery rules (see Condition)

getConditionList()

AdvancedTimezoneCode

String

Timezone in which the subscription happens

getAdvancedTimezoneCode()

AdvancedTime

Integer

Local run time for the subscription

getAdvancedTime()

 Condition

Condition Element

Data Type

Description

Retrieval Code

Operator

String

Filter operator for the column(s). Values include:

  • BETWEEN
  • NOTBETWEEN
  • EQUAL
  • NOTEQUAL
  • GREATER
  • GREATEREQUAL
  • INLIST
  • NOTINLIST
  • ISNULL
  • ISNOTNULL
  • LESS
  • LESSEQUAL
  • STARTSWITH
  • NOTSTARTSWITH
  • CONTAINS
  • NOTCONTAINS
  • ENDSWITH
  • NOTENDSWITH

getOperator()

FieldId

Integer

Field Id of column

getFieldId()

Value1

String

First conditional value

getValue1()

Value2

String

Second conditional value. This is needed if the operators are BETWEEN, NOTBETWEEN, etc.

getValue2()

 DashboardDefinition

DashboardDefinition Element

Data Type

Description

Retrieval Code

TabId

Integer

ID of the dashboard tab

getTabId()

GroupTypeCode

String

Type of dashboard tab. Values include:

  • ANALYTIC
  • KPI
  • STANDARD

getGroupTypeCode()

Owner

Integer

ID of dashboard owner

getOwner()

OwnerTypeCode

String

Type of dashboard owner. Value defaults to ORGANISATION

getOwnerTypeCode()

AccessCode

String

Security level of the dashboard tab

getAccessCode()

StartDate

Date

Creation Date

getStartDate()

EndDate

Date

End Date (if applicable)

getEndDate()

StatusCode

String

Status of the dashboard tab

getStatusCode()

ShortDescription

String

Name of the dashboard tab

getShortDescription()

LongDescription

String

Business description of the dashboard tab

getLongDescription()

LanguageCode

String

Two letter language code

getLanguageCode()

StyleCode

String

Layout code. Values include:

  • SINGLE
  • TWO
  • THREE
  • WIDENARROW
  • NARROWWIDE

getStyleCode()

Audience

String

Audience description

getAudience()

ParentGroupId

Integer

If the dashboard tab is in draft mode, the original tab ID is saved into this column

getParentGroupId()

Elements

Array (DashboardElement)

A DashboardElement object contains portlet information for reports that reside within the dashboard tab (See DashboardElement)

getElements()

Filters

Array (DashboardFilterDefinition)

A DashboardFilterDefinition object contains format records pertaining the dashboard tab, analytic filters, and filter groups (See DashboardFilterDefinition)

getFilters()

Fields

Array (DashboardFieldDefinition)

A DashboardFieldDefinition object contains format records pertaining fields being displayed as drilldowns on the dashboard tab

getFields()

 DashboardElement

DashboardElement Element

Data Type

Description

Retrieval Code

TabId

Integer

ID of the dashboard tab

getTabId()

EntityId

Integer

ID of the portlet, which also happens to be the Report ID

getEntityId()

EntityTypeCode

String

Portlet entity type. Value defaults to REPORT

getEntityTypeCode()

ColumnNumber

Integer

Indicating where the portlet is column-wise. The first column starts at the value 1

getColumnNumber()

RowNumber

Integer

Indicating where the portlet is row-wise. The first row starts at the value 1

getRowNumber()

SequenceNumber

Integer

Portlet loading sequence within the dashboard tab

getSequenceNumber()

StartDate

Date

Date the portlet was added

getStartDate()

PortletStatus

String

Portlet status

getPortletStatus()

PortletHeight

Integer

Portlet height in pixels

getPortletHeight()

 DashboardFieldDefinition

DashboardFieldDefinition Element

Data Type

Description

Retrieval Code

TabId

Integer

ID of the dashboard tab

getTabId()

FieldId

Integer

Field ID of column

getFieldId()

FieldType

String

Field data type. Values include:

  • BOOLEAN
  • DATE
  • GISGEOMETRY
  • GISMULTIPOLY
  • GISPOINT
  • NUMERIC
  • TEXT
  • TIMESTAMP

getFieldType()

ReportId

Integer

ID of report

getReportId()

TemplateId

Integer

ID of corresponding field template record

getTemplateId()

FieldName

String

Column name

getFieldName()

FieldDescription

String

Column name

getFieldDescription()

 DashboardFilterDefinition

DashboardFilterDefinition Element

Data Type

Description

Retrieval Code

GroupId

Integer

ID of the dashboard tab

getGroupId()

ComponentId

Integer

Numeric ID for the component based on the component type

getComponentId()

ComponentTypeCode

String

Component types for a DashboardFilterDefinition object include:

  • FILTER (individual analytic filter)
  • FILTERGROUP (analytic filter group)
  • NULL (general dashboard tab)

getComponentTypeCode()

EntityId

Integer

 

getEntityId()

EntityTypeCode

String

Entity types for a DashboardFilterDefinition object include:

  • REPORT (analytic filters)
  • REPORTGROUP (general dashboard tab)

getEntityTypeCode()

FormatKey

String

Format Code

getFormatKey()

FormatValue

String

Format Value

getFormatValue()

 ReportFilter

ReportFilter Element

Data Type

Description

Retrieval Code

FilterId

Integer

ID of the filter

getFilterId()

IsOmitted

Boolean

If the filter is omitted by default

getIsOmitted()

DataValue

String

Filter values for a particular filter. If there are two values (i.e if the filter operator is BETWEEN, etc) then they are concatenated with a pipe value

getDataValue()

 DashboardFilter

DashboardFilter Element

Data Type

Description

Retrieval Code

ReportId

Integer

ID of the report that the filter belongs to

getReportId()

FilterType

String

Filter operator

getFilterType()

FilterId

Integer

ID of the filter

getFilterId()

TabId

Integer

ID of the dashboard tab that the report

getTabId()

FilterValue

String

Filter values for a particular filter. If the filter operator involves the usage of two values (i.e BETWEEN, etc) then both values are concatenated with a pipe value

getFilterValue()

TemplateId

Integer

ID of the field template record. This applies if the Filter Type is DRILL, etc

getTemplateId()