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

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

АРТ»

115184, Москва, Озерковский переулок, д. 12

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

Руководство разработчика

Страниц   168

Версия 0.9.7 02.02.2018

Назначение документа

Настоящий документ содержит руководство разработчика по программному продукту «QP8.Framework». Также в документе содержится описание дополнительного продукта «Виджетная платформа». Цель документа – предоставить разработчику сведения, достаточные для разработки и сопровождения Информационных Систем, основанных на продуктах.

Целевая аудитория

Документ предназначен для разработчиков, обладающих следующими компетенциями:

знание технологий программной платформы. NET для разработки веб-приложений ( MVC, ); знание языков C#, SQL, XAML; знание технологий LINQ to SQL, Entity Framework; знание веб-технологий (HTTP, DNS).

История изменений

Версия	Дата	Автор	Описание
0.9.7	02.01.2018		Добавлено уточнение свойства поля «Уникальное (Unique)» (см. Свойства поля) Удалено упоминание о том, что свойство «Обязательное (Required)» недоступно полям типа M2M (см. Свойства поля) Добавлено примечание о использовании команды контекстного меню поля «Apply Default Value» (см. Параметры, зависящие от типа (Type-specific parameters))
0.9.6	31.01.2018		Добавлено уточнение свойства «Общее владение (Shared Ownership)» (см. Свойства группы пользователей)
0.9.5	25.1.2018		Добавлено: Описание параметра Disable list auto wrapping (ul, ol, dl) (см. Параметры визуального редактора (Visual Editor Parameters)) Удалено: United режим работы сайта
0.9.4	25.1.2018		Добавлена ссылка на описание свойства поля (см. Фильтрация по умолчанию (Default Filters))
0.9.3	19.01.2018		Добавлено: Пример использования функционала «фильтрация по умолчанию» (см. Фильтрация по умолчанию (Default Filters)); Описание команд контекстного меню. Например, создание статьи (см. Статья (Article)). Обновлено: Структура QP (Логическая структура QP). Удалено: Информация о том, что учетная запись создаваемого пользователя имеет статус «Заблокирован» (Свойства пользователя)
0.9.2	17.01.2018		Обновлено: Описание подразделов: Основные принципы, Описание синтаксиса, Remote-валидация, Поддержка ссылок {x:Reference}, Ресурсный словарь, Добавлено: Подраздел Условие «AreEqual»; Пример использования динамического ресурсного словаря (см. Динамический ресурсный словарь). Удалено: Подраздел «Unit-тестирование»
0.9.1	17.01.2018		Обновлено: Ссылки на описания NuGet-пакетов (см. «Установка NuGet-пакетов»)
0.9	16.01.2018		Обновлено: Подраздел «Установка NuGet-пакетов»
0.8	18.12.2017		Добавлено: Установка пакетов NuGet для QP

Содержание

1.        Термины и определения        9

1.1.        Общие термины и определения        9

1.2.        Термины и определения для QP        9

1.3.        Определения для ролей пользователей в Системе        10

1.4.        Аббревиатуры        10

2.        Обозначения        11

3.        Общие сведения о продукте        12

3.1.        Системные требования        12

3.1.1.        Аппаратное обеспечение        12

3.1.2.        Программное обеспечение        12

3.2.        Документация по продукту        13

4.        Справочник Разработчика        14

4.1.        Логическая структура QP        14

4.2.        Пользователь (User)        14

4.2.1.        Свойства пользователя        15

4.3.        Группа пользователей (User Group)        17

4.3.1.        Свойства группы пользователей        18

4.4.        Сайт (Site)        18

4.4.1.        Создание нового сайта        19

4.4.2.        Копирование сайта        23

4.4.3.        Изменение свойств сайта        23

4.4.4.        Удаление сайта        23

4.4.5.        Сборка сайта        23

4.5.        Контент (Content)        25

4.5.1.        Создание нового контента        25

4.5.2.        Копирование контента        27

4.5.3.        Изменение свойств контента        27

4.5.4.        Очистка контента        27

4.5.5.        Удаление контента        28

4.6.        Виртуальный контент (Virtual Content)        28

4.6.1.        Виртуальный контент типа «JOIN»        28

4.6.2.        Виртуальный контент типа «UNION»        28

4.6.3.        Виртуальный контент типа «USER QUERY»        28

4.6.4.        Создание виртуального контента        29

4.6.5.        Изменение свойств виртуального контента        29

4.6.6.        Удаление виртуального контента        29

4.7.        Поле (Field)        29

4.7.1.        Создание нового поля        29

4.7.2.        Копирование поля        40

4.7.3.        Изменение свойств поля        40

4.7.4.        Удаление поля        41

4.8.        Статья (Article)        41

4.8.1.        Служебные свойства статьи        41

4.9.        Архивная статья (Archive Article)        42

4.10.        Уведомление (Notification)        42

4.10.1.        Архитектура уведомлений        42

4.10.2.        Обобщённый алгоритм работы уведомлений        43

4.10.3.        Свойства уведомления        43

4.10.4.        Сборка уведомления        45

4.10.5.        Внешнее уведомление        45

4.11.        Workflow        47

4.11.1.        Статус        48

4.11.2.        Создание и изменение Workflow        48

4.11.3.        Использование Workflow        49

4.11.4.        Параллельный Workflow        49

4.11.5.        Отмена расщепления        50

4.11.1.        Комментарий при смене статуса Workflow        50

4.11.2.        История изменений статуса статьи        50

4.11.3.        Удаление Workflow        50

4.12.        Пользовательское действие (Custom action)        50

4.12.1.        Свойства пользовательского действия        51

4.12.2.        Передача контекста        54

4.12.3.        Неинтерфейсное пользовательское действие        54

4.12.4.        Подтверждение на выполнение пользовательского действия        55

4.13.        Стиль визуального редактора (Visual Editor Style)        55

4.13.1.        Свойства стиля визуального редактора        55

4.14.        Плагин визуального редактора (Visual Editor Plugin)        56