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

Error rendering macro 'rw-search'

null

Versions Compared

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

 


 

Anchor
AdminFunction
AdminFunction

Expand
titleAdministrationFunction

All possible parameters for this object:

 

Parameter NameData TypeDescription
FunctionNameString Name of the function.
FunctionCodeStringUnique code for the function. 
FunctionDescriptionStringFunction's description to define its purpose. 
FunctionTypeCodeString 
AccessLevelCodeString Code to set the access level of this function.

 

A list of possible functions in Yellowfin. (Report Access is mandatory)

Note: This is an extension of Role Security Functions.

 

Expand
titleSee list of functions
Function NameCodeDesciptionType CodeAccess Level Code

Report Access 

MIREPORT 

Allows users to log in and view, create, edit or delete reports 

TN 

CRUD 

Activity Stream

ACTIVITYSTREAM

Allows users to access the activity stream.

null

CRUD

Ad Hoc Reports

ADHOCREPORTS

Allows users to create Ad Hoc reports.

null

CRUD

Approval Admin

ADMINAPPROVE

Allows users to manage outstanding content approvals without having to be specified as the approver.

null

CRUD

Advanced Spreadsheet Functionality

ADVANCEDEXCEL

Enables users to perform advanced operations on spreadsheet/CSV reports, such as selecting the data source.

null

CRUD

Stored Procedures

ADVANCEDSQL

Allows users to create views against Stored Procedures.

null

CRUD

Hide Advanced Report Search

ADVRPTSEARCH

Hides the Advanced Search on the Browse page.

null

CRUD

Allow Freehand SQL Calculated Fields

ALLOWFREEHANDSQLCALCFIELD

Allows users to create Freehand SQL Calculated Fields in reports.

null

CRUD

Translate content

ALLOWTRANSLATE

Allows users to translate user entered data on dashboards, reports and views.

null

CRUD

Annotations

ANNOTATIONS

Allows users to read, edit, create and delete annotations.

null

CRUD

Background Execution Management

BACKGROUNDMANAGEMENT

Allows users to view the current background execution queue, cancel current queries, and force start queued items.

null

CRUD

Plugin Management

BINARYLOADER

Allows users to manage plugins including Third Party Source Conncetions, JDBC Drivers, and Advanced Functions.

null

CRUD

Bookmarks and Snapshots

BOOKMARKS

Allows users to create and use bookmarks and snapshots.

null

CRUD

Broadcast Reports

BROADCAST

Allows users to broadcast reports on a one-off or scheduled basis

null

CRUD

Subscribe to Broadcast

BROADCASTSUBSCRIBE

Allows users to subscribe to report broadcasts.

null

CRUD

Client Organisation Management

CLIENTORGS

Allows users to set up and manage Client Organisations.

null

CRUD

Composite Views

COMPOSITE

Allows users to create Composite Views.

null

CRUD

Create Spreadsheet Table

CREATESSTABLE

Allows users to create a spreadsheet tables within a view.

null

CRUD

Custom Query Filters

CUSTOMFILTER

Allows users to create reports with drop-down User Prompt filters populated by custom SQL queries.

null

CRUD

Public Dashboards

DASHPUBLIC

Allows users to create and edit Public dashboards.

null

CRUD

Refresh Dashboard Reports

DASHREFRESH

Allows users to set a refresh period on Dashboard reports

null

CRUD

Data Sources

DATASOURCE

Allows users to create and edit Data Sources

null

CRUD

Data Source Admin

DATASOURCEADMIN

Allows users to create and edit all data sources regardless of security restrictions

null

CRUD

Database Views

DATAVIEW

Allows users to create and edit Database Views

null

CRUD

Disable Cached Filter Values

DISABLECACHEDFILTERS

Disables users from caching report filter values.

null

CRUD

Disable Mobile Access

DISABLEMOBILE

Stops a user from accessing reports via a native mobile application.

null

CRUD

Collaboration Admin

DISCUSSIONADMIN

Allow users full administration access to discussion streams, comments, and tasks both public and private.

null

CRUD

Discussion Groups

DISCUSSIONGROUPS

Allows users to browse and contribute to discussion groups.

null

CRUD

Distribute Reports

DISTRIBUTEREPORT

Allows users to distribute reports or Dashboard Tabs to other users

null

CRUD

Distribute Storyboards

DISTRIBUTESTORYBOARD

Allows users to distribute Storyboards to other users.

null

CRUD

Show Draft Dashboards

DRAFTDASHBOARDS

Shows Dashboards being edited by other users.

null

CRUD

Draft Content List

DRAFTRPTLIST

Displays a list of recently accessed draft content on the Dashboard and Browse pages.

null

CRUD

Show Draft Views

DRAFTVIEWS

Shows Views being edited by other users.

null

CRUD

Related Content

DRILLTHROUGH

Allows users to enable Co-Display, Drill Down, Drill Anywhere, and Drill Through functionality.

null

CRUD

Email Storyboards

EMAILSTORYBOARD

Allows users to send an adhoc email copy of a Storyboard.

null

CRUD

Error Email Link

ERROREMAIL

Do not show a link to send an email on the error page when something goes wrong.

null

CRUD

Error Stacktrace

ERRORSTACKTRACE

Show a stacktrace on the error page when something goes wrong.

null

CRUD

Transformation Flows

ETLPROCESS

Allow the user to create and edit transformation flows. Warning: This should only be enabled for trusted developers, as it will allow them to run custom scripts.

null

CRUD

Spreadsheet Reports

EXCELREPORTS

Allows users to write reports based on spreadsheet and CSV files.

null

CRUD

Export Reports to CSV

EXPORTCSV

Allows users to export report results to CSV

null

CRUD

Export Reports and Dashboards to DOC

EXPORTDOC

Allows users to export content items to DOC.

null

CRUD

Export Reports and Dashboards to XLS

EXPORTEXCEL

Allows users to export content items to XLS.

null

CRUD

Export Content to PDF

EXPORTPDF

Allows users to export content items to PDF.

null

CRUD

Export Report Settings

EXPORTSETTINGS

Allow users to define the export settings for a report through the save menu, rather than relying on the system default.

null

CRUD

Export

EXPORTVIEW

Allows users to export content to XML files for backup or transfer to another system.

null

CRUD

Multicast Reports

MULTICAST

Allows users to broadcast reports to external users

null

CRUD

Multicast Access Filter Reports

MULTICASTSRCFILTER

Allows users to broadcast reports with access filters to external users. The credentials of the user who creates the broadcast will be used to send the report to external users.

null

CRUD

Named User

NAMEDUSER

Allows a user to bypass concurrent logon limitations.

null

CRUD

OLAP

OLAP

Allows users to connect to OLAP Data Sources

null

CRUD

Configuration

ORGCONFIG

Allows users to modify system parameters

null

CRUD

Org Reference Codes

ORGREFCODES

Allows users to manage Org Reference Codes from the Admin Console.

null

CRUD

Configure Page Format

PAGEFORMAT

Allows users to configure the page layout (integration settings, etc)

null

CRUD

Public Storyboards

PUBLICSTORYBOARD

Allows users to make a Storyboard public.

null

CRUD

Public Reports

REPORTCORPORATE

Allows users to create and edit Public reports

null

CRUD

Personal Dashboard

REPORTDASHBOARD

Gives users access to the dashboard page, and allows them to create their personal dashboard, visible only to them.

null

CRUD

Assisted Discovery

REPORTDATADISCOVERY

Allow users to use Assisted Discovery in the report builder.

null

CRUD

Email Reports

REPORTEMAIL

Allows users to send an adhoc email copy of a report

null

CRUD

Report as a Datasource

REPORTFROMREPORT

Allows reports to be written aginst the results of another report.

null

CRUD

Versioned Reports

REPORTMI

Allows users to archive report result sets, dependent on Content Category Version History settings.

null

CRUD

Restrict Visible Roles

RESTRICTROLES

Restricts the Roles that are visible to a user when adding new users and groups.

null

CRUD

Hide Report Refresh

RPTREFRESH

Hides the Report Refresh menu item.

null

CRUD

Report Types

RUNTYPE

Allows users to create freehand SQL reports, and Jasper reports.

null

CRUD

Draft Public Reports

SEECORPDRAFT

Allows users to see draft versions of Public reports created by other users.

null

CRUD

Configure Support Email

SEMAIL

Allows users to set the support email address

null

CRUD

Skip Schema Check

SKIPSCHEMACHECK

Bypass schema check when using CheckSchemaForUser functionality.

null

CRUD

Source Filters

SOURCEFILTER

Allows users to create data source filters

null

CRUD

SSRS Reports

SSRS

Allows users to create SSRS Reports.

null

CRUD

Storyboard

STORYBOARD

Allows users to view, create, edit or delete Storyboards.

null

CRUD

Storyboard Admin

STORYBOARDADMIN

Allows users to edit and delete any private or public Storyboard.

null

CRUD

Storyboard Global Filters

STORYBOARDGLOBAL

Allows users to set global filters on Storyboards.

null

CRUD

Sub Queries

SUBQUERIES

Allows users to create Sub Queries on reports.

null

CRUD

System Information

SYSTEMINFO

Allows admin users to view System Information.

null

CRUD

System Task Admin

SYSTEMTASKADMIN

Allow users to approve or reject the completion of system tasks.

null

CRUD

Personal Tasks

TASKPERSONAL

Allow users to create and assign tasks to themselves.

null

CRUD

Public Tasks

TASKPUBLIC

Allow users to create and assign tasks to themselves and others.

null

CRUD

Personal Tasks

TASKS

Allow users to see and be assigned tasks.

null

CRUD

Themes

THEMES

Allows users to manage Storyboard Themes.

null

CRUD

Timeline

TIMELINE

Allows users to access their timeline.

null

CRUD

Connections

TIMELINECONNECTIONS

Allow users to connect to other users through their timeline and the community panel.

null

CRUD

User Profile

USERPROFILE

Allows users to view and update their User Profile.

null

CRUD

Min/Max default filter values

FILTERMINMAX

Allows users to set default values for cached filters to the minimum and maximum cached value.

null

CRUD

Force Clone Views

FORCECLONEVIEWS

Removes the option to edit existing views directly - users are forced to clone views to edit them.

null

CRUD

Geometry Pack Management

GEOPACKMANAGEMENT

Allows users to import and delete geometry packs.

null

CRUD

Disable Add Existing Tab

HIDEADDTODASHBOARD

Prevents users from adding existing tabs from the Browse Page or the Pre-Built Tab option to their dashboard.

null

CRUD

Hide Dashboard Maximise Report

HIDEDASHMAXIMISE

Hides the Maximise option on Dashboard reports.

null

CRUD

Hide Dashboard Report Menu

HIDEDASHRPTMENU

Hides the drop-down menu on reports on the Dashboard.

null

CRUD

Hide DBMS Messages

HIDEDBMSMSG

Replaces errors messages from DBMS with generic messages.

null

CRUD

Disable profile email change

HIDEEMAIL

Stops users from changing their email address in My Profile.

null

CRUD

Hide Embed Links

HIDEEMBEDLINKS

Removes links to embed reports and dashboards using the Javascript API.

null

CRUD

Hide External Links

HIDEEXTLINKS

Removes external direct links to reports and dashboards.

null

CRUD

Hide profile password

HIDEPASSWORD

Removes the password reset option in My Profile.

null

CRUD

Hide Print on Reports and Dashboards

HIDEPRINT

Hides the Print option on the Report and Dashboard pages.

null

CRUD

Hide Columns Option (Browse Page)

HIDERPTLISTCOLUMNS

Hides the Columns option on the Browse page. Users will not be able to change ths columns displayed.

null

CRUD

Hide Report Details (Browse Page)

HIDERPTLISTDETAILS

Hides the Report Details on the Browse page.

null

CRUD

Hide Open Report

HIDERPTMENUOPEN

Hides the Open Report menu item.

null

CRUD

Hide SQL

HIDESQL

Hides Report SQL from users. If this function is enabled, users with this role will not be able to view the Report SQL.

null

CRUD

Hide profile User ID

HIDEUSERID

Removes the User ID option in My Profile.

null

CRUD

Import

IMPORTVIEW

Allows users to import content from XML files.

null

CRUD

Instant Insight Settings

INSTANTINSIGHTSETTING

Allow users to modify Instant Insight settings at the view level.

null

CRUD

Instant Insight

INSTANTINSIGHTUSE

Allow users to use Instant Insight.

null

CRUD

Javascript Charts

JAVASCRIPTCHART

Allow users to write javascript charts through the chart builder. Warning: this should only be enabled for trusted developers as it will allow them to run custom javascript.

null

CRUD

Configure Logon ID

LOGONID

Allows users to specify how users are authenticated

null

CRUD

Filter Period Management

MANAGEFILTERPERIOD

Allows users to choose which Predefined Date Filters are available.

null

CRUD

Create and Edit Tags

MANAGETAG

Allows users to create and edit tags.

null

CRUD

View and Field Categories

VIEWCATEGORIES

Allows users to manage View and Field Categories from the Admin Console.

null

CRUD

Freehand SQL Views

VIEWRUNTYPE

Allows users to create Freehand SQL views.

null

CRUD

Web Services

WEBSERVICES

This function is required for a user account that will be used to access to Web Services

null

CRUD

Licence Management

YFLICENCE

Allows users to view Licence details and upload new Licence files

null

CRUD

Roles Management

YFROLES

Allows users to create and edit security roles

null

CRUD

Access Filter

ACCESSFILTER

Allows users to set or change the access filter on a report

null

CRUD

Group Management

ACCESSGROUP

Allows users to create and edit Groups

CP

CRUD

Folder Access

CONTENTACCESS

Allow users to configure content folders.

CP

CRUD

User Management

USERS

Allows users to create and delete other user accounts

DIR

CRUD

Favourites

FAVOURITES

Allows users to add reports to their favourites list

QL

CRUD

Hide Comments

HIDERPTMENUCOMMENTS

Hides the comment functionality from Reports, Storyboards, and Dashboards.

null

CRUD

Hide Report Details (Report Menu)

HIDERPTMENUDETAILS

Hides the Report Details item on the Report Menu.

null

CRUD

Hide Browse Page

REPORTSHIDDEN

Hides the Browse page.

null

CRUD

 


 

Expand
titleAdministrationReport

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

 

 

...