ReportSchedule
A timed export for a report — when to run, format and destination
TypeScript
export interface ReportSchedule extendsExtends
Properties
| Property | Type | Description |
|---|---|---|
| ExportDestination | ExportDestinationType | Destination of Report to run on Schedule |
| Name | string | Unique display name for this scheduled report |
| ReportFormat | ReportFormatType | Format of Report to run on Schedule |
| ReportName | ReportNameType | Name of Report to export |
| Schedule | Schedule | When the export should run |
| IsReadOnly | boolean | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
| IsSuspended | boolean | Suspends (i.e. turns off) an Adaptable Object |
Property Details
ExportDestination
Destination of Report to run on Schedule
TypeScript
ExportDestination?: ExportDestinationType;Property Value
Name
Unique display name for this scheduled report
TypeScript
Name: string;Property Value
string
ReportFormat
Format of Report to run on Schedule
TypeScript
ReportFormat: ReportFormatType;Property Value
ReportName
Name of Report to export
TypeScript
ReportName: ReportNameType;Property Value
Schedule
When the export should run
TypeScript
Schedule: Schedule;Property Value
IsSuspended
Inherited from SuspendableObject
Suspends (i.e. turns off) an Adaptable Object
TypeScript
IsSuspended?: boolean;Property Value
boolean
IsReadOnly
Inherited from AdaptableObject
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
TypeScript
IsReadOnly?: boolean;Property Value
boolean