Глобальные обработчики событий

Обработчик событий передает параметры экспресс-отчёта, с которыми производилось вычисление, и позволяет выполнять заданное с помощью кода действие при каждом возникновении события.

Для настройки обработки событий экспресс-отчёта:

1. Установите флажки «Глобальный обработчик вычисления отчётов» и «Экспресс-отчёты».

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

3. Выберите класс, содержащий обработчики событий. В раскрывающемся списке «Класс» будут отображены все классы выбранной сборки, модуля или формы.

Для экспресс-отчётов можно настроить обработку событий, наступающих при работе с отчётом:

• OnBeforeExecuteAnalyzer - реализует событие, наступающее перед вычислением таблицы;

• OnAfterExecuteAnalyzer - реализует событие, наступающее после вычисления таблицы;

• OnBeforeExportAnalyzer - реализует событие, наступающее перед экспортом отчёта;

• OnAfterExportAnalyzer - реализует событие, наступающее после экспорта отчёта;

• OnBeforePrintAnalyzer - реализует событие, наступающее перед печатью отчёта;

• OnAfterPrintAnalyzer - реализует событие, наступающее после печати отчёта.

Для выполнения примера создайте модуль и подключите его как обработчик событий для экспресс-отчётов. В модуле подключите системные сборки: Dimensions, Export, Express, Forms, Metabase. Добавьте обработчики событий:

Public Class EventsClass: ExpressEvents
    param_comment: string;

    Public Sub OnAfterExecuteAnalyzer(Args: IEaxAfterExecuteEventArgs);
    Var DSSet: IDimSelectionSet;
    Begin
        DSSet := args.AnalyzerData.SheetData.Selection;
        // получение строки-списка отмеченных элементов в измерениях экспресс-отчёта
        param_comment := GetEaXReportParams(DSSet);
        // добавление записи в протокол доступа с требуемым комментарием
        args.AnalyzerData.Descriptor.CheckAndAudit(2, "Выполнение отчета." + param_comment);
    End Sub OnAfterExecuteAnalyzer;

    Public Sub OnAfterPrintAnalyzer(Args: IEaxAfterPrintEventArgs);
    Var DSSet: IDimSelectionSet;
    Begin
        DSSet := args.AnalyzerData.SheetData.Selection;
        param_comment := GetEaXReportParams(DSSet);
        Debug.WriteLine(param_comment);
    End Sub OnAfterPrintAnalyzer;

    Public Sub OnAfterExportAnalyzer(Args: IEaxAfterExportEventArgs);
    Var DSSet: IDimSelectionSet;
    Begin
        DSSet := args.AnalyzerData.SheetData.Selection;
        param_comment := GetEaXReportParams(DSSet);
        Debug.WriteLine(param_comment);
    End Sub OnAfterExportAnalyzer;
End Class EventsClass;

// получение строки-списка отмеченных элементов в измерениях экспресс-отчёта
Public Function GetEaXReportParams(ExArDsset: IDimSelectionSet): string;
Var ControlStr: string;
    i, DimCnt: integer;
    DimName: string;
    selection: idimselection;
Begin
    dimCnt := ExArDsset.Count;
    ControlStr := "Параметры отчета: ";
    For i := 0 To dimCnt - 1 Do
        DimName := ExArDsset.Item(i).Dimension.Name;
        ControlStr := ControlStr + DimName + ": ";
        selection := ExArDsset.Item(i);
        If selection.SelectedCount = 0 Then
            ControlStr := ControlStr + ": <не выбрано>. ";
            Else
            ControlStr := ControlStr + ": " + Selection.ToString;
        End If;
    End For;
    Return ControlStr;
End Function GetEaXReportParams;

После выполнения примера, при наступлении события обновления таблицы, в протокол доступа будет занесена информация о выделенных измерениях. При печати и экспорте информация будет выведена в консоль разработчика. Пример строки:

Примечание: Выполнение отчета. Параметры отчета: Факты: : ФактСтраны: : Албания,Бельгия,Босния и Герцеговина,Хорватия,Кипр,Чешская Республика,Гренландия,Венгрия,Италия,Латвия Показатели: : Прирост ВВП (% в год)Календарь: : 2005,2006,2007,2008,2009,2010

Обработчик событий для работы с обновлениями формирует информацию о процессе установки обновлений:

• дата и время;

• имя пользователя;

• имя рабочей станции;

• имя обновления;

• перечень объектов и их версии (прежняя и новая);

• сообщения об обновлении каждого объекта;

• статус обновления.

Для настройки обработки событий работы с обновлениями:

1. Установите флажки «Глобальный обработчик событий работы с обновлениями».

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

3. Выберите класс, содержащий обработчики событий. В раскрывающемся списке «Класс» будут отображены все классы выбранной сборки, модуля или формы.

Примечание. Класс должен наследовать класс UpdateCallBack и содержать метод, имеющий следующую сигнатуру:
Function OnCallBack(<param1>: MetabaseUpdateCallbackReason; <param1>: IMetabaseUpdate) : Boolean.

Пример обработчика событий работы с обновлениями. В модуле подключите системную сборку Metabase. Добавьте обработчик событий:

Public Class UpdateHandlerClass: UpdateCallBack
    Function OnCallback(Reason: MetabaseUpdateCallbackReason; Update: IMetabaseUpdate): Boolean;
    Begin
        //Проверка режимов применения обновления
        Select Case Reason
            Case MetabaseUpdateCallbackReason.ApplyCoreEnd: //действия при окончании применения обновления из ядра
            Case MetabaseUpdateCallbackReason.ApplyCoreStart: //действия при вызове применения обновления из ядра
            Case MetabaseUpdateCallbackReason.ApplyUI: //действия при вызове применения обновления из интерфейса
            Case MetabaseUpdateCallbackReason.SaveUI: //действия при вызове сохранения обновления из интерфейса
            Case MetabaseUpdateCallbackReason.SaveCore: //действия при вызове сохранения обновления из ядра
            Case MetabaseUpdateCallbackReason.LoadCoreEnd: //действия при окончании чтения обновления из ядра
        End Select;
        return False; //без прерывания системного действия
    End Function OnCallback;
End Class UpdateHandlerClass;

Результат выполнения примера будет зависеть от заданных действий перечисления MetabaseUpdateCallbackReason.

Для установки параметров обработки ошибок, возникающих в системах, которые разработаны с помощью «Форсайт. Аналитическая платформа», используйте вкладку «Обработка ошибок» в разделе «Обратная связь» диалога «Параметры».

Для открытия диалога «Параметры»

Укажите следующие параметры:

• Отправлять сообщения об ошибках на Email. Укажите адрес электронной почты, на который будут отправляться сообщения о возникших ошибках. Для отправки сообщений электронной почты будет использоваться программа, установленная в операционной системе в качестве почтового клиента по умолчанию;

• Обработчик ошибок. Установите один из доступных переключателей:

• По умолчанию. При работе в «Форсайт. Аналитическая платформа» будет использоваться встроенный механизм обработки ошибок: при возникновении ошибки будет отображено соответствующее окно с информацией об ошибке и возможностью отправить её по указанному в настройках адресу;

• Установить собственный обработчик ошибок. Возникающие ошибки «Форсайт. Аналитическая платформа» можно обработать в функции со следующей сигнатурой:
  Function <наименование функции>(<наименование параметра>: IException): Boolean

Выберите сборку, модуль или форму, в которой содержатся функции с подходящей сигнатурой, из соответствующего раскрывающегося списка. Перечень функций выбранного модуля, формы или сборки, удовлетворяющих этой сигнатуре, будет отображён в раскрывающемся списке «Функции».

Примечание. Собственный обработчик ошибок позволяет обработать только те ошибки, которые возникли в прикладном коде. Ошибки, которые могут возникнуть в ядре «Форсайт. Аналитическая платформа», будут выводиться в соответствующем окне.