Программный продукт «QP8.Framework» (стр. 20 )

Рисунок 5. 1111.

В свойствах контента используется свойство «Скрипт для формы». Скрипт используется в форме для текущего контента.

Рисунок 6. 111.

Параметр QP_CURRENT_CONTEXT заменяется на значение для текущего контекста (компонента, создаваемого для вкладки или окна с редактором).

Методы и поля объекта контекста

setGlobal(key, value)

Установка глобальной переменной (уровня бекэнда).

Полезно при задании переменной во внешнем скрипте и чтении из скрипта, определяемого в бекэнде.

getGlobal(key)

Чтение глобальной переменной (уровня бекэнда).

loadScript(url, key)

Загрузка внешнего скрипта с проверкой на повторную загрузку по имени или по ключу.

Примечание: параметр key необязателен.

addCustomButton(settings)

Добавление пользовательской кнопки для поля с указанным именем.

Примечание: кнопка добавляется справа от поля.

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

Название	Описание
name	Имя поля формы, к которому добавляется кнопка.
title	Имя кнопки. Используется в ГПИ.
suffix	Суффикс для формирования идентификатора кнопки на основании идентификатора поля.
class	CSS-класс кнопки. Примечание: необязательный параметр. Примечание: поскольку class является зарезервированным словом в JavaScript, его нужно задавать в кавычках или апострофах, иначе возможна некорректная работа (например, в IE8).
url	URL пиктограммы для кнопки. Примечание: необязательный параметр.
onClick	Обработчик события click. Назначается на кнопку с помощью стандартных средств jQuery. В качестве дополнительных параметров обработчика в него передаются: settings – исходные настройки кнопки; $input – jQuery-обёртка элемента ГПИ, к которому привязана кнопка; $form – jQuery-обёртка формы.

addCustomLinkButton(settings)

Добавление пользовательской кнопки для поля с указанным именем.

Примечание: кнопка LinkButton добавляется над полем.

Назначается на кнопку с помощью стандартных средств jQuery. В качестве дополнительных параметров обработчика в него передаются те же поля, что и в методе addCustomButton.

initHandler

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

В качестве параметров метода передаются:

Название	Описание
editor	Родительский компонент BackendEntityEditor.
$elem	Обёртка jQuery для родительского элемента (формы или контейнера для классификатора).

disposeHandler

Поле, задающее пользовательский обработчик события dispose.

Передаваемые параметры идентичны параметрам метода initHandler.

beforeSubmitHandler

Поле, задающее пользовательский обработчик события beforeSubmit. В качестве параметров метода передаётся параметр editor – родительский компонент BackendEntityEditor.

fieldValueChangedHandler

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

В качестве параметров метода передаются:

Название	Описание
editor	Родительский компонент BackendEntityEditor.
data	Объект для автоматического сохранения. Содержит поля: fieldName – имя поля, value – значение поля.

Запись и воспроизведение действий

Существует функциональная возможность записать в файл последовательность всех действий пользователей в бекэнде (в пределах текущего Customer Code), приводящих к изменению данных в БД, а также в дальнейшем автоматически выполнить в бекэнде все действия из подобного файла.

Внимание: в текущей версии QP не поддерживается запись следующих действий:

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

Возможность полезна в ситуациях, когда Система существует в нескольких окружениях, при этом в части окружений возможность вносить изменения прочими штатными средствами QP отсутствует или занимает много времени, например, из-за корпоративных политик. Запись действий осуществляется в формате XML.

Примечание: данные по воспроизведению действий приведены в руководстве администратора.

Запись действий на сервере-источнике

Для включения записи требуется активировать свойство «Записывать действия в файл» (Record actions into file) (пункт контекстного меню «Настройки» для корневого элемента в дереве сущностей).

Рисунок 7. Настройки в контекстом меню.

Свойство «Очистить файл, если он существует» (Empty file if exists), следует активировать, если действия нужно записывать в пустой файл. В противном случае запись будет осуществляться в конец существующего файла.

Рисунок 8. Параметры записи действий.

XML-файл размещается во временной директории QP, имя файла совпадает с Customer Code.

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

Отпечаток БД (DB fingerprint)

Механизм проверки отпечатка БД (DB fingerprint) предназначен для определения, что БД, в которой выполнена запись XML-файла и БД, в которой требуется выполнить действия, не имеют существенных отличий. Решение об отличии принимается на основании вычисления отпечатка БД.

Если отпечатки двух БД совпадают, то они считаются идентичными или несущественно различающимися, что означает, что действия из XML-файла, записанные в одной БД, можно выполнить во второй.

Конфигурация отпечатка БД задаётся в свойстве «Конфигурация вычисления "отпечатка" БД» (DB fingerprint computing configuration).

Если конфигурация отпечатка БД задана, то при создании нового файла в него будет записано вычисленное значение отпечатка и конфигурация, при которой он вычислялся.

Пример конфигурации отпечатка БД:

<fingerprint>

       <entityType code="site">

               <included>

                       <id>34</id>

               </included>

       </entityType>

       <entityType code="content" considerIdentity="true">

               <included>

                       <parentId>34</parentId>

               </included>

               <excluded>

                       <id>285</id>

               </excluded>

       </entityType>

       <entityType code="field">

               <excluded>

                       <parentId>285</parentId>

               </excluded>

       </entityType>

       <entityType code="content_link" />

</fingerprint>

Параметры:

Название	Описание
entityType	Задаёт сущности QP, по которым должен вычисляться отпечаток. Возможные значения кодов: public const string None = ""; public const string CustomerCode = "db"; public const string Site = "site"; public const string ContentGroup = "content_group"; public const string Content = "content"; public const string Article = "article"; public const string OldArticle = "content_item"; public const string ArchiveArticle = "archive_article"; public const string ArticleVersion = "article_version"; public const string FieldGroup = "field_group"; public const string Field = "field"; public const string VirtualField = "virtual_field"; public const string VirtualArticle = "virtual_article"; public const string Notification = "notification"; public const string VisualEditorPlugin = "visual_editor_plugin";         public const string VisualEditorStyle = "visual_editor_style"; public const string VisualEditorCommand = "visual_editor_command"; public const string ContentFolder = "content_folder"; public const string SiteFolder = "site_folder"; public const string OldSiteFolder = "folder"; public const string ContentFile = "content_file"; public const string SiteFile = "site_file"; public const string Workflow = "workflow"; public const string WorkflowRule = "workflow_rule"; public const string VirtualContent = "virtual_content";  public const string StatusType = "status_type"; public const string Style = "style"; public const string Snippet = "snippet"; public const string User = "user";  public const string UserGroup = "user_group"; public const string CustomAction = "custom_action"; public const string BackendAction = "backend_action"; public const string SitePermission = "site_permission"; public const string ContentPermission = "content_permission"; public const string ArticlePermission = "article_permission"; public const string WorkflowPermission = "workflow_permission"; public const string SiteFolderPermission = "site_folder_permission"; public const string EntityTypePermission = "entity_type_permission"; public const string ActionPermission = "action_permission"; public const string PageTemplate = "template"; public const string Page = "page"; public const string TemplateObject = "template_object"; public const string PageObject = "page_object"; public const string TemplateObjectFormat = "template_object_format"; public const string PageObjectFormat = "page_object_format"; public const string PageObjectFormatVersion = "page_object_format_version"; public const string TemplateObjectFormatVersion = "template_object_format_version"; public const string ContentLink = "content_link";
Included	Можно ограничить вычисление отпечатка по определённому критерию, включив или исключив определённые сущности по их собственному или родительскому идентификаторам. Ограничения учитывают иерархию сущностей (к дочерним сущностям ограничение будет применено автоматически). Например, если нужно ограничить вычисление определенным сайтом (Id = 34), то требуется задать это ограничение только для entityType со значением site.
Excluded
ParentId
Id
considerIdentity	Указатель, требуется ли при вычислении отпечатка учитывать текущее значение счётчика для идентификатора сущности. Например, если создать поле и затем сразу же удалить его, то содержимое БД до операции будет идентично содержимому БД после операции, но значение счётчика увеличится.

Создание Систем с использованием продукта

Возможные архитектурные решения для Системы: