Главная

Руководство: Мета файл

Мета файл

Мета файл - это текстовый файл, в кодировке UTF-8, определяющий тип, параметры и ресурсы расширения.
Каждый тип расширения имеет своё расширение мета файла:

  • .rep - отчёт
  • .prn - печатная форма
  • .view - просмотр объектов (например документов)
  • .action - обработчик действий

например "reportname.rep", "printformname.prn"

Каждый метафайл состоит из двух секций:

  • params - секция с параметрами
  • files - секция с ссылками на файлы, пути к файлам указываются относительно расположения мета файла

Пример мета файла:

[params]
uri = stmobile://report/...
contentType = html

[files]
script = myscript.js
template = mytemplate.html

Общие параметры:

  • uri - содержит stmobile://... - идентификатор расширения, обязательный параметр
  • enabled - значение true/false - признак, что расширение включено, не обязательный параметр, по умолчанию true. Также позволяет отключить стандартный отчет или печатную форму, если установить значение false.

Отчёты

[params]
uri = stmobile://report/...
contentType = html
title = Название отчёта
section = Название группы отчётов
priority = 1

[files]
script = myscript.js
template = mytemplate.html

Параметры:

  • uri - идентификатор отчёта, начинается с stmobile://report/ (см. URI)
  • contentType - формат шаблона представления, обычно html (см. Шаблон представления)
  • title - отображаемое название отчёта
  • section - название группы в которую попадёт отчёт, если такой группы нет, то она будет добавлена.
  • priority - приоритет отчёта в группе
  • apiversion - версия движка api (начиная версии 4.1 по умолчанию равно 2)
  • openmode - вариант открытия страницы (page/dialog, по умолчанию page). Параметр можно задать при переходе на отчет, через URI (параметр в URI приоритетнее, чем в мета-файле)
  • contentWidthMode - (только для openmode = page), задает ширину страницы full/copact
  • contentHeigthSize - (только для openmode = dialog), задает высоту страницы
  • script - скрипт получения и подготовки данных для отображения (см. Скрипт файл)
  • template - шаблон отчёта (см. Шаблон представления)

Печатные формы

[params]
uri = stmobile://printform/...
contentType = fixedText
title = Название печатной формы

[files]
script = myscript.js
template = mytemplate.txt
template_wide = mytemplate_wide.txt

Параметры:

  • uri - идентификатор печатной формы, начинается с stmobile://printform/ (см. URI)
  • contentType - формат шаблона представления, обычно fixedText (моноширинный текст) (см. Шаблон представления)
  • title - отображаемое название отчёта
  • script - скрипт получения и подготовки данных для отображения (см. Скрипт файл)
  • template - шаблон печатной формы (см. Шаблон представления)
  • template_wide - шаблон печатной формы, широкая форма

Просмотр объектов

[params]
uri = stmobile://viewer/...
contentType = html
title = Название формы просмотра

[files]
script = myscript.js
template = mytemplate.html

Параметры:

  • uri - идентификатор формы просмотра, начинается с stmobile://viewer/ (см. URI)
  • contentType - формат шаблона представления, обычно html (см. Шаблон представления)
  • title - отображаемое название формы просмотра
  • script - скрипт получения и подготовки данных для отображения (см. Скрипт файл)
  • template - шаблон формы просмотра (см. Шаблон представления)

Обработчик действий

[params]
uri = stmobile://action/...

[files]
script = myscript.js

Параметры:

  • uri - идентификатор обработчика действий, начинается с stmobile://action/ (см. URI)
  • script - скрипт выполняющий действие (см. Скрипт файл)