Kaizen
Browse modulesInsightsinsights/schedulingInterfaces

Interface: CreateDashboardScheduleInput

Defined in: server/insights/scheduling/report-schedule-service.ts:90

Extends

Properties

config

config: 
  | {
  cadence: "daily";
  format: "pdf" | "csv" | "xlsx";
  recipients: string[];
  timeOfDay: string;
  timezone: string;
}
  | {
  cadence: "weekly";
  format: "pdf" | "csv" | "xlsx";
  recipients: string[];
  timeOfDay: string;
  timezone: string;
  weekdays: number[];
}
  | {
  cadence: "monthly";
  dayOfMonth: number | "last";
  format: "pdf" | "csv" | "xlsx";
  recipients: string[];
  timeOfDay: string;
  timezone: string;
}
  | {
  cadence: "custom";
  cron: string;
  format: "pdf" | "csv" | "xlsx";
  recipients: string[];
  timezone: string;
};

Defined in: shared/insights/dashboard-schedule.ts:25

Union Members

Type Literal
{
  cadence: "daily";
  format: "pdf" | "csv" | "xlsx";
  recipients: string[];
  timeOfDay: string;
  timezone: string;
}

Type Literal
{
  cadence: "weekly";
  format: "pdf" | "csv" | "xlsx";
  recipients: string[];
  timeOfDay: string;
  timezone: string;
  weekdays: number[];
}
cadence
cadence: "weekly";
format
format: "pdf" | "csv" | "xlsx" = reportDeliveryFormatSchema;
recipients
recipients: string[] = reportRecipientsSchema;
timeOfDay
timeOfDay: string = timeOfDaySchema;
timezone
timezone: string = timezoneSchema;
weekdays
weekdays: number[];

One or more weekdays; de-duplicated so [1,1] cannot double-fire.


Type Literal
{
  cadence: "monthly";
  dayOfMonth: number | "last";
  format: "pdf" | "csv" | "xlsx";
  recipients: string[];
  timeOfDay: string;
  timezone: string;
}

Type Literal
{
  cadence: "custom";
  cron: string;
  format: "pdf" | "csv" | "xlsx";
  recipients: string[];
  timezone: string;
}

Inherited from

DashboardScheduleDetails.config

dashboardKey

dashboardKey: string = dashboardKeySchema;

Defined in: shared/insights/dashboard-schedule.ts:24

Inherited from

DashboardScheduleDetails.dashboardKey

enabled?

optional enabled?: boolean;

Defined in: server/insights/scheduling/report-schedule-service.ts:91


name

name: string | null = reportScheduleNameSchema;

Defined in: shared/insights/schedule.ts:228

Inherited from

DashboardScheduleDetails.name

view

view: {
  bucket?: "year" | "month" | "day" | "week" | "quarter";
  filters: Record<string, 
     | {
     from: string;
     kind: "date-range";
     to: string | null;
   }
     | {
     kind: "select";
     values: string[];
   }
     | {
     kind: "measure";
     operator: "gt" | "lt" | "gte" | "lte" | "eq";
     value: number;
   }
     | {
     kind: "search";
     text: string;
   }
    | undefined>;
  range?: {
     from: string;
     to: string;
  };
} = dashboardViewSnapshotSchema;

Defined in: shared/insights/dashboard-schedule.ts:32

bucket?

optional bucket?: "year" | "month" | "day" | "week" | "quarter";

filters

filters: Record<string, 
  | {
  from: string;
  kind: "date-range";
  to: string | null;
}
  | {
  kind: "select";
  values: string[];
}
  | {
  kind: "measure";
  operator: "gt" | "lt" | "gte" | "lte" | "eq";
  value: number;
}
  | {
  kind: "search";
  text: string;
}
| undefined>;

range?

optional range?: {
  from: string;
  to: string;
};
range.from
from: string;
range.to
to: string;

Inherited from

DashboardScheduleDetails.view

On this page