Administration Object Definitions

These objects are specific to the Administration web services:

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

Object parameters:

Parameter Name	Type	Description
sessionId	String
loginId	String	This refers to a Yellowfin account with the web services role enabled. Must be a Yellowfin default (primary) org user.
password	String	This refers to the password of the above account.
ntlm	Boolean
orgId	Integer	This should always be 1, which signifies the default org ID.
loginSessionId	String
orgRef	String
query	String
reportId	Integer
dashboardTabId	Integer
function	String	This refers to the type of the call.
person	AdministrationPerson
group	AdministrationGroup
report	AdministrationReport
client	AdministrationClientOrg
reportGroup	AdministrationReportGroup
favourite	PersonFavourite
contentResources	ContentResource[]
importOptions	ImportOption[]
role	AdministrationRole
retrospectiveDays	Integer
binaryData	byte[]
people	AdministrationPerson[]
datasource	AdministrationDataSource
sourceClientLink	AdministrationDataSourceClientLink
sourceId	Integer
schedule	AdministrationSchedule

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

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.

This object is returned by the web service.

Parameters of this object:

Parameter name	Type
ReportId	Integer
StatusCode	String
ErrorCode	Integer
Messages	String[]
SessionId	String
LoginSessionId	String
person	AdministrationPerson
people	AdministrationPerson[]
group	AdministrationGroup
groups	AdministrationGroup[]
roles	AdministrationRole[]
reports	AdministrationReport[]
reportGroups	AdministrationReportGroup[]
report	AdministrationReport
clients	AdministrationClientOrg[]
client	AdministrationClientOrg
personfavourites	PersonFavourite[]
binaryAttachments	ReportBinaryObject[]
contentResources	ContentResource[]
importIssues	ImportIssue[]
EntityId	Integer
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:

AdministrationServiceResponse ssr = doWebserviceCall(sr);

String statusCode = ssr.getStatusCode();

This object is used to define a Yellowfin user involved in a function.

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

These are the parameters for the AdministrationGroup object:

AdministrationGroup Element	Data Type	Description
GroupName	String	Name of a group.
GroupDescription	String	Description of a group.
GroupId	Integer	Unique ID to identify a group.
GroupStatus	String
GroupInternalReference	String
GroupMembers	AdministrationGroupMember[]	An array of AdministrationGroupMember objects. These objects hold group member metadata

Parameter Name	Data Type	Description
InternalId	Integer	This is the IpId field of Person table in the Yellowfin database.
LoginId	String	User ID of the group member (depending on the Logon ID method, this could be the email address or user ID).

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

All possible parameters for this object:

Parameter Name	Data Type	Description
FunctionName	String	Name of the function.
FunctionCode	String	Unique code for the function.
FunctionDescription	String	Function's description to define its purpose.
FunctionTypeCode	String
AccessLevelCode	String	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.

Function Name	Code	Desciption	Type Code	Access 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

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

AdministrationClientOrg Element	Data Type	Description
ClientName	String	Name of the client organization.
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 organization is the primary organization.
ClientId	Integer	IpId of a client.

AdministrationReportGroup Element	Data Type	Description
ReportGroupName	String
ReportGroupDescription	String
ReportGroupId	Integer
ReportGroupStatus	String
ReportGroupType	String	One of the following values: ANALYTIC KPI
ReportGroupInternalReference	String
GroupReports	AdministrationReport[]	An array contain details of the dashboard's reports.
AssociatedReports	Integer[]	An array of Associated Reports IDs.
PublishUUID	String	Dashboard UUID

ReportBinaryObject Element	Data Type	Description
Key	String	Unique key used for Binary Object storage
ContentType	String	MIME type for the Binary Object
Data	Byte[]	Raw data for Binary Object

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

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.

OptionKey

OptionValue

Task

SKIP

True

False

Skip an item in the import file.

OPTION

ADD

Import an item from the import file.

OPTION

REPLACE

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

Note: this requires an existing record to be replaced.

EXISTING

Content UUID

This 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 System	Database Code
Generic ODBC Source	GENERICODBC
Microsoft Access	MSACCESS
DB2 AS400	AS400
Cache DB	CACHEDB
Columnar DB	COLUMNAR
DB2	DB2
Connection Cloud	CONNECTIONCLOUD
Derby	DERBY
DIAPRISM	DIAPRISM
FileMaker Pro	FILEMAKER
Firebird	FIREBIRD
FoxPro	FOXPROODBC
H2	H2
Hive	HIVE
HSQLDB	HSQLDB
Informix	INFORMIX
Ingres	INGRES
Vectorwise	VECTORWISE
Interbase	INTERBASE
Lucid	LUCIDDB
MonetDB	MONETDB
MySQL	MYSQL
Netezza	NETEZZA
Lotus Notes	NOTES
NouDB	NOUDB
Progress OpenEdge	OPENEDGE
Oracle	ORACLE
Pervasive	PERVASIVE
PostgresSQL	POSTGRESQL
Progress	PROGRESS
SAP HANA	SAPHANA
SAS	SASJDBC
SqLite	SQLITE
Microsoft SQL Server	MSSQLSERVER
Sybase ASA / Sybase SQL Anywhere	SYBASEASA
Sybase ASE	SYBASEASE
Sybase IQ	SYBASEIQ
TeraData	TERADATA
Universe	UNIVERSE
Vertica	VERTICA

Override the details of a data source type during import.

DRIVER

JDBC Driver classname

Override the details of a data source host during import.

URL

A JDBC URL

Override the details of a data source URL during import.

DATASOURCE

XMLA Data Source

Override the details of an XMLA data source during import.

CATALOG

XMLA Catalog

Override the details of an XMLA data source catalog during import.

USERNAME

Source Username

Override the details of a data source username during import.

PASSWORD1

Source Password

Override the details of a data source password during import.

Note: this requires PASSWORD2 to be set as well.

PASSWORD2

Password Validation

Override the details of a data source password during import.

SOURCE

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

CACHESOURCE

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

CATEGORY

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

SUBCATEGORY

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

Parameter	Data Type
itemKey	String
resource	ContentResource
issueElements	InportIssueElement[]

Parameter	Data Type
imessageKey	String
messageComponents	String[]
renderedMessage	String

Parameter	Data Type	Description
reportGroupId	Integer	Dashboard tab ID
reportGroupUUID	String	Dashboard tab published UUID
displayOrder	Integer	Display order of a dashboard tab in a user dashboard.
reportGroup	AdministrationReportGroup	Dashboard tab
reportGroupSubTabs	AdministrationReportGroup[]	Sub tabs with a dashboard.

Parameter	Data Type	Description
dashboardName	String	Name of the dashboard.
dashboardGroupId	Integer
tabIds	String[]	An array of the sub tabs' IDs.
tabNames	String[]	An array of the sub tabs' names.
statusCodes	String[]	An array of the sub tabs status.

Parameter	Data Type	Description
PersonId	Integer	User IpId (Yellowfin database, Person.IpPerson)
ContentType	String	This optional parameter can be set to filter the result by a specific content type. Values could include: REPORT REPORTGROUP DISCUSSIONGROUP REPORTVIEW STORYBOARD IMAGE
ContentId	Integer	This optional parameter can be used to restrict the result to a specific content by providing its internal ID.
FavouriteType	String
CreationCode	String
CreatorId	Integer	This refers to the distributor of the content, who distributes the content to a user. This is used with the CreationCode set to “DISTRIBUTE”.
TextEntityId	Integer
InstanceId	Integer
CreationDate	Date
Subject	String
Message	String
WidthCode	String

Below are some possible combinations of ContentType, FavouriteType and CreationCode:

ContentType	FavouriteType	CreationCode	Description
REPORT	FAVOURITE	MANUAL	Favorite reports.
REPORTGROUP	REPORTDASHBOARD		All user dashboard tabs that a user can see on a dashboard.
REPORTGROUP	INBOX	DISTRIBUTE	Dashboards distributed to the user.
DISCUSSIONGROUP	DISCUSSIONMEMBER		Discussions which a user is a member of.
REPORTVIEW		MANUAL	Favourite views.
STORYBOARD	FAVOURITE	WEB	Favourite storyboards.
IMAGE	PROFILE	MANUAL	User's profile image.
COMMENT	FLAGGED	MANUAL	Flagged by user comments.

Request Element	Data Type	Description
AccessLevelCode	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, MySQL, Oracle, etc.
Timezone	String
UserName	String	Username for the data source account.
UserPassword	String	Password of the above account. The password will be encrypted automatically when saving the data source.

Parameter	Type
OptionKey	String
OptionValue	String
ValueDataType	String

Parameter	Type
clientOrgId	Integer
clientOrgRef	String
sourceId	Integer

Abstract class for Administration Service representation of a Yellowfin scheduled task. This class provides common functionality/data for all task schedules. Subclasses add more info for subclass-specific data, such as broadcast info, etc.

Parameter	Data Type	Description
Frequency	ScheduleFrequency[]	An array object containing details of the schedule frequency type.
ScheduleActive	String	Returns whether or not the schedule is active. This does not indicate whether or not the schedule is currently running, but whether or not the schedule will be run when its next schedule time occurs
ScheduleDescription	String	Short description of the schedule’s purpose. This will usually contain the name of the item that the schedule is for, such as report name, filter name, etc.
ScheduleUUID	String	The UUID of the schedule generated by the system.
ScheduleTypeCode	String	The schedule type of this record. ie. REPORTBROADCAST, SOURCEFILTERREFRESH, etc.
LastRunStatus	String	The status code of the last run of the schedule. This value is only updated after a schedule has completed, so it will contain the previous value if the schedule is currently running
LastRunError	String	If the last run ended in failure, then this field may contain an error which describes what happened
LastRunDateTimeGMT	String	The GMT DateTime of the last run of the schedule. Note that this is the time that the schedule was initiated.
NextRunDateTimeGMT	String	Based on the current schedule settings, this returns the next time that this schedule will run, in GMT. Note that this value is not ‘live’, meaning it will not update until the server has received and validated the changes and returned a new schedule object.

Following are some of the sub classes of the AdministrationSchedule class:

AdministrationSchedule Sub Class	Description	Fields
CompositeViewRefreshSchedule	Schedule which represents the refresh task for a composite view.	This class contains the following fields: ViewId: Returns the database ID of the composite view.
FilterGroupCacheRefreshSchedule	Refresh task for a cached filter or filter group.	This class contains the following fields: ViewId: Returns the database ID of the composite view. FilterGroupId: Returns the database ID of the filter group.
RefCodeRefreshSchedule	Refresh task for a custom reference code.	This class contains the following fields: SourceId: Returns the database ID of the source which the reference code is being refreshed from.
ReportBroadcastSchedule	Broadcast task for a report. Includes info about the broadcast report and recipients.	This class contains the following fields: ReportId: Returns the ID of the report which is being broadcast. Recipients: Returns an array of IDs for each recipient of the broadcast. Each entry can be a group or person ID. Subject: Returns the subject line of the broadcast. Some broadcast types do not use this field. AppendDate: Some broadcast types have the option of appending the broadcast date to the subject or filename, notedly FTP and EMAIL types. BodyText: Returns the email body text for EMAIL broadcasts. Format: Returns the broadcast output format code. HTML, PDF, etc. ConditionList: Returns an array of Condition objects which represent complex broadcast conditions. FailureNotificationGroup: Returns the ID of the group which will be notified when a broadcast fails. BroadcastStartDate: Returns the date that the broadcast schedule is set to begin. BroadcastEndDate: Returns the date that the broadcast schedule is set to end.
ReportFilterCacheRefreshSchedule	Refresh task for a report cached filter.	This class contains the following fields: ReportId: Returns the ID of the report which this cached filter is from.
ReportRefreshSchedule	Refresh task for a report which does not get auto-run on load.	This class contains the following fields: ReportId: Returns the ID of the scheduled report.
SourceFilterRefreshSchedule	Refresh task for a source filter. Updating source filter values based on query from source.	This class contains the following fields: SourceId: This may be either a data source ID or a report ID, depending on the source type. SourceType: SOURCE or REPORT, specifies the type of object which SourceId points to.
SourceFilterUpdateReminderSchedule	Reminder task for updating source filter values. Sends a reminder to specified people on a schedule.	This class contains the following fields: SourceId: Database ID of the data source which the source filter should be refreshed from.
ThirdPartySourceAutoRunSchedule	Auto-run task for third-party data sources.	This class contains the following fields: SourceId: Database ID of the third-party data source.

Base class for all frequency types. This class holds the database attributes for a frequency schedule. It is the responsibility of each subclass to provide user-friendly methods to set and get useful data based on the database value of each field.

E.g. Day of month is sometimes stored in frequency unit, and sometimes not, if the schedule type has day of month at all. The subclass will also enforce validation.

Parameter	Data Type	Description
FrequencyTypeCode	String	The frequency type of this object. Used to determine the object type.
FrequencyCode	String	Has different meanings depending on the frequency type code.
FrequencyUnit	Integer	Has different meanings depending on the frequency type code
LocalRunTime	Integer	Returns the seconds from midnight that this schedule will run (relative to this schedule's timezone). Note: Some schedule types do not use this property, notably MinutesFrequency.
LocalTimezoneCode	String	The full time zone code (ie. AUSTRALIA/SYDNEY, etc.) that will be used to translate the specified local run time into the Yellowfin server's time.
DayOrdinals	String	Ordered list of day names which correspond to their ordinal values.

Following are some of the sub classes of the ScheduleFrequency class:

ScheduleFrequency Sub Class	Description	Fields
AnnualFrequency	At a set time on a specific day of a specific month of the year.	This class contains the following fields: FrequencyCode: This frequency code should be the UPPERCASE English name of the month of the year that this schedule will run. eg JANUARY. FrequencyUnit: Specifies the day of the month that this schedule will run.
BiannualFrequency	At a set time on a specific day of two months spaced equally apart within the year. X month and (6 + X) month, with X being the 'MonthOfYear' property.	This class contains the following fields: FrequencyCode: This frequency code should be the UPPERCASE English number-word for the first month of the year that this will run, eg. if the schedule should run January and July, value would be “ONE” (first month of the year, then plus 6 months). Highest value allowed is SIX. FrequencyUnit: Specifies the day of the month that this schedule will run.
DailyFrequency	At a set time every day. This class has no extra fields, as only localRunTime is necessary.
EndOfMonthFrequency	At a set time on the last day of every month. This class has no extra fields, as only localRunTime is necessary.
FortnightlyFrequency	At a set time on a specific day of the week, once every fortnight.	This class contains the following fields: FrequencyCode: This frequency code should be the UPPERCASE English name of the day on which this schedule should run. E.g: “MONDAY”. FrequencyUnit: Specifies the ordinal value of the day that is used above in frequencyCode. Note that the ordinal value must match the dayOrdinals constants provided. i.e. MONDAY=1, SUNDAY=0, etc.
MinutesFrequency	Every X minutes.	This class contains the following fields: FrequencyUnit: How many minutes between schedule runs.
MonthlyFrequency	At a set time on a specific day of each month.	This class contains the following fields: FrequencyUnit: Day of the month that this schedule will run.
QuarterlyFrequency	At a set time on a specific day of either the first, second, or third month in each quarter.	This class contains the following fields: FrequencyCode: This frequency code should be the UPPERCASE English number-word for the month of each quarter that this schedule will run, eg. if the schedule should run in the first month of each quarter, value would be “ONE”, so the schedule will run January, April, July & October. Highest value allowed is THREE. FrequencyUnit: Specifies the day of the month that this schedule will run.
WeekdaysFrequency	At a set time every weekday. This class has no extra fields, as only localRunTime is necessary.
WeeklyFrequency	At a set time on a specific day of the week.	This class contains the following fields: FrequencyCode: This frequency code should be the UPPERCASE English name of the day of the week that this schedule will run, eg. “MONDAY”. FrequencyUnit: Specifies the ordinal value of the day that is used above in frequencyCode. Note that the ordinal value must match the dayOrdinals constants provided. ie. MONDAY=1, SUNDAY=0, etc.

Content

Space Tools

Administration Object Definitions