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

Сайт – набор данных в бекэнде. Допускается создание нескольких сайтов. Содержимое каждого сайта определяется созданными в нём контентами.

Статья – элемент контента. Статья содержит данные, заданные в поля контента.

Физический путь – путь до объекта в файловой системе.

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

Пользователь – персона, осуществляющая взаимодействие с Системой.

Администратор – пользователь с правами на внесение любых изменений в Систему, которые можно выполнить с использованием бекэнда QP.

Контент-менеджер – пользователь с ограниченными правами на изменение содержимого Системы с использованием бекэнда QP.

Разработчик – пользователь с правами на внесение любых изменений в Систему (в том числе в содержимое скриптов, структуру БД).

Аббревиатуры

БД – База данных.

СУБД – система управления базами данных.

HTML (от англ. «HyperText Markup Language») – язык разметки документов.

JSON (от англ. «JavaScript Object Notation») – текстовый формат обмена данными.

XML (от англ. «eXtensible Markup Language») – расширяемый язык разметки документов.

API (от англ. «Application programming interface», интерфейс программирования приложений) – набор правил по использованию функциональных возможностей Системы, предоставляемый разработчикам для организации взаимодействия сторонних программных продуктов с Системой.

LINQ (от англ. «Language-Integrated Query») – компонент. NET Framework для работы с данными из БД, как с объектами. Запросы к СУБД формируются с использованием языков программирования. NET.

LINQ to SQL – решение для LINQ, позволяющее в качестве источника данных использовать СУБД Microsoft SQL Server.

DPC (Digital Product Catalog) – программный продукт, разработанный на базе QP. Ориентирован на удобство работы со структурой данных для различных продуктов Заказчика.

POCO (от англ. «Plain old CLR object») – подход к разработке программного обеспечения, предполагающий использование максимально простых классов для работы с объектами.

Обозначения

Обозначение	Описание	Пример использования
Технические данные	Используется для выделения различных технических данных в тексте: URL, названия свойств и методов, имена файлов и т. п.	ГПИ Системы доступен по URL https://www. domainname. zone/.
Код	Пример кода.	public DataTable Data { get; set; }
Переменная	Используется для указания переменного значения.	Формат URL: Базовый URI/Псевдоним объекта
Требует дополнения	TBD (to be determined). Указывает, что необходима доработка текста – проверка корректности утверждения, детализация, правка после внесения изменений в документ и т. п.	Система работает с одной БД.
Примечание:	Дополнительные данные справочного характера.	Примечание: используется при генерации классов LINQ to SQL.
Внимание:	Важные данные, которые требуется обязательно учитывать.	Внимание: опция поддерживается только ASP-сборкой в целях совместимости.

Общие сведения о продукте Системные требования Аппаратное обеспечение

Минимальная конфигурация	Рекомендуемая конфигурация
Процессор	Intel Pentium IV 1.8 ГГц	Intel Xeon 2.4 ГГц x2
Память	2 ГБ	8 ГБ
Дисковое пространство	2 ГБ	100 ГБ и больше (в зависимости от применения)

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

Операционная система

Окружение	Описание
Production	Требуется серверная ОС: Microsoft Windows Server 2008, Microsoft Windows Server 2008 R2, Microsoft Windows Server 2012, Microsoft Windows Server 2012 R2, Microsoft Windows Server 2016.
Stage	Достаточно ОС для настольных ПК: Microsoft Windows 7, Microsoft Windows 8.1, Microsoft Windows 10. Рекомендуется ОС из списка для production-окружения.
Development

Поддерживаются 64-битные версии ОС.

Для рабочего места Разработчика достаточно любой из перечисленных ОС для настольных ПК.

СУБД

Полностью поддерживаемые СУБД:

Microsoft SQL Server 2008, Microsoft SQL Server 2012, Microsoft SQL Server 2014, Microsoft SQL Server 2016.

Примечание: для выполнения обновления продукта с использованием мастера установки требуется модуль sqlps (SQL Server PowerShell).

Частично поддерживаемые СУБД:

Внимание: в Microsoft SQL Server Express без компонента «Advanced Services» не поддерживается полнотекстовый поиск.

Microsoft SQL Server 2008 Express (с «Advanced Services»), Microsoft SQL Server 2012 Express (с «Advanced Services»).

Веб-сервер

Microsoft IIS 7 Microsoft IIS 7.5 Microsoft IIS 8 Microsoft IIS 8.5 Microsoft IIS 10

Программное обеспечение для работы с ГПИ продукта

Работа с ГПИ ведётся с использованием веб-браузера. Поддерживаемые веб-браузеры:

Google Chrome (или веб-браузер на основе Chromium), Microsoft Internet Explorer (не ниже 8.0), Microsoft Edge, Mozilla Firefox.

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

ПО для Разработчика

.NET Framework версии не ниже 4.5. Microsoft Visual Studio 2015 или выше.

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

Пакет документов по продукту содержит:

Название	Описание
Руководство администратора	Установка, обновление, удаление продукта и эксплуатация Системы на основе продукта
Руководство разработчика	Разработка Системы на основе продукта
Руководство редактора	Работа с данными в Системе, созданной на основе продукта, в роли Контент-менеджера

Справочник Разработчика Логическая структура QP

Внимание: объекты ветви «Шаблон» являются устаревшими (не рекомендуется использовать для разработки новых Систем; используются для сопровождения Систем, основанных на предыдущих версиях продукта).

Структура QP представляет собой иерархию сущностей:

БД
Пользователь Группа пользователей Сайт
Контент
Поле Статья Архивная статья Уведомление
Виртуальный контент Workflow Статус Шаблон
Объект шаблона
Формат
Страница
Объект страницы
Формат
Пользовательское действие Стиль визуального редактора Плагин визуального редактора

Для обновления структуры иерархии, если были внесены изменения, необходимо вызвать контекстное меню для сайта и нажать на пункт «Обновить».

Примечание: обновление доступно на всех уровнях иерархии. Вызов команды «Обновить» обновляет сущности выбранного уровня.

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

Доступ к бекэнду предоставляется только пользователям, авторизованным в Системе. Управление пользователями осуществляется с использованием:

ГПИ бекэнда (раздел «Пользователи»), Команд контекстного меню в структуре QP: Если контекстное меню вызывается для сущности «Пользователь», то доступна команда создания новой учетной записи пользователя - «Новый пользователь»; Если контекстное меню вызывается для конкретного пользователя сущности «Пользователь», то доступны команды: «Создать по образцу». Команда создает копию учетной записи пользователя. Копия имеет отличный от оригинала логин, к логину добавляется символ «1»; «Удалить». Команда удаляет учетную запись после ее подтверждения; «Свойства». Команда открывает вкладку в ГПИ с настройками учетной записи пользователя. QP8 API (класс Permissions). Свойства пользователя

Параметры входа (Login Parameters)

Название	Описание
Логин (Login)	Уникальный (в пределах БД) идентификатор пользователя. Используется для доступа в бекэнд.
Пароль (Password)	Набор символов, используемый для авторизации пользователя в бекэнде.
NT-логин (NT-login)	Идентификатор пользователя. Используется режимом единой авторизации для привязки пользователя QP к пользователю Windows из AD.
Автоматический вход (Auto Login)	Указатель, что для пользователя включен режим единой авторизации c AD.
Заблокирован (Disabled)	Указатель, что пользователь деактивирован (нет прав на работу в бекэнде)

Данные профиля (Profile data)

Название	Описание
Имя (First Name)	Персональные данные пользователя. Примечание: используются в ГПИ бекэнда при выводе данных, связанных с пользователем (например, данные о последнем изменении сущности пользователем).
Фамилия (Last Name)
E-mail	Адрес электронной почты пользователя.
Язык (Language)	Язык для ГПИ бекэнда. Внимание: ОС на веб-сервере и на компьютере пользователя должны поддерживать выбранный язык.

Членство (Membership)

Название	Описание
Группы (Groups)	Группы пользователей, в которые входит пользователь.

Фильтрация по умолчанию (Default Filters)

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