---
title: "Administration Object Definitions"
canonical: "https://wiki.yellowfinbi.com/space/yfcurrent/2209668/Administration%20Object%20Definitions"
format: markdown
---
These objects are specific to the Administration web services:

> Macro (anchor)



<details>
<summary>AdministrationServiceRequest</summary>

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:

```java
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.


---
</details>

> Macro (anchor)



<details>
<summary>AdministrationServiceResponse</summary>

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:

```java
AdministrationServiceResponse ssr = doWebserviceCall(sr);

String statusCode = ssr.getStatusCode();
```



---
</details>

> Macro (anchor)



<details>
<summary>AdministrationPerson</summary>

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:<br>- 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<br>- ACTIVE
- INACTIVE
- INACTIVEWITHEMAIL |
</details>

> Macro (anchor)



<details>
<summary>AdministrationGroup</summary>

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 |


---
</details>

> Macro (anchor)



<details>
<summary>AdministrationGroupMember</summary>

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


---
</details>

> Macro (anchor)



<details>
<summary>AdministrationRole</summary>

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


---
</details>

> Macro (anchor)



<details>
<summary>AdministrationFunction</summary>

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.



---
</details>

> Macro (anchor)



<details>
<summary>AdministrationReport</summary>

| **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 |
</details>

> Macro (anchor)



<details>
<summary>AdministrationClientOrg</summary>

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


---
</details>

> Macro (anchor)



<details>
<summary>AdministrationReportGroup</summary>

| **AdministrationReportGroup Element** | **Data Type** | **Description** |
| --- | --- | --- |
| ReportGroupName | String |  |
| ReportGroupDescription | String |  |
| ReportGroupId | Integer |  |
| ReportGroupStatus | String |  |
| ReportGroupType | String | One of the following values:<br>- 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 |


---
</details>

> Macro (anchor)



<details>
<summary>ReportBinaryObject</summary>

| **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 |
</details>

> Macro (anchor)



<details>
<summary>ContentResource</summary>

| **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:<br>- 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.) |
| ChangeDate | Date | The date and time the object was last updated. |
</details>

> Macro (anchor)



<details>
<summary>ImportOption</summary>

| **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<br>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.<br><span style="color: #cc0000">Note:</span> 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 |  | 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.<br><span style="color: #cc0000">Note:</span> 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<br>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 | Category Code | Assign a Sub Category code to a parent Category during import. |
| SOURCE | SOURCE<SourceId> | Assign a report to a source during import. An example of the value might be SOURCE39003 for a source with Id 39003. |
| VIEW | VIEW<ViewId> | Assign a report to a view during import. An example of the value might be VIEW39003 for a view with Id 39003. |
| EXECUTIONOBJECTNAME | Name | Assign a web service exection object name during import. Provide a name that uniquely identifies this report via web services. |
| CATEGORY | CAT<CategoryCode> | Assign a report to an existing report category during import. An example of the value might be CATTUTORIAL for a category with a code of TUTORIAL. |
| SUBCATEGORY | CAT<CategoryCode> | Assign a report to an existing report sub category, that's a child of the category specified above, during import. An example of the value might be CATTUTORIAL for a category with a code of TUTORIAL. |
| 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. |

Note that s<span style="color: #172b4d">ource parameters can be passed with import of a datasource, and are prefixed with SOURCEPARAMETER_.</span>  
<span style="color: #172b4d">Source Parameters are all the options that are shown on the connection wizard in Yellowfin, and they differ for every source.</span>

Below is a list of the Source Parameter options for some commonly used datasources:

**PostgreSQL:**

`HOSTNAME`  
`PORT`  
`DATABASE`  
`ADDITIONALPARAMETERS`

  
**MySQL:**

`HOSTNAME`  
`PORT`  
`DATABASE`  
`ADDITIONALPARAMETERS`  
`USEFETCHSIZE (TRUE/FALSE)`  
`FETCHSIZE (Integer)`  


**MS SQL Server:**

`HOSTNAME`  
`PORT`  
`DATABASE`  
`ADDITIONALPARAMETERS`  
`USEFETCHSIZE (TRUE/FALSE)`  
`FETCHSIZE (Integer)`  
`WINDOWSAUTH (WINDOWS/SQL)`  
`DOMAIN (Windows Auth Domain)`  
`USENAMEDINSTANCE (TRUE/FALSE)`  
`NAMEDINSTANCE (Instance Name)`  
`SSLOPTION (ENABLED/DISABLED)`  
`DRIVER (net.sourceforge.jtds.jdbc.Driver/com.microsoft.jdbc.sqlserver.SQLServerDriver/com.microsoft.sqlserver.jdbc.SQLServerDriver)`  


**Oracle:**

MODE (SID/SERVICE/TSNAMES)  
HOSTNAME  
PORT  
ADDITIONALPARAMETERS  
SID (Sid)  
SERVICE (Service)  
TSNAMES (TSNames)  
USEFETCHSIZE (TRUE/FALSE)  
FETCHSIZE (Integer)

For other sources not listed above, the Source Parameter Options can be extracted from an export file. To do this, follow these steps:

Step 1:  
Export a source from Yellowfin of the type you'd like to find the Source Parameters for. This will generate a YFX file.

Step 2:  
Unzip the YFX file. You may have to rename it as a ZIP file if your operating system doesn't recognise it as an archive.

Step 3:  
Unzipping the file will extract a YFExport.xml file. Open this file in a text editor.

Step 4:  
Search for <sourceParameter> in the xml file. Each <sourceParameter> node in the xml file will contain parameterKey, and this is the key that can be used during import. The parameterValue will display the value for that Source Parameter for the export. This is the value that can be changed via the ImportOption during import.
</details>

> Macro (anchor)



<details>
<summary>ImportIssue</summary>

| **Parameter** | **Data Type** |
| --- | --- |
| itemKey | String |
| resource | ContentResource |
| issueElements | InportIssueElement[] |
</details>

> Macro (anchor)



<details>
<summary>ImportIssueElement</summary>

| **Parameter** | **Data Type** |
| --- | --- |
| imessageKey | String |
| messageComponents | String[] |
| renderedMessage | String |
</details>

> Macro (anchor)



<details>
<summary>ParentReportGroup</summary>

| **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](#AdministrationObjectDefinitions-adminReportGroup) | Dashboard tab |
| reportGroupSubTabs | [AdministrationReportGroup](#AdministrationObjectDefinitions-adminReportGroup)[] | Sub tabs with a dashboard. |
</details>

> Macro (anchor)



<details>
<summary>ParentDashboard</summary>

| **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. |
</details>

> Macro (anchor)



<details>
<summary>PersonFavourite</summary>

| **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:<br>- 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. |
</details>

> Macro (anchor)



<details>
<summary>AdministrationDataSource</summary>

| **Request Element** | **Data Type** | **Description** |
| --- | --- | --- |
| AccessLevelCode | String | To specify the permission/access level of this database. |
| ClientSources | [AdministrationDataSourceClientLink](#AdministrationObjectDefinitions-adminDataSournceClientLink) |  |
| 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](#AdministrationObjectDefinitions-AdminDataSourceOption) |  |
| 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. |



---
</details>

> Macro (anchor)



<details>
<summary>AdministrationDataSourceOption</summary>

| **Parameter** | **Type** |
| --- | --- |
| OptionKey | String |
| OptionValue | String |
| ValueDataType | String |


---
</details>

> Macro (anchor)



<details>
<summary>AdministrationDataSourceClientLink</summary>

| **Parameter** | **Type** |
| --- | --- |
| clientOrgId | Integer |
| clientOrgRef | String |
| sourceId | Integer |


---
</details>

> Macro (anchor)



<details>
<summary>AdministrationSchedule</summary>

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](#AdministrationObjectDefinitions-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:<br>- **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:<br>- **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:<br>- **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:<br>- **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:<br>- **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:<br>- **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:<br>- **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:<br>- **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:<br>- **SourceId:** Database ID of the third-party data source. |


---
</details>

> Macro (anchor)



<details>
<summary>ScheduleFrequency</summary>

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:<br>- **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:<br>- **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:<br>- **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:<br>- **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:<br>- **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:<br>- **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:<br>- **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. |


---
</details>