Table of Contents

Class ReportGeneratingTask

Namespace
Lers.Administration
Assembly
Lers.System.dll

Задание формирования отчетов.

public sealed class ReportGeneratingTask : EditableRecord, IUniqueObject, INotifyPropertyChanged
Inheritance
ReportGeneratingTask
Implements
Inherited Members
Extension Methods

Fields

MaxMailMessageLength

Максимальная длина текста сообщения.

public const int MaxMailMessageLength = 500

Field Value

int

MaxMailSubjectLength

Максимальная длина темы сообщения.

public const int MaxMailSubjectLength = 78

Field Value

int

MaxTitleLength

Максимальная длина наименования задания.

public const int MaxTitleLength = 100

Field Value

int

Properties

Accounts

Возвращает коллекцию учетных записей, которым будет отправлен сформированный отчет.

public AccountCollection Accounts { get; }

Property Value

AccountCollection

AvailableInfo

Возвращает значение, определяющее какая дополнительная информация о задании была получена.

public ReportGeneratingTaskInfoFlags AvailableInfo { get; }

Property Value

ReportGeneratingTaskInfoFlags

BalanceGroupId

Идентификатор балансовой группы, для которой будет формироваться отчет.

public int? BalanceGroupId { get; set; }

Property Value

int?

DataType

Возвращает или задает тип данных, которые содержатся в отчете.

public DeviceDataType DataType { get; set; }

Property Value

DeviceDataType

Remarks

Поддерживаются следующие значения: Month, Day, Hour.

ExportOptions

Параметры экспорта отчетов в файл.

public string ExportOptions { get; set; }

Property Value

string

IsModified

Получает значение, определяющее, есть ли изменения, которые можно сохранить.

public override bool IsModified { get; }

Property Value

bool

MailMessage

Возвращает или задает текст рассылаемого сообщения.

public string MailMessage { get; set; }

Property Value

string

MailSubject

Возвращает или задает тему рассылаемого сообщения.

public string MailSubject { get; set; }

Property Value

string

MailingEnabled

Возвращает или задает значение, определяющее, нужно ли рассылать сформированный отчет выбранным получателям.

public bool MailingEnabled { get; set; }

Property Value

bool

MailingFileFormat

Возвращает или задает формат файла, в котором будут рассылаться отчеты.

public ReportExportFormat MailingFileFormat { get; set; }

Property Value

ReportExportFormat

MailingFileSplitMode

Возвращает или задает режим разбиения рассылаемых отчетов на файлы.

public ReportSplitMode MailingFileSplitMode { get; set; }

Property Value

ReportSplitMode

MailingList

Адреса для прямой рассылки сформированных отчетов.

public string[] MailingList { get; set; }

Property Value

string[]

MeasurePointSystems

Возвращает или задает инженерные системы, для точек учета которых, должен быть сформирован отчет.

public SystemType MeasurePointSystems { get; set; }

Property Value

SystemType

NodeGroups

Возвращает коллекцию групп объектов учета, для которых должен быть сформирован отчет.

public NodeGroupCollection NodeGroups { get; }

Property Value

NodeGroupCollection

Nodes

Возвращает коллекцию объектов учета, для которых должен быть сформирован отчет.

public NodeCollection Nodes { get; }

Property Value

NodeCollection

NotifyMessage

Возвращает или задает текст уведомления о том, что отчет не сформирован из-за отсутствия части данных.

public string NotifyMessage { get; set; }

Property Value

string

NotifyTrusteeId

Идентификатор учётной записи или группы, которой будет отправлено уведомление о том, что отчёт не сформирован.

public int? NotifyTrusteeId { get; set; }

Property Value

int?

OverwriteExistingFiles

Возвращает или задает значение, определяющее, нужно ли перезаписывать существующие файлы при экспорте отчетов.

public bool OverwriteExistingFiles { get; set; }

Property Value

bool

PackAttachments

Возвращает или задает значение, определяющее, нужно ли паковать вложения в один архив.

public bool PackAttachments { get; set; }

Property Value

bool

PeriodEndDayOrHour

Возвращает или задает номер дня или часа окончания периода отчета.

public int PeriodEndDayOrHour { get; set; }

Property Value

int

Remarks

Для ежемесячного отчета диапазон значений от 1 до 31. Если в месяце меньше дней, чем указано, то будет использоваться последний день месяца. Для ежедневного отчета диапазон 0 - 23.

PeriodEndMonthOrDay

Возвращает или задает месяц или день окончания периода отчета.

public TaskPeriodMonthDay PeriodEndMonthOrDay { get; set; }

Property Value

TaskPeriodMonthDay

PeriodLastDays

Возвращает количество последних дней, за которые надо формировать отчет.

public int PeriodLastDays { get; set; }

Property Value

int

Remarks

Отчет будет формировать за последние N дней относительно текущей даты за период от Today - N до Today включительно.

PeriodStartDayOrHour

Возвращает или задает номер дня или часа начала периода отчета.

public int PeriodStartDayOrHour { get; set; }

Property Value

int

Remarks

Для ежемесячного отчета диапазон значений от 1 до 31. Если в месяце меньше дней, чем указано, то будет использоваться последний день месяца. Для ежедневного отчета диапазон 0 - 23.

PeriodStartMonthOrDay

Возвращает или задает месяц или день начала периода отчета.

public TaskPeriodMonthDay PeriodStartMonthOrDay { get; set; }

Property Value

TaskPeriodMonthDay

PeriodType

Тип периода формирования отчета.

public TaskPeriod PeriodType { get; set; }

Property Value

TaskPeriod

RegisterTemplateId

Идентификатор отчетной формы для реестра сформированных отчетов по точкам учета.

public int? RegisterTemplateId { get; set; }

Property Value

int?

Report

Возвращает или задает отчет для формирования.

public Report Report { get; set; }

Property Value

Report

ReportSaveDirectory

Возвращает или задает значение, определяющее, нужно ли сохранять сформированный отчет в папку.

public string ReportSaveDirectory { get; set; }

Property Value

string

RequiresApproval

Возвращает или задает признак, который определяет необходимость проверки наличия подтверждения перед рассылкой отчетных документов.

public bool RequiresApproval { get; set; }

Property Value

bool

SaveReport

Возвращает или задает значение, определяющее, нужно ли сохранять сформированный отчет в базу данных.

public bool SaveReport { get; set; }

Property Value

bool

Schedule

Возвращает или задает расписание.

public Schedule Schedule { get; }

Property Value

Schedule

SkipOnMissingData

Не формировать отчёт если часть данных по точкам учёта не опрошены.

public bool SkipOnMissingData { get; set; }

Property Value

bool

Title

Возвращает или задает наименование.

public string Title { get; set; }

Property Value

string

UseNodeGroup

Возвращает или задает значение, определяющее, используются ли группы объектов учета.

public bool UseNodeGroup { get; }

Property Value

bool

Methods

RefreshAsync()

Обновляет свойства записи.

public Task RefreshAsync()

Returns

Task

RefreshAsync(ReportGeneratingTaskInfoFlags)

Обновляет свойства записи с указанием флагов.

public Task RefreshAsync(ReportGeneratingTaskInfoFlags flags)

Parameters

flags ReportGeneratingTaskInfoFlags

Определяет, какую дополнительную информацию необходимо получить.

Returns

Task

ToString()

Возвращает наименование.

public override string ToString()

Returns

string

Возвращает наименование в виде строки.