Russian (Русский) - Change language

XML-файл отчета

XML-файл содержит информацию о пользовательском отчете и используется для подключения пользовательского отчета к Консоли Администрирования и Мониторинга ABBYY FlexiCapture. При установке системы к Консоли подключены примеры возможных пользовательских отчетов. При необходимости просмотрите их структуру или используйте как образец.

XML-файл отчета содержит следующие элементы:

  1. <customreport></customreport>
    Главный элемент отчета, все описание отчета должно находиться внутри него. Атрибуты:
    • Name – название отчета, обязательный атрибут. Это название будет отображаться в меню Консоли Администрирования и Мониторинга.
    • Type – тип отчета, обязательный атрибут. Может принимать значения DataSetReport (для отчета на основе набора данных).
    • Description – необязательный атрибут. Если указан, отображается на странице отчета в Консоли Администрирования и Мониторинга.
  1. <crystalreportfile/>
    Обязательный элемент. Имеет единственный атрибут Filename, который указывает имя файла отчета (*.rdl или *.rdlc). Данный файл должен находиться в одном каталоге с XML-файлом описания отчета.
    Замечание. Прочие элементы требуются только для отчетов на основании набора данных.
  2. <storedprocedure/>
    Обязательный элемент, если данные извлекаются с помощью хранимой процедуры. Имеет единственный атрибут Name, который содержит название хранимой процедуры.
  3. <sqlText></sqlText>
    Обязательный элемент, если данные извлекаются с помощью SQL-запроса. Текст запроса располагается между открывающим и закрывающим тегами.
    Замечание. Если в файле присутствуют оба тега, <storedprocedure/> и <sqlText></sqlText>, набор данных будет формироваться с помощью хранимой процедуры.
  4. <parameters></parameters>
    Набор элементов <parameter> – параметров хранимой процедуры или SQL-запроса. Если для формирования набора данных не требуется указывать параметры, элемент должен отсутствовать.
  5. <parameter></parameter>
    Описывает параметр SQL-запроса или хранимой процедуры и особенности его ввода пользователем на Консоли Администрирования и Мониторинга. Атрибуты:
    • Name – имя параметра. Обязательный атрибут. Передается в хранимую процедуру или SQL-запрос.
    • Type – тип параметра. Обязательный атрибут. Возможные значения: Int, Date, String.
    • Prompt – подсказка при вводе пользователем значения параметра. Необязательный атрибут.
    • Default – значение, предлагаемое по умолчанию при вводе пользователем значения параметра. Необязательный атрибут. Для параметров с типом Date доступно зарезервированное значение now, соответствующее текущей дате.

По умолчанию для ввода значения параметра пользователем на Консоли Администрирования и Мониторинга используется поле ввода. Если необходимо, чтобы пользователь выбирал значение параметра из списка, добавьте элемент <possiblevaluelist>.

  1. <possiblevaluelist></possiblevaluelist>
    Набор элементов <possiblevaluelistitem /> – возможных значений элемента <parameter>.
  2. <possiblevaluelistitem />
    Описывает одно из возможных значений параметра. Атрибуты:
    • value – возможное значение параметра. Обязательный атрибут. Тип значения должен совпадать с типом параметра.
    • displayvalue – строка, отображаемая пользователю в списке выбора. Необязательный атрибут. Если атрибут не указан, пользователю отображается значение атрибута value.

11/10/2020 12:08:08 PM


Please leave your feedback about this article