Пользовательская документация СЭГО

Пользовательская документация СЭГО

Введение

Программа «Система электронных голосований и опросов» (далее СЭГО) предоставляет возможность организациям проводить голосования и опросы пользователей путем размещения в сети веб-сайта, публикации на этом сайте голосований, регистрации пользователей и подтверждения их уникальности, учет ответов пользователей на вопросы голосования, и публикации итогов голосований и решения, принятого организацией-инициатором голосования по его итогам. Главным потребителем СЭГО нами представляются муниципалитеты городов.

СЭГО – сервер-сателлит платформы «Экзарх» (далее, «Экзарх»). Каждый экземпляр СЭГО разворачивается в облаке Оператора платформы «Экзарх» для организации-заказчика на мощностях Оператора. Платформа «Экзарх» используется для авторизации и верификации пользователей, хранения информации профиля пользователей, и в качестве пользовательского интерфейса для системы управления материалами сайта.

Для работы с программой СЭГО не требуется установка дополнительного обеспечения. На рабочем месте необходима операционная система с графической оболочкой, доступ в Интернет и один из поддерживаемых браузеров:

Internet Explorer 10 или новее Edge 14 или новее Chrome 16 или новее Firefox 24 или новее Opera 46 или новее Safari 7 или новее Yandex. Браузер 17 или новее

Как правило, один из этих браузеров предустанавливается с операционной системой компьютера.

Пользователи СЭГО участвуют в голосованиях посредством веб-сайта, зарегистрированного за доменом, согласованным с организацией-заказчиком СЭГО. Редактор СЭГО или редакторы СЭГО – должностные лица организации-заказчика, осуществляющие управление СЭГО и наполнение его голосованиями и другими материалами. Редакторы СЭГО управляют СЭГО с помощью системы управления материалами СЭГО в веб-интерфейсе платформы «Экзарх».

Редактором СЭГО может быть:

руководитель организации; доверенный администратор организации; должность с правами «редактор СЭГО».

Система управления материалами СЭГО

Материалом, мы называем тексты, изображения, вопросы голосований и варианты ответов, сгруппированные в страницы, отображаемые на сайте голосований.

Чтобы управлять материалами, редактор должен открыть систему управления материалами СЭГО, далее СУМ СЭГО,  в веб-интерфейсе платформы «Экзарх». Она мало отличается от других систем управления материалами и ее использование тривиально для любого веб-мастера.

Начало работы редактора СЭГО

Для начала работы необходимо в браузере открыть веб-интерфейс «Экзарх». Для этого надо ввести в строку адреса одно их приведенных ниже доменных имен-синонимов:

экзарх. рф exarh. ru

В форме авторизации, войти в «Экзарх» пользователем, на которого была назначена должность с доступом к СЭГО. В статусной панели, в переключателе должности, выбрать должность с доступом к СЭГО. Затем, в главном меню выберите инструмент «Голосования».

Платформа «Экзарх», помимо инструментов управления материалами сайта голосования, содержит множество других инструментов, таких как служебная почта и справочник структуры организации. В рамках этой документации, мы рассматриваем только СУМ СЭГО. За более подробной документаций по платформе «Экзарх» зайдите на страницу: …

Общие элементы интерфейса

Основные элементы интерфейса СУМ СЭГО являются набор вкладок подразделов системы управления, панель фильтров и переключатель страниц.

Все вкладки подразделов СУМ, построены по одному принципу. На первом уровне, как правило, они отображают материалы в виде таблицы с панелью фильтров и переключателем страниц. Если заголовок столбца таблицы подсвечен белым, то нажатие на заголовок столбца в таблице включает сортировку по этому полю, повторное нажатие  включает сортировку в обратном направлении.

Клик по одному из материалов открывает второй уровень отображения, где можно управлять конкретным материалом. Нюансы работы с каждым из типов материалов описаны ниже.

В каждой вкладке из подразделов так же имеется кнопка для добавления материала, которому посвящен подраздел.

Словари, словарные значения

Словари – вспомогательная сущность СЭГО, которая используется для хранения простых срочных значений (так называемых словарных значений или терминов), таких как категории новостей, или поощрений в магазине.

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

На настоящий момент в СЭГО введены следующие словари:

Статусы материалов – статусы материалов, которые отображаются в выпадающем меню формы редактирования материалов.

Статусы голосований - содержит статусы голосований, которые отображаются в выпадающем меню поля «Статус голосования» формы редактирования материала голосования.

Категории новостей – содержит список возможных категорий новостей, которые отображаются в выпадающем меню формы редактирования материала новости.

Теги голосований – содержит возможные теги материала голосований, добавляемые в текстовое поле с подсказкой «Теги» в форме редактирования материала голосования.

Единицы измерения – содержит возможные единицы измерения в описании материала поощрения.

Категории товаров – содержит возможные категории товаров в описании материала поощрения.

Обычно, редактору СЭГО нет необходимости добавлять или редактировать словарные значения в таких словарях, как: Статусы материалов, Статусы голосований.

Список терминов выбранного словаря отображается таблицей. Для редактирования термина, необходимо щелкнуть мышью по строке таблицы. У термина словаря следующие свойства:

Имя – строка; имя термина и его основное свойство. В большинстве словарей заполняется только это свойство.

Полное имя – строка; имя термина без аббревиатур. Заполнять не обязательное, если полное имя не заполнено, то используется содержимое поля «Имя».

Описание – необязательное текстовое поле с описанием термина.

Управление материалами (общее)

На настоящий момент в СЭГО разработано множество разных типов материалов  сайта, управление которыми сгруппировано по разным вкладкам  СУМ СЭГО.

Тип материала	Вкладка
страницы, новости, голосования	Материалы
поощрения	Магазин
сертификаты	Сертификаты

Основные свойства материалов, базовый материал - страница

Все материалы имеют свойства (поля для ввода данных) общие для всех видов материалов. Страница – самый базовый вид материала, который имеет только эти, общие для всех материалов, свойства. Новую страницу можно создать из подраздела «Материалы» нажатием на кнопку «Добавить материал» и выбором в новой форме в выпадающем меню «Тип материала» тип «Страница» (он выбран по умолчанию).

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

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

Тип материала. Находится в группе «Характеристики публикации». Выпадающее меню, с помощью которого можно управлять типом материала.

Статус материала. Находится в группе «Характеристики публикации». Черновик, или опубликованный материал. Определяет, отображается ли материал на сайте, или нет.

Миниатюра. Изображение, ассоциированное с материалом.

Название материала. Заголовок материала, так же заголовок вкладки браузера с открытым материалом на странице.

Описание. Содержимое материала, отображающееся на странице. Может содержать форматирование, изображения, ссылки.

Анонс. Короткое описание материала, которое отображается в списках и виджетах на сайте голосования. Если анонс материала не заполняется, то анонс будет сформирован из описания материала. Анонс не может содержать изображения, какое-либо форматирование или ссылки.

Приложенные файлы. К материалу можно приложить файлы. Они будут бесконечно храниться на сервере СЭГО. По умолчанию, приложенные файлы никак не отображаются в материале. Чтобы приложить их к материалу, необходимо нажать на кнопку со скрепкой. Файлы будут вставлены в описание материала, в текущую позицию курсора. Если вставляемый файл – изображение, то он будет вставлен, как изображение, иначе, будет вставлен как обычная ссылка.

Группа «Метаданные». В ней находятся поля, с которыми работают CEO-специалисты. Для материала можно указать ключевые слова и мета-описание, которые не отображаются на странице браузера, но используются для лучшей индексации поисковыми машинами сайта. 

Шаблон страницы. Находится в группе «Системные настройки». Индивидуальная настройка (кастомизация) СЭГО для конкретной организации может содержать специфические шаблоны веб-страниц, отличающиеся от стандартных. С помощью этой опции, эти шаблоны можно включить. Если кастомизация СЭГО имеет дополнительные шаблоны, то редакторы снабжаются дополнительными инструкциями по использованию этих настроек.

Статическая ссылка. Находится в группе «Системные настройки». Для любого материала можно указать статическую ссылку вида http://=0720=85-4>. Это бывает полезно для размещения дополнительных пунктов меню, при публикации баннеров и тому подобное.

Новость

Новую новость можно создать из подраздела «Материалы» нажатием на кнопку «Добавить материал» и выбором в новой форме в выпадающем меню «Тип материала» тип «новость». В момент выбора, форма создания материала изменит свой внешний вид.

Новость от страницы отличается тем, что опубликованные новости автоматически отображаются в разделе «Новости» сайта и в блоке «Последние новости» на главной странице авторизованного и неавторизованного пользователя. Так же у новости, в блоке «Характеристики публикации» есть свойство «Категория», по умолчанию пустое, где можно указать категорию новости. Если категория указана, то новость публикуется не только в разделе «Новости», но и в отдельной категории, которая может быть привязана к меню/подменю сайта.

Голосование

Новое голосование можно создать из подраздела «Материалы» нажатием на кнопку «Добавить материал» и выбором в новой форме в выпадающем меню «Тип материала» тип «голосование». В момент выбора, форма создания материала изменит свой внешний вид.

Добавится новая группа настроек «Настройки голосований», которая содержит:

Начало голосования. Дата начала голосования может не совпадать с датой публикации материала. Если материал опубликован, но дата начала голосования стоит позже, то голосование отображается на сайте СЭГО, но пользователи могут только просматривать его, сервер начнет принимать ответы голосования, начиная с  0 часов даты голосования.

Конец голосования. Пользователи могут отвечать на ответы голосования до даты окончания голосования до полуночи дня, указанного как конец голосования. Т. е. указывается последний день включительно.

Статус голосования. Выпадающий список. Действующее голосование – голосование в котором пользователь может отвечать на вопросы голосования. Завершенное голосование – голосование, отображающее статистику пользователей.

Режим отображения статистики. Выпадающее меню. В зависимости от предпочтений организации-инициатора голосования, статистика может отображаться пользователям сразу после голосования, после завершения голосования, или не отображаться.

Теги. Текстовое поле с подсказкой, куда вводятся теги голосования. Теги подробно описаны в ….

Поощрения

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

Поощрения состоят из двух независимых подсистем: подсистемы нематериальных поощрений и подсистемы материальных поощрений. В процессе кастомизации СЭГО под нужны заказчика, одна из этих подсистем, или обе, могут быть выключены.

Подсистема нематериальных поощрений

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

Рейтинги пользователей можно использовать для построения рейтинговых таблиц, а достижения красиво отображаются в профиле. Это добавляет элемент игры и развлечения сайту СЭГО и делает времяпровождение на сайте более интересным. Рейтинги пользователей можно использовать для организации мероприятий, розыгрышей призов и решения других задач.

Так, многие достижения сами по себе помогают отобрать пользователей по каким-либо параметрам, например, отобрать пользователей которые несколько лет пользуются СЭГО, участвовали в большом количестве голосований, участвовали в большом количестве голосований на определенную тему и так далее.

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

В зависимости от предпочтений заказчика СЭГО, зарабатываемый пользователем рейтинг а так же включенные достижения могут быть модифицированы и не соответствовать приведенным в этой документации.

Действия пользователя, которые  влияют на рейтинг

Действие	Зарабатываемый рейтинг
Посещение сайта (засчитывается один раз в день, где день – промежуток времени от 00:00 до 24:00)	10-50 (зарабатываемый рейтинг растет в арифметической прогрессии по количеству дней посещения сайта подряд, вплоть до достижения максимума в 50)
Участие в голосовании	20
Заработанное достижение	зависит от достижения

Предусмотренные достижения

Достижение	Рейтинг	Условие достижения и описание
Активный участник	0	Формальное достижение, которое не увеличивает рейтинг. Открывается по достижению 5000 очков рейтинга и позволяет покупать поощрения за баллы в магазине поощрений (см. Подсистема материальных достижений)
Выбор сделан!	50	За первое успешное голосование. Это достижение призвано познакомить пользователя с системой нематериальных поощрений и объяснить что это такое.
Первые шаги	100	Выдается за участие в 10 голосованиях.
Опытный участник	1000	Выдается за участие в 100 голосованиях.
Ветеран	5000	Выдается за участие в 500 голосованиях.
Бережливый	1500	Выдается за накопление 5000 баллов.
Скрудж	3000	Выдается за накопление 15000 баллов.
За помощь проекту	1000	Выдается редактором СЭГО
за участие в мероприятии	1000	Выдается редактором СЭГО
Сова	1000	Выдается, если пользователь заходил на сайт в период с 00.00 – 05.00 более 10 раз в течение месяца.
Жаворонок	1000	Выдается, если пользователь заходил на сайт в период с 05.00 – 08.00 более 10 раз в течение месяца.
С возвращением	1000	Выдается если пользователь заходит на сайт после перерыва в 30 дней или более. Призвано поощрить пользователя остаться на сайте и изучить что новенького появилось за время отстутствия.
Активист месяца	500	Многоразовое достижение, которое выдается пользователю, который участвовал в более чем 50% голосований месяца.
Активист года	1500	Многоразовое достижение, которое выдается пользователю, который участвовал в более чем  50% голосований года.
Завсегдатай месяца	500	Многоразовое достижение. Выдается пользователю по окончанию месяца, если он посещал сайт каждый день в течении него.
Завсегдатай года	3000	Многоразовое достижение. Выдается пользователю по окончанию года, если он посещал сайт каждый день в течении него.
Юбилей	500	Выдается каждый год с момента регистрации на сайте.
Разносторонний	500	Выдается пользователю, который добавил более 10 тегов в свои интересы

Начисление достижений вручную

Некоторые достижения, а именно медали «За помощь Проекту» и «За участие в мероприятии», выдаются вручную редактором СЭГО через интерфейс СУМ СЭГО.

Для того чтобы начислить одно из этих достижений, необходимо перейти во вкладку «Начисления» и нажать «Добавить достижение». В открывшейся форме ввести UID пользователя, выбрать из выпадающего меню достижение и ввести комментарий.

Подсистема материальных поощрений

Если подсистема материальных поощрений включена, то, голосуя, пользователи накапливают баллы, которые можно обменять на разнообразные поощрения в разделе «Поощрения» сайта СЭГО.

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

       В магазине поощрений различаются два вида поощрений: сувениры и услуги.  К услугам относятся возможные услуги, которые предлагает сайт СЭГО, например, билеты в театр, музей или уроки танцев. Различие между ними – это единицы измерения этих сувениров (штуки или, скажем, билеты) и использование поля «Окончание брони», так как некоторые услуги действуют ограниченное время по договоренностям с партнерами. Так же сувениры должны физически храниться на каком-либо складе или пункте выдачи, куда будут приходить пользователи сайта СЭГО с сертификатами.

Ответственные лица, осуществляющие управление складом сувениров и обмен сертификатов на поощрения, должны иметь должностные кабинеты в организации, владеющей СЭГО, и быть редакторами сайта голосований.

Логика работы и бизнес-процессы

Редактор СЭГО добавляет поощрения в магазин.

Пользователь накапливает 20 баллов в награду за каждое голосование. По достижению 5000 баллов, он зарабатывает достижение «Активный участник» и может тратить свои баллы в разделе «Поощрения» сайта СЭГО.

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

Для обмена подарочного сертификата на подарок, Участник должен предъявить подарочный сертификат ответственному лицу в пункте обмена, согласно условиям, описанным в поощрении и продублированном на сертификате. Участник должен произвести обмен в срок 14 дней, если в описании поощрения не оговорены другие сроки. По достижению этого срока, статус сертификата автоматически меняется на «просроченный» и обмен его на подарок не производится.

Ответственное лицо, используя веб-интерфейс СУМ СЭГО, проверяет код, указанный на сертификате, убеждается в том, что сертификат действующий, отмечает в СУМ, что произошла выдача подарка, и выдает его.

Добавление материальных поощрений, используя СУМ

Работа с поощрениями осуществляется через СУМ, вкладку «Магазин».

Добавление поощрений выполняется в два этапа:

Добавление описания поощрения. Добавление нескольких единиц поощрения на склад.

На сайте СЭГО, поощрения отображаются, только если материал поощрения опубликован, и есть хотя бы одна не свободная единица поощрения.

Описание поощрения – дополнительный вид материала СЭГО и обладает всеми свойствами страницы сайта.

Для добавления описания поощрения, в СУМ перейти во вкладку «Магазин» и нажать кнопку «Добавить товар».

Материал поощрения имеет следующие свойства, отличные от страницы:

Стоимость. Группа «Характеристики товара». Стоимость товара в баллах.

Окончание брони. Находится в группе «Характеристики товара». Материал товара будет автоматически скрыт из отображения на сайте по достижению даты окончания брони.

Единицы измерения. Группа  «Характеристики товара». Словарное значение, привязанное к словарю «Единицы измерения». Определяет в чем измеряется единица поощрения, например: билет, 2 билета, штука и т. п.

Категории.  Группа «Характеристики товара». Текстовое поле с подстановкой, привязанное к словарю «Категории товаров». Управляет тем, в какой категории отображается поощрение. Поощрение может отображаться более чем в одной категории одновременно.

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

После того, как описание поощрения добавлено на сайт СЭГО, необходимо добавить единицы этого поощрения на склад.  Для этого, на странице редактирования материала товара, необходимо ввести число в поле перед кнопкой «Принять товар» и нажать соответствующую кнопку. При совершении этих действий, создается операция с товаром, должность, выполняющая операцию, будет указана ответственным лицом в истории операций.

Списание поощрений

Иногда возникает необходимость списать все или некоторое количество единиц поощрений со склада. Чтобы списать поощрение, в материале поощрения, , в текстовое поле перед кнопкой «Списать товар» нужно указать число, не превышающее остаток поощрений на складе и нажать соответствующую кнопку. При совершении этих действий, создается операция с товаром, должность, выполняющая операцию, будет указана ответственным лицом в истории операций.

Невозможно списать товар, который находится в резерве, так как ожидается, что за ним придет пользователь с сертификатом. Чтобы списать этот зарезервированный товар, необходимо прежде принудительно аннулировать сертификат, выданный пользователю, чтобы товар из резерва перешел в остаток. Процедура аннулирования сертификата описана ниже.

Поиск и просмотр подарочных сертификатов

Работа с сертификатами осуществляется во вкладке «Сертификаты» СУМ, где сертификаты отображаются таблицей. Клик по ряду таблицы открывает форму просмотра и редактирования выбранного сертификата.

Свойства сертификата

Сертификат является одним из материалов сайта СЭГО, пользователь, владеющий сертификатом, получает ссылку,  с помощью которой, может открыть страницу сертификата на сайте СЭГО.

Он обладает следующими свойствами:

Код сертификата. Уникальный цифровой код, печатаемый на сертификате.

Дата создания. Дата выдачи сертификата пользователю.

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

Стоимость. Стоимость в баллах выданного поощрения.

Единицы измерения.  Словарное значение, привязанное к словарю «Единицы измерения». Поле определяет в чем измеряется единица поощрения, например: билет, 2 билета, штука и т. п.

Статус сертификата. Статус сертификата может принимать значения: непогашенный, погашенный, просроченный. В момент выдачи сертификата пользователю, по умолчанию, сертификат получит статус «непогашенный». Если пользователь не обменяет сертификат на поощрение до даты истечения, то статус сертификата автоматически поменяется на «просроченный». В процессе выдачи сертификата пользователю, статус сертификата меняется на «выданный».

ID пользователя. Экзарх-адрес пользователя.

ID товара. ID материала описания товара. Если материал найден, то сразу после текстового поля отобразится ссылка на найденный товар.

Описание.  Описание сертификата отображается на печатаемом сертификате и на его странице. При автоматической генерации сертификата, в это поле будет скопировано описание материала товара.

Выдача поощрений по сертификату

Для выдачи поощрения по сертификату, войти во вкладку «Сертификаты» СУМ СЭГО, ввести код сертификата в поле поиска, открыть найденный сертификат и нажать кнопку «Выдать товар по сертификату». Статус сертификата изменится на «Погашенный».  Единица товара спишется со склада. Соответствующие операции и ответственная должность будут записаны в истории операций товара и в начислениях пользователя.

Создание сертификата вручную

Обычным образом пользователь получает сертификат, обменивая его на баллы, на сайте СЭГО. В некоторых случаях, например для организации конкурсов на мероприятиях, акциях, редактору СЭГО необходимо принудительно выдать сертификат пользователю.

Для создания сертификата в СУМ перейти во вкладку «Сертификаты» и нажать «Создать сертификат» и заполнить поля.

Просмотр истории операций с поощрением

В СУМ СЭГО перейти во вкладку «Магазин», нажатием на ряд таблицы перейти к редактированию поощрения, перейти во вкладку «История операций».

Здесь в табличном виде отображается дата операции, ID операции (служебное поле), описание операции, изменение состояния склада и резерва и ответственная должность.