Page History

Versions Compared

Old Version 16

changes.mady.by.user user-3484a

Saved on 28 Feb, 2018

compared with

New Version Current

changes.mady.by.user user-3484a

Saved on 02 Jul, 2018

Key

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

These objects are Following are the object specific to the Administration web services:

...

Expand

title	AdministrationReportGroup

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

Anchor

	reportBinaryObject
	reportBinaryObject

Expand

title	ReportBinaryObject

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

Anchor

	contentResource
	contentResource

Expand

title	ContentResource

ContentResource Element	Data Type	Description
ResourceName	String
ResourceDescription	String
ResourceId	Integer
ResourceUUID	Integer
ResourceType	String
ResourceOrgId	Integer
ResourceCode	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

title	ImportOption

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

Expand

title	Codes...

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.

Anchor

	parentReportGroupimportIssueparentReportGroup
	importIssue

Expand

title	ParentReportGroupImportIssue

DescriptionreportGroupId

Parameter	Data Type
itemKey	String
resource	ContentResource	Integer	Dashboard tab ID
issueElements	InportIssueElement[]

Anchor

	importIssueElement
	importIssueElement

Expand

title	ImportIssueElement

Parameter	Data Type
imessageKey	String
messageComponents	String[]
renderedMessage	String

Anchor

	parentReportGroup
	parentReportGroup

Expand

title	ParentReportGroup

Parameter	Data Type	Description
reportGroupId	Integer	Dashboard tab ID
reportGroupUUID	String	Dashboard tab published UUID
displayOrder	Integer	Display order of a
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.

Anchor

	parentDashboard
	parentDashboard

Expand

title	ParentDashboard

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.

Anchor

	personFavourite
	personFavourite

Expand

title	PersonFavourite

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.

Anchor

	AdminDataSource
	AdminDataSource

Expand

title	AdministrationDataSource

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.

Anchor

	AdminDataSourceOption
	AdminDataSourceOption

Expand

title	AdministrationDataSourceOption

Parameter	Type
OptionKey	String
OptionValue	String
ValueDataType	String

Anchor

	adminDataSournceClientLink
	adminDataSournceClientLink

Expand

title	AdministrationDataSourceClientLink

Parameter	Type
clientOrgId	Integer
clientOrgRef	String
sourceId	Integer

Anchor

	adminSchedule
	adminSchedule

Expand

title	AdministrationSchedule

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.

Anchor

	scheduleFrequency
	scheduleFrequency

Expand

title	ScheduleFrequency

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

Page History

Versions Compared

Old Version 16

New Version Current

Key