Свойства элемента проекта вида «СобытиеЖурналаСобытий»

В проекте событие журнала событий имеет следующие свойства:

Важность

Перечисление. Важность события. Отображается на одноименное свойство во встроенном языке. Если не задано в описании проекта, задается в конструкторе. Может принимать значения:

• Максимальная — самый высокий уровень значимости. Такое событие:
  • требует скорейшей реакции;
  • оказывает существенное влияние на работу приложения;
  • необходимо для анализа журнала (содержит критичные сведения).
• Высокая — отражение в журнале существенных событий. Такое событие:
  • не требует немедленной реакции;
  • оказывает существенное влияние на работу приложения;
  • необходимо для анализа журнала (содержит важные сведения).
• Обычная — протоколирование в журнале свершившегося факта. Такое событие:
  • обычно не требует реакции;
  • фиксирует произошедший факт;
  • полезно для анализа журнала.
• Низкая — самый низкий уровень значимости. Такое событие:
  • Не требует реакции. Например, уточняет другое событие (расширяет, расшифровывает и т.д. — то есть фиксирует дополнительную информацию в определенных случаях).
  • Может использоваться для отладки и трассировки.
  • Событие имеет смысл на ограниченный период времени или для ограниченного круга заинтересованных лиц:
    • быстро теряет свою актуальность;
    • может содержать специфическую информацию;
    • как правило, не предназначено для длительного регулярного использования.
• ИзКонструктора (по умолчанию) — при выборе этого параметра важность события задается из конструктора во встроенном языке (например, пер Событие = новый ОперацияИмпортДанных(Важность = ВажностьСобытия.Максимальная)).

Пример YAML-файла:

ВидЭлемента: СобытиеЖурналаСобытий
Id: a565661f-f458-465b-8f71-1f90cd490890
ВидСобытия: Операция
Имя: ОперацияИмпортДанных
Важность: Низкая

ВидСобытия

Перечисление. Вид события. Может принимать значения:

• Информация (по-умолчанию) — событие, описывающее не ошибку
• Ошибка — событие, описывающее ошибку
• Операция — событие, описывающее начало и конец операции

Пример YAML-файла:

ВидЭлемента: СобытиеЖурналаСобытий
Id: a565661f-f458-465b-8f71-1f90cd490890
ВидСобытия: Операция
Имя: ОперацияИмпортДанных
Важность: Низкая

Описание

Строка. Подробное человекочитаемое описание события. При обращении к событию используется то описание, которое было актуально на момент регистрации события. Локализуется.

Пример YAML-файла:

ВидЭлемента: СобытиеЖурналаСобытий
Id: a565661f-f458-465b-8f71-1f90cd490890
ВидСобытия: Операция
Имя: ОперацияИмпортДанных
Важность: Низкая
Описание: Операция импорт отмечается событиями с началом и концом операции. 
           В событии конца операции при условии успешного завершения выводится 
           информация об измененных объектах, задании импорта и времени выполнения операции.

Свойства

Коллекция<СвойствоСобытия>. Коллекция свойств события. Каждый элемент коллекции отображается на одноименное свойство во встроенном языке. Пример YAML-файла:

ВидЭлемента: СобытиеЖурналаСобытий
Id: a565661f-f458-465b-8f71-1f90cd490890
ВидСобытия: Операция
Имя: ОперацияИмпортДанных
Важность: Низкая
Свойства:
        -
            Id: a565661f-f458-465b-8f71-1f90cd396890
            Имя: Добавлено
            Тип: Число
            Обязательно: Ложь
        -
            Id: a568521f-f458-465b-8f71-1f90cd490890
            Имя: Пропущено
            Тип: Число
            Обязательно: Ложь
            ЗначениеПоУмолчанию: 0

Ид

Ууид. Идентификатор свойства.

Id: a568521f-f458-465b-8f71-1f90cd490890
Имя: Пропущено
Тип: Число
Обязательно: Ложь
ЗначениеПоУмолчанию: 0

Имя

Строка. Имя свойства. Должно быть уникально в рамках одного события.

Id: a568521f-f458-465b-8f71-1f90cd490890
Имя: Пропущено
Тип: Число
Обязательно: Ложь
ЗначениеПоУмолчанию: 0

Тип

Строка | Число | Булево | Момент | Длительность | ВажностьСобытия | ХарактерОшибки | Ууид | Неопределено . Тип значения свойства.

Id: a568521f-f458-465b-8f71-1f90cd490890
Имя: Пропущено
Тип: Число
Обязательно: Ложь
ЗначениеПоУмолчанию: 0

Описание

Строка. человекочитаемое описание свойства события. Необязательное свойство. При обращении к свойству события используется то описание, которое было актуально на момент регистрации события. Локализуется.

Ид: a565661f-f458-465b-8f71-1f90cd490511
Имя: Дополнительно
Описание: Дополнительная информация
Тип: Строка

ЗначениеПоУмолчанию

Строка | Число | Булево | Момент | Длительность | ВажностьСобытия | ХарактерОшибки | Ууид. Значение свойства по умолчанию. Указанное значение будет записано в журнал событий, если явно не указано другое

Id: a568521f-f458-465b-8f71-1f90cd490890
Имя: Пропущено
Тип: Число
Обязательно: Ложь
ЗначениеПоУмолчанию: 0

Обязательно

Булево. Обязательно ли должно быть задано свойство у события данного типа.

Id: a568521f-f458-465b-8f71-1f90cd490890
Имя: Пропущено
Тип: Число
Обязательно: Ложь
ЗначениеПоУмолчанию: 0

ХарактерОшибки

Перечисление. Характер ошибки. Обязательное поле для вида события Ошибка. Отображается на одноименное свойство во встроенном языке. Если не задано в YAML, задается в конструкторе. Может принимать значения:

• ДляПользователя — ошибка для конечного пользователя.
• ДляПоддержки — ошибка для специалиста поддержки.
• ВнутренняяОшибка — внутренняя ошибка.
• ИзКонструктора — при выборе этого параметра характер ошибки события задается из конструктора во встроенном языке (например, пер Событие = новый ОшибкаИмпорта(ХарактерОшибки = ХарактерОшибки.ВнутренняяОшибка)).

Пример YAML-файла:

ВидЭлемента: СобытиеЖурналаСобытий
Ид: a568521f-f458-465b-8f31-1f90cd490890
Имя: ОшибкаИмпорта
ОбластьВидимости: ВПодсистеме
Важность: Обычная
ВидСобытия: Ошибка
ХарактерОшибки: ДляПоддержки

ШаблонПредставления

Строка. Обязательно для вида Информация и Ошибка. Форматная строка, в которой формируется хорошо читаемое сообщение для человека. В качестве аргументов используются свойства события. Формат используется тот же, что в интерполяции: %{ИмяСвойстваСобытия} либо ${ИмяСвойстваСобытия} (возможна также запись без фигурных скобок). Могут использоваться как предопределенные, так и добавленные пользователем свойства событий. Локализуется. При обращении к событию используется та форматная строка, которая была актуальна на момент регистрации события.

ВидЭлемента: СобытиеЖурналаСобытий
Ид: a568521f-f458-465b-8f31-1f90cd490890
Имя: ОшибкаИмпорта
ОбластьВидимости: ВПодсистеме
Описание: Событие регистрируется при любой ошибке импорта файла данных независимо транзакции. 
          Содержит информацию о задании импорта и блоке данных, на котором произошел сбой.
Важность: Обычная
ХарактерОшибки: ДляПоддержки
ВидСобытия: Ошибка
ШаблонПредставления: Задания %{Задание} завершилось с ошибкой на этапе 
                       обработки объекта %{ОписаниеОбъекта}: %{ОтладочнаяИнформация}.
Свойства:
    -
        Ид: a568521f-f458-460b-8f31-1f90cd490890
        Имя: Задание
        Тип: Ууид
        Обязательно: Истина
    -
        Ид: a568581f-f458-465b-8f31-1f90cd490890
        Имя: ОписаниеОбъекта
        Тип: Строка
        Обязательно: Истина
    -
        Ид: a568521f-f458-225b-8f31-1f90cd490890
        Имя: ОтладочнаяИнформация
        Тип: Строка

ШаблонПредставленияНачала

Строка. Обязательно для вида Операция. Форматная строка, в которой формируется хорошо читаемое сообщение для человека для начала операции. В качестве аргументов используются свойства события. Формат используется тот же, что в интерполяции: %{ИмяСвойстваСобытия} либо ${ИмяСвойстваСобытия} (возможна также запись без фигурных скобок). Могут использоваться как предопределенные, так и добавленные пользователем свойства событий. Локализуется. При обращении к событию используется та форматная строка, которая была актуальна на момент регистрации события.

ВидЭлемента: СобытиеЖурналаСобытий
Ид: a565661f-f458-465b-8f71-1f90cd490890
Имя: ОперацияИмпортДанных
ОбластьВидимости: ВПодсистеме
Описание: Операция импорт отмечается событиями с началом и концом операции. 
          В событии конца операции при условии успешного завершения выводится 
          информация об измененных объектах, задании импорта и времени выполнения операции.
Важность: Низкая
ВидСобытия: Операция
ШаблонПредставленияНачала: Начало операции импорта %{Задание}
ШаблонПредставленияКонца: Операция импорта %{Задание} завершена успешно.  
                          Добавлено %{Добавлено}, пропущено %{Пропущено} объектов. 
                          Общее время %{Длительность}. Дополнительная информация %{Дополнительно}
ШаблонПредставленияОшибки: Операция импорта %{Задание} завершена с ошибкой.  
                           Общее время %{Длительность}. Дополнительная информация %{Дополнительно}
Свойства:
    -
        Ид: a565661f-f458-465b-8f71-1f90cd396890
        Имя: Добавлено
        Тип: Число
    -
        Ид: a568521f-f458-465b-8f71-1f90cd490890
        Имя: Пропущено
        Тип: Число
        ЗначениеПоУмолчанию: 0
    -
        Ид: a710661f-f458-465b-8f71-1f90cd490890
        Имя: Задание
        Тип: Ууид
        Обязательно: Истина
    -
        Ид: a565661f-f458-465b-8f71-1f90cd490511
        Имя: Дополнительно
        Описание: Дополнительная информация
        Тип: Строка

ШаблонПредставленияКонца

Строка. Обязательно для вида Операция. Форматная строка, в которой формируется хорошо читаемое сообщение для человека для успешного завершения операции. В качестве аргументов используются свойства события. Формат используется тот же, что в интерполяции: %{ИмяСвойстваСобытия} либо ${ИмяСвойстваСобытия} (возможна также запись без фигурных скобок). Могут использоваться как предопределенные, так и добавленные пользователем свойства событий. Локализуется. При обращении к событию используется та форматная строка, которая была актуальна на момент регистрации события.

ВидЭлемента: СобытиеЖурналаСобытий
Ид: a565661f-f458-465b-8f71-1f90cd490890
Имя: ОперацияИмпортДанных
ОбластьВидимости: ВПодсистеме
Описание: Операция импорт отмечается событиями с началом и концом операции. 
          В событии конца операции при условии успешного завершения выводится 
          информация об измененных объектах, задании импорта и времени выполнения операции.
Важность: Низкая
ВидСобытия: Операция
ШаблонПредставленияНачала: Начало операции импорта %{Задание}
ШаблонПредставленияКонца: Операция импорта %{Задание} завершена успешно.  
                           Добавлено %{Добавлено}, пропущено %{Пропущено} объектов. 
                           Общее время %{Длительность}. Дополнительная информация %{Дополнительно}
ШаблонПредставленияОшибки: Операция импорта %{Задание} завершена с ошибкой.  Общее время %{Длительность}. 
                           Дополнительная информация %{Дополнительно}
Свойства:
    -
        Ид: a565661f-f458-465b-8f71-1f90cd396890
        Имя: Добавлено
        Тип: Число
    -
        Ид: a568521f-f458-465b-8f71-1f90cd490890
        Имя: Пропущено
        Тип: Число
        ЗначениеПоУмолчанию: 0
    -
        Ид: a710661f-f458-465b-8f71-1f90cd490890
        Имя: Задание
        Тип: Ууид
        Обязательно: Истина
    -
        Ид: a565661f-f458-465b-8f71-1f90cd490511
        Имя: Дополнительно
        Описание: Дополнительная информация
        Тип: Строкаъ

ШаблонПредставленияОшибки

Строка. Обязательно для вида Операция. Форматная строка, в которой формируется хорошо читаемое сообщение для человека для завершения операции с ошибкой. В качестве аргументов используются свойства события. Формат используется тот же, что в интерполяции: %{ИмяСвойстваСобытия} либо ${ИмяСвойстваСобытия} (возможна также запись без фигурных скобок). Могут использоваться как предопределенные, так и добавленные пользователем свойства событий. Локализуется. При обращении к событию используется та форматная строка, которая была актуальна на момент регистрации события.

ВидЭлемента: СобытиеЖурналаСобытий
Ид: a565661f-f458-465b-8f71-1f90cd490890
Имя: ОперацияИмпортДанных
ОбластьВидимости: ВПодсистеме
Описание: Операция импорт отмечается событиями с началом и концом операции. 
          В событии конца операции при условии успешного завершения выводится 
          информация об измененных объектах, задании импорта и времени выполнения операции.
Важность: Низкая
ВидСобытия: Операция
ШаблонПредставленияНачала: Начало операции импорта %{Задание}
ШаблонПредставленияКонца: Операция импорта %{Задание} завершена успешно.  
                          Добавлено %{Добавлено}, пропущено %{Пропущено} объектов. 
                          Общее время %{Длительность}. Дополнительная информация %{Дополнительно}
ШаблонПредставленияОшибки: Операция импорта %{Задание} завершена с ошибкой.  
                            Общее время %{Длительность}. Дополнительная информация %{Дополнительно}
Свойства:
    -
        Ид: a565661f-f458-465b-8f71-1f90cd396890
        Имя: Добавлено
        Тип: Число
    -
        Ид: a568521f-f458-465b-8f71-1f90cd490890
        Имя: Пропущено
        Тип: Число
        ЗначениеПоУмолчанию: 0
    -
        Ид: a710661f-f458-465b-8f71-1f90cd490890
        Имя: Задание
        Тип: Ууид
        Обязательно: Истина
    -
        Ид: a565661f-f458-465b-8f71-1f90cd490511
        Имя: Дополнительно
        Описание: Дополнительная информация
        Тип: Строка