Отчет

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

Уникальные действия

[?]

Настроить

Это действие используется для редактирования свойств отчета.  

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

Тип действия:

настроить

Редактировать шаблон отчета

Это действие поддерживается только в AggreGate Client. Оно запускает Редактор отчетов и позволяет редактировать шаблон отчета.

Имя действия:

editTemplate

Неинтерактивный режим:

Не поддерживается

Права доступа:

Доступно на уровне с правами доступа для Менеджера.

Показать исходные данные

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

Имя действия:

viewData

Не интерактивный режим:

не поддерживается

Права доступа:

Доступно на уровне с правами доступа для Наблюдателя.  

Просмотреть историю

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

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

Тип действия:

настроить

Имя действия:

viewHistory

Права доступа:

Доступно на уровне с правами доступа для Менеджера

Экспортировать в файл сервера

Это действие вызова функции сохраняет заполненный отчет в файл на машине AggreGate Server. Отчет заполняется данными в момент выполнения данного действия и, таким образом, всегда содержит актуальные данные.

Отчеты могут сохраняться в одном из следующих форматов:

  • Формат документов для печати (PDF)

  • Microsoft Excel (XLS)

  • Расширенный текстовый формат (RTF)

  • Файл данных с разделителями-запятыми (CSV)

  • Расширяемый язык маркировки (XML)

  • Open Office (ODT)

Также можно выбрать разделитель полей для CSV формата.

Тип действия:

вызвать функцию

Имя действия:

export

Права доступа:

Доступны на уровне прав доступа для Оператора

Экспортировать в файл клиента

Это действие вызова функции открывает заполненный отчет как Блок данных, возволяя сохранять его в файл на AggreGate Client или на локальной машине веб пользователя. Отчет заполняется данными в момент выполнения данного действия и, таким образом, всегда содержит актуальные данные.

Отчеты могут сохраняться в одном из следующих форматов:

  • Формат документов для печати (PDF)

  • Microsoft Excel (XLS)

  • Расширенный текстовый формат (RTF)

  • Файл данных с разделителями-запятыми (CSV)

  • Расширяемый язык маркировки (XML)

  • Open Office (ODT)

Также можно выбрать разделитель полей для CSV формата.

Тип действия:

Call Function

Имя действия:

exportRemote

Права доступа:

Доступны на уровне прав доступа для Оператора

Отправить отчет по e-mail

Это действие вызова функции отправляет отчет по e-mail получателям, заданным в виде списка e-mail адресов, разделенных запятой. Отчет заполняется данными в момент выполнения данного действия и, таким образом, всегда содержит самые свежие данные.

Отчеты могут отправляться в одном из следующих форматов:

  • Формат документов для печати (PDF)

  • Microsoft Excel (XLS)

  • Расширенный текстовый формат (RTF)

  • Файл данных с разделителями-запятыми (CSV)

  • Расширяемый язык маркировки (XML)

  • Open Office (ODT)

Также можно выбрать разделитель полей для CSV формата.

Может оказаться очень удобным запланировать это действие так, чтобы оно активировало периодическую отправку отчета по e-mail (например, ежедневно или еженедельно).

Тип действия:

Call Function

Имя действия:

sendByMail

Права доступа:

Доступно на уровне с правами доступа для Менеджера.

Показать отчет

(Действие по умолчанию)

Это действие используется для построения и просмотра отчета.

Поток действия:

  • [Не обязательно] Система подсказывает пользователю ввести параметры отчета, которые используют UI процедуру редактировать данные.

  • Шаблон отчета составляется на сервере и заполняется данными.

Имя действия:

show

Иконка действия:

Не интерактивный режим:

не поддерживается

Права доступа:

Доступно на уровне с правами доступа для Наблюдателя.  

Параметры выполнения:

Отчет о расположении окна

Отчет о свойствах инструментальных панелей

Запланировать отправку отчета

Это действие вызова функции создает новую запланированную задачу для периодической отправки заполненного отчета по e-mail в формате, заданном пользователем.

Более подробно см. Отправить отчет по E-mail

Имя действия:

schedule

Иконка действия:

Права доступа:

Доступно на уровне с правами доступа для Менеджера.

Общие действия

[?]

Удалить, создать копию, реплицировать, редактировать права доступа, просмотр событий, показать статус

Состояния и иконки контекста

Иконка

Код

Состояние

0

Этот отчет относительный.

1

Этот отчет абсолютный.

Дополнительная информация

Информация о контексте

Тип контекста: report

Имя контекста: предварительно определено, для каждого отчета разное.

Описание контекста: предварительно определено, для каждого отчета разное.

Путь контекста: users.USER_NAME.reports.REPORT_NAME

Контекстная маска: users.*.reports.*

Права доступа к контексту

[?]

Уровень

Описание

Отсутствует

Нет доступа.

Наблюдатель

Запуск отчета.

Просмотр исходных данных отчета.

Мониторинг основных событий.

Просмотр статуса.

Оператор

Просмотр конфигурации.

Менеджер

Конфигурация и удаление отчета.

Инженер

Те же, что у Менеджера.

Администратор

Те же, что у Менеджера.

Общие переменные (свойства)

[?]

Общие переменные: groupMembership (членство группы), validity (пригодность), activeAlerts (активные тревоги)

Свойства отчета

См. описание переменной и ее полей здесь.

Имя переменной:

childInfo

Записи:

1

Права доступа:

Доступно для чтения на уровне с правами доступа для Наблюдателя, доступно для записи с правами доступа для Менеджера.  

Формат записи:

Имя поля

Тип поля

Примечания

name

String

1 - 50 знаков

description

String

1 - 100 знаков

expression

String

template

String

type

Integer

validityExpression

String

validityListeners

Data Table

defaultContext

String

История отчета

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

Системные операторы могут удалять истории отчетов, убирая определенные записи из этой таблицы и сохраняя изменения на сервере.

Имя переменной:

history

Записи:

0... не ограничено

Права доступа:

Доступны для чтения на уровне с правами доступа для Наблюдателя, доступны для записи на уровне с правами доступа для Менеджера

Формат записи:

Имя поля

Тип поля

Примечания

date

Date

Дата создания отчета.

user

String

Пользователь системы, который заполнил отчет.

report

Data Block

Данные отчета. Могут открываться в Обозревателе отчетов.

Дополнительные параметры отчета

См. описание переменной и ее полей здесь.

Имя переменной:

Parameters

Записи:

0...не ограничено

Права доступа:

Доступно для чтения на уровне с правами доступа для Наблюдателя, доступно для записи с правами доступа для Менеджера.  

Формат записи:

Имя поля

Тип поля

Примечания

parameter

String

value

String

Общие функции

[?]

Экспортировать в файл сервера

Сохраняет отчет в файл на AggreGate Server. Файл будет расположен в установочной директории AggreGate Server до тех пор, пока обозначенный путь абсолютен.

Имя функции:

export

Права доступа:

Доступно на уровне прав доступа для Менеджера

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

file

Строка

Путь конечного файла (абсолютного или относительного, с расширением или без расширения).

format

Целое

Формат отчета. Указывается один из следующих типов отчетов:

  • Формат документов для печати (PDF)

  • Microsoft Excel (XLS)

  • Расширенный текстовый формат (RTF)

  • Файл данных с разделителями (CSV)

  • Расширяемый язык маркировки (XML)

  • Open Office (ODT)

fieldDelimiter

Строка

Разделитель CSV полей. Символьный литерал для разграничения полей в отчете. Должен содержать запятую, точку с запятой, пробел или табуляцию.

targetContextMask

Строка

Маска контекстов, для которой генерируется относительный отчет.

Записи вывода:

0

Формат вывода:

Нет

Экспортировать в файл клиента

Создает загружаемый отчет AggreGate Server.

Имя функции:

exportRemote

Права доступа:

Доступно на уровне прав доступа для Менеджера

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

format

Целое

Формат отчета. Указывается один из следующих типов отчетов:

  • Формат документов для печати (PDF)

  • Microsoft Excel (XLS)

  • Расширенный текстовый формат (RTF)

  • Файл данных с разделителями (CSV)

  • Расширяемый язык маркировки (XML)

  • Open Office (ODT)

targetContextMask

Строка

Маска контекстов, для которой генерируется относительный отчет.

Записи вывода:

1

Формат вывода:

Нет

Имя

Тип

Описание

value

Блок данных

Созданный файл отчета.

Отправить отчет по email

Заполняет отчет данными и отправляет его по email.

Имя функции:

sendByMail

Права доступа:

Доступно на уровне с правами доступа для Менеджера.  

Записи ввода:

1

Формат ввода:

Имя

Тип

Описание

recipients

Строка

email получателей (через запятую)

format

Целое

Формат отчета. Указывается один из следующих типов отчетов:

  • Формат документов для печати (PDF)

  • Microsoft Excel (XLS)

  • Расширенный текстовый формат (RTF)

  • Файл данных с разделителями (CSV)

  • Расширяемый язык маркировки (XML)

  • Open Office (ODT)

fieldDelimiter

Строка

Разделитель CSV полей. Символьный литерал для разграничения полей в отчете. Должен содержать запятую, точку с запятой, пробел или табуляцию.

targetContextMask

Строка

Маска контекстов, для которой генерируется относительный отчет.

subject

Строка

Тема электронного письма.

message

Строка

Тело электронного письма.

html

Булево

Флаг, указывающий, является ли тело сообщения HTML.

fileName

Строка

Имя файла для прикрепленного отчета.

Записи вывода:

0

Формат вывода:

Нет

Общие события

[?]

Общие события: info (информация)