Skip to content

S
Synergy Showcase
Commit da94acb1 authored by Kristina Markova's avatar Kristina Markova
Browse files
Options

showcase docs

parent 3e7c7950
Hide whitespace changes
Inline Side-by-side
Showing with 465 additions and 128 deletions
install-guide/index.rst
View file @ da94acb1
...@@ -47,8 +47,8 @@ Synergy Showcase устанавливается отдельным пакето ...@@ -47,8 +47,8 @@ Synergy Showcase устанавливается отдельным пакето
.. code-block:: html .. code-block:: html
deb [allow-insecure=yes] http://deb.arta.kz/tengri constructor-1.1 main contrib non-free deb [allow-insecure=yes] http://deb.arta.kz/tengri constructor-1.1 main contrib non-free
deb [allow-insecure=yes] http://deb.arta.kz/tengri showcase-2.0 main contrib non-free deb [allow-insecure=yes] http://deb.arta.kz/tengri showcase-2.0 main contrib non-free
Для установки приложения необходимо выполнить команду: Для установки приложения необходимо выполнить команду:
...@@ -59,40 +59,44 @@ Synergy Showcase устанавливается отдельным пакето ...@@ -59,40 +59,44 @@ Synergy Showcase устанавливается отдельным пакето
В ходе установки необходимо выбрать тип установки из предложенного списка: В ходе установки необходимо выбрать тип установки из предложенного списка:
.. figure:: ../_static/showcase1.png .. figure:: _static/showcase1.png
Дальнейшие шаги зависят от выбранного типа установки.
Вариант установки Clean Вариант установки Clean
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
Указать URL сервера Synergy, на котором производится работа (например: http://192.168.4.218:8080/Synergy)
.. figure:: _static/showcase2.png
В ходе установки необходимо выполнить следующее: Ввести пароль от сервера mysql:
* Выбрать тип установки из предложенного списка .. figure:: _static/showcase2_1.png
.. figure:: resources/img/showcase1.png После этого будет выполнена загрузка дампов БД, содержащих "чистую" конфигурацию Synergy Showcase.
Рис. Тип установки Вариант установки Install/Upgrade configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Указать URL до Synergy, на котором производится работа (например: http://192.168.1.191:8080/Synergy) Указать URL сервера Synergy, на котором производится работа (например: http://192.168.4.218:8080/Synergy)
.. figure:: resources/img/showcase2.png .. figure:: _static/showcase2.png
Рис. Ввод synergy URL Последовательно указать логин и пароль Гостевого пользователя, который будет использоваться для просмотра данных портала:
* Ввести последовательно логин и пароль Системного пользователя .. figure:: _static/showcase3.png
.. figure:: resources/img/showcase3.png .. figure:: _static/showcase4.png
Рис. Ввод логина Последовательно указать логин и пароль пользователя, имеющего роль "Разработчик Synergy":
.. figure:: resources/img/showcase4.png .. figure:: _static/showcase5.png
Рис. Ввод пароля .. figure:: _static/showcase6.png
После установки После установки
--------------- ---------------
После установки приложения обязательно выполнить пункты `инструкции по внедрению <http://rtd.lan.arta.kz/docs/showcase-introduction-guide/ru/v1.0/>`_. После установки приложения обязательно выполнить пункты `инструкции по внедрению <http://rtd.lan.arta.kz/docs/showcase-introduction-guide/ru/v2.0/>`_.
introduction-guide/index.rst
View file @ da94acb1
...@@ -13,7 +13,6 @@ ...@@ -13,7 +13,6 @@
src/first_tuning src/first_tuning
src/new_service src/new_service
src/new_request
src/portal src/portal
Введение Введение
......
introduction-guide/src/first_tuning.rst
View file @ da94acb1
Первоначальная настройка Первоначальная настройка
------------------------ ------------------------
В первую очередь после установки пакета Synergy Showcase следует проверить используемую лицензию ARTA Synergy
(Административное приложение - Обслуживание системы - Информация о лицензии - Максимальное количество
пользовательских лицензий).
Мы рекомендуем использовать лицензию на неограниченное количество пользователей. Поскольку портал Витрины услуг
предполагает возможность самостоятельной регистрации клиентов, при превышении количества доступных лицензий
новые клиенты при попытке регистрации будут получать ошибку.
Инструкция по обновлению лицензии приведена в `документации <http://tdd.lan.arta.kz/docs/synergy/tags/hamming/admin-manual/html/s33.html>`_
Clean Clean
~~~~~ ~~~~~
...@@ -22,6 +32,18 @@ Clean ...@@ -22,6 +32,18 @@ Clean
#. Скопировать этот файл на сервер в папку ``/opt/synergy/jboss/standalone/deployments``. #. Скопировать этот файл на сервер в папку ``/opt/synergy/jboss/standalone/deployments``.
.. hint::
Для копирования файла на сервер по ``ssh`` можно воспользоваться командой ``scp``:
.. code-block:: html
$ scp showcase.war root@192.168.3.120:/opt/synergy/jboss/standalone/deployments
В результате портал Витрины услуг будет доступен по адресу ``http[s]://<host>:<port>/showcase``:
.. figure:: ../_static/showcase3.png
Install/upgrade configuration Install/upgrade configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
...@@ -29,6 +51,9 @@ Install/upgrade configuration ...@@ -29,6 +51,9 @@ Install/upgrade configuration
#. Добавить гостевого пользователя в группу "Клиенты Showcase" ``showcase_clients``. #. Добавить гостевого пользователя в группу "Клиенты Showcase" ``showcase_clients``.
#. Добавить операторов, обрабатывающих заявки на услуги, и контент-менеджеров, настраивающих описание услуг, в группу
"Операторы Showcase" ``showcase_operators``.
#. Добавить ``war`` приложения Showcase на сервер в папку ``/opt/synergy/jboss/standalone/deployments`` (см. алгоритм для **Clean**). #. Добавить ``war`` приложения Showcase на сервер в папку ``/opt/synergy/jboss/standalone/deployments`` (см. алгоритм для **Clean**).
Авторизоваться в Конструкторе приложений можно от имени пользователя с ролью "Конструктор web-клиента". Авторизоваться в Конструкторе приложений можно от имени пользователя с ролью "Конструктор web-клиента".
...@@ -38,32 +63,29 @@ Install/upgrade configuration ...@@ -38,32 +63,29 @@ Install/upgrade configuration
#. Для шаблонов маршрутов ``showcase_templates_status01``, ``showcase_templates_status02`` и ``showcase_templates_status03`` указать #. Для шаблонов маршрутов ``showcase_templates_status01``, ``showcase_templates_status02`` и ``showcase_templates_status03`` указать
ответственного оператора для услуг. ответственного оператора для услуг.
#. В разделе "Настройки платформы" создать новую роль "Просмотр услуг" с #. В разделе "Настройки платформы" - "Хранилище" - "Роли" создать новую роль "Просмотр услуг" с правами:
Manual
~~~~~~
#. Импортировать приложение Showcase из архива ``/opt/synergy/apps/showcase/app-showcase.7zip``. - "Просмотр"
.. hint:: - "Просмотр комментариев"
#. При импорте приложения рекомендуем руководствоваться `документацией`_. - "Просмотр версий документа"
#. Если на сервере уже был установлен продукт, следует сверить номера версий приложения в архиве и на сервере, при необходимости нужно увеличить номер версии в архиве. - "Просмотр свойств документа"
#. Добавить системного пользователя в группу ``Showcase``. - "Просмотр категорий документа"
#. Прописать логин и пароль системного пользователя в настройки скриптов интерпретатора ``event.blocking.interpreter.createContact`` и ``event.form.formdata.change``. - "Просмотр списка ссылок документа"
#. Проверить, что группе пользователей ``Showcase`` предоставлены все права на реестр **"Каталог услуг"**, а также на все реестры заявок. - "Загрузка файла документа"
.. _`документацией`: http://tdd.lan.arta.kz/docs/synergy/tags/hamming/release-notes/html/app_export_import.html#app_import #. В разделе "Настройки платформы" - "Хранилище" - "Папки" создать новую папку "Документы для услуг". Предоставить доступ к этой папке
группам пользователей:
Настройки каталога услуг - "Клиенты Showcase" - роль "Просмотр услуг"
~~~~~~~~~~~~~~~~~~~~~~~~
После установки необходимо в клиентской части создать одну запись в реестре **"Настройки каталога услуг"**, где указывается количество плашек услуг в одной строке при их отображении на портале. - "Операторы Showcase" - роль "Полный доступ"
После этого в Synergy IDE нужно убрать права на создание и удаление записей в этом реестре. #. В этом же разделе "Настройки платформы" - "Хранилище" - "Папки" в папке "Документы для услуг" создать дочернюю папку "Пустая".
introduction-guide/src/new_request.rst deleted 100644 → 0
View file @ 3e7c7950
Добавление новой заявки
------------------------------
Каждой услуге соответствует некоторый реестр заявок. Для разных услуг может использоваться как некоторая типовая форма заявки, так и уникальные формы с собственными реестрами и маршрутами.
Здесь будет рассмотрен случай настройки уникальной формы заявки на услугу.
Справочник статусов заявок
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Для указания статуса любой заявки используется справочник **"Статусы заявок"**. Поля этого справочника регулируют поведение заявки и ее отображение в Личном кабинете портала:
#. Значение ``isEditable=1`` означает, что:
- заявку в этом статусе клиент сможет отредактировать из Личного кабинета. Обычно используется для статусов типа "На доработку" или "Ожидает ответа клиента". Если в поле указано 0, то клиент не редактирует заявку.
- если в заявке заполнены поля ``crm_form_contact_product_file`` или ``crm_form_contact_product_comment``, содержимое этих компонентов будет отображено у пользователя в Личном кабинете.
#. Значение ``isEnd=1`` означает, что, если в заявке заполнены поля ``crm_form_contact_product_file`` или ``crm_form_contact_product_comment``, содержимое этих компонентов будет отображено у пользователя в Личном кабинете. В справочнике должен быть ровно один элемент, у которого в этом поле указано ``0``, для всех остальных нужно указать ``1``.
#. Значение ``isModified=1`` означает, что в этот статус заявка перейдет после того, как клиент из своего Личного кабинета отредактировал заявку и сохранил изменения в ней. Например, может использоваться для перехода из статуса "На доработке" в статус "В работе". В справочнике должен быть ровно один элемент, у которого в этом поле указано ``0``, для всех остальных нужно указать ``1``.
Настройка формы заявки
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
После импорта приложение **Showcase** содержит две типовые формы заявок: "Заявка №1" и "Заявка №2". Для ускорения конфигурирования новой формы заявки можно сделать копию одной из этих форм.
Каждая форма заявки обязательно должна содержать следующие компоненты:
- ``crm_form_contact_product_email``: однострочное поле, обязательное, заполняется e-mail клиента
- ``crm_form_contact_main_fullName`` - однострочное поле, обязательное, заполняется ФИО клиента
- ``crm_form_contact_product_requestID`` - идентификатор заявки. Не допускается совпадение идентификаторов для заявок на разные услуги: нужно использовать либо единый шаблон номера для всех услуг, либо для каждой услуги в шаблоне номера указывать некий префикс, уникальный для этой услуги.
- ``crm_form_contact_product`` - ссылка на реестр "Каталог услуг" ``items``, заполняется ссылкой на выбранную услугу
- ``crm_form_contact_product_date`` - компонент "Дата и время", дата подачи заявки
- ``crm_form_contact_product_status`` - компонент "Выпадающий список", используется справочник "Статусы заявок", содержит текущий статус заявки
- ``crm_form_contact_product_file`` - компонент "Ссылка на файл в Хранилище", может быть приложен файл для обратной связи с клиентом
- ``crm_form_contact_product_comment`` - компонент "Многострочное поле", может быть добавлен комментарий для обратной связи с клиентом
Код формы заявки на услугу должен начинаться с ``showcase_form_request_``.
Настройка реестра заявки
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
После создания формы заявки необходимо создать и настроить реестр для нее:
#. В начало маршрута активации реестра заявки на услугу необходимо добавлять блокирующий процесс ``event.blocking.interpreter.createContact``, иначе поданная заявка не будет добавлена в запись контактов.
#. Все права на реестр необходимо предоставить группе пользователей ``Showcase``.
Созданный реестр нужно указать в сведениях о соответствующей услуге (реестр "Каталог услуг", поле "Ссылка на реестр").
introduction-guide/src/new_service.rst
View file @ da94acb1
Добавление новой услуги Добавление новой услуги
----------------------------- -----------------------
Все услуги, публикуемые на витрине Showcase, настраиваются через реестр **"Каталог услуг"**. Для того, чтобы опубликовать новую услугу, нужно создать в реестре новую запись для нее. Прежде, чем публиковать новую услугу, следует ответить на вопросы:
- Какая форма заявки будет использоваться для услуги - одна из типовых форм, ранее созданных для других услуг,
или с собственным набором полей?
- Будет ли описание услуги сопровождаться документами, которые пользователь может скачать и просмотреть?
В зависимости от ответов на эти вопросы будет отличаться процесс добавления новой услуги:
#. Если услуга требует использования уникальной формы заявки - необходимо создать эту форму и реестр для нее в Synergy IDE.
Если можно использовать уже существующую форму заявки, этот шаг можно пропустить.
#. Если услуга требует приложения некоторого набора документов, которые клиент может просмотреть - необходимо предварительно
создать папку в модуле Хранилище - Файлы. Эта папка должна быть вложена в ранее созданную папку "Документы для услуг", чтобы
права на нее были настроены корректно.
#. В любом случае процедура добавления новой услуги на Витрину услуг завершается созданием новой записи в Каталоге услуг.
.. hint::
По умолчанию приложение **Showcase** содержит типовую форму заявки "Заявка 1" и реестр "Заявки 1". Для ускорения конфигурирования
новой формы заявки можно сделать копию реестра "Заявки 1" - при этом будут созданы копии этого реестра и его формы.
Это позволит сократить время настройки обязательных компонентов формы, маршрута активации и сопоставления данных в реестре.
Создание новой формы заявки
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Каждая форма заявки должна содержать следующие компоненты:
.. table:: Компоненты формы заявки
+---------------------------------+-----------------+----------------------------------------------------+------------------------------+
| Идентификатор | Тип компонента |Свойства компонента | Описание |
+=================================+=================+====================================================+==============================+
| ``item_request_created_date`` | Дата/время | - Формат даты: ``${dd}.${mm}.${yyyy} ${HH}:${MM}`` | Дата и время создания заявки |
| | | - Заблокированное от изменений пользователем | |
| | | - Заполнять текущей датой/временем | |
| | | - Вводить время | |
+---------------------------------+-----------------+----------------------------------------------------+------------------------------+
| ``item_requestID`` | Номер | Выбран шаблон номера ``showcase_request`` | Идентификатор заявки |
+---------------------------------+-----------------+----------------------------------------------------+------------------------------+
| ``item_request_author`` | Объекты Synergy | - Тип данных - "Пользователи" | Автор заявки |
| | | - Заполнять создающим пользователем | |
+---------------------------------+-----------------+----------------------------------------------------+------------------------------+
| ``item_request_status`` | Выпадающий | - Используется справочник "Статусы заявок" | Текущий статус заявки |
| | список | - В качестве значения элемента выбрано поле "Код" | |
+---------------------------------+-----------------+----------------------------------------------------+------------------------------+
| ``item_request_text`` | Многострочный | Вспомогательный текст: "Текст заявки" | Основной текст запроса |
| | текст | | клиента |
+---------------------------------+-----------------+----------------------------------------------------+------------------------------+
| ``item_request_result`` | Многострочный | | Ответ исполнителя заявки |
| | текст | | |
+---------------------------------+-----------------+----------------------------------------------------+------------------------------+
| ``item_request_file_link`` | Файл | | Файл с результатом |
| | | | исполнения заявки (при |
| | | | необходимости) |
+---------------------------------+-----------------+----------------------------------------------------+------------------------------+
| ``item_request_itemName`` | Ссылка на | - Скрытое поле | Услуга, которой |
| | реестр | - Выбранный реестр: "Каталог услуг" | соответствует форма заявки |
| | | - после создания записи услуги в реестре "Каталог | |
| | | услуг" выбрать эту запись в качестве значения | |
| | | поля по умолчанию | |
+---------------------------------+-----------------+----------------------------------------------------+------------------------------+
| ``item_request_global_reglink`` | Ссылка на | - Скрытое поле | Ссылка на сводный реестр |
| | реестр | - Выбранный реестр: "Общий реестр заявок" | всех созданных заявок; |
| | | | заполняется автоматически |
| | | | в процессе активации заявки |
+---------------------------------+-----------------+----------------------------------------------------+------------------------------+
.. note::
Идентификаторы всех компонентов, за исключением ``item_request_global_reglink``, приведены в качестве примера, при
конфигурировании разработчику достаточно следить только за наличием компонентов указанного типа. Однако мы рекомендуем
использовать эти идентификаторы, чтобы упростить процесс настройки сопоставления в общий реестр заявок.
Настройка реестра заявки
~~~~~~~~~~~~~~~~~~~~~~~~
После создания формы заявки необходимо создать и настроить реестр для нее.
Группе пользователей "Операторы Showcase" необходимо предоставить все права на реестр. Группе "Клиенты Showcase" должны быть
предоставлены все права на реестр, кроме права "Удаление":
.. figure:: ../_static/showcase4.png
Сопоставления данных в сводный реестр заявок
""""""""""""""""""""""""""""""""""""""""""""
Основные сведения каждой заявки на услугу копируются в сводный реестр "Общий реестр заявок". Записи этого реестра отображаются
в Личном кабинете клиента. Для того, чтобы Личный кабинет всегда отображал актуальное состояние каждой заявки, поданной клиентом,
необходимо актуализировать данные этого реестра после каждого изменения данных основной заявки.
Актуализация данных выполняется штатным **сопоставлением в реестр**. В реестре заявок на услугу необходимо настроить сопоставление
полей его формы и формы сводного реестра. Пример сопоставления, настроенного для компонентов формы заявки (при условии, что на форме
заявки использованы рекомендованные идентификаторы компонентов):
.. table:: Сопоставление полей
=============================== ================================ ==============================
Поле исходного реестра Поле реестра-приемника Сопоставляемые данные
=============================== ================================ ==============================
``item_request_created_date`` ``item_request_creation_date`` Дата и время создания заявки
``item_request_result`` ``item_request_result`` Ответ исполнителя заявки
``item_request_itemName`` ``item_request_itemName`` Название услуги
``item_request_status`` ``item_request_status`` Текущий статус заявки
``item_requestID`` ``item_requestID`` Идентификатор заявки
``item_request_author`` ``item_request_author`` Автор заявки
=============================== ================================ ==============================
Если в Личном кабинете необходимо отображать другие данные заявок клиента, разработчик Synergy должен:
#. добавить нужные компоненты во все формы заявок;
#. добавить нужные компоненты в общую форму заявок ``item_request_main``;
#. в реестре "Общий реестр заявок" включить отображение новых компонентов формы;
#. для каждого реестра заявок добавить новые компоненты в сопоставление данных.
Вид настроенного сопоставления:
.. figure:: ../_static/showcase5.png
Маршрут реестра
"""""""""""""""
После создания реестра заявок на услугу необходимо настроить его **маршрут активации**. Маршрут каждого реестра должен включать
в себя этапы:
#. блокирующий процесс ``event.blocking.interpreter.createItemDoc``;
#. сопоставление в реестр, идентификатор компонента - ``item_request_global_reglink``;
.. note:: В этапе маршрута "Сопоставление в реестр" в качестве идентификатора компонента должен быть указан компонент формы заявки
типа "Ссылка на реестр", где выбран реестр "Общий реестр заявок".
#. условный переход, код этапа - ``case``, переходы:
.. table:: Переходы
========================= =========== ========== ========================================================
ID Условие Значение Действие
========================= =========== ========== ========================================================
``item_request_status`` Совпадает ``02`` Запустить маршрут по шаблону **Статус "На доработке"**
``item_request_status`` Совпадает ``03`` Запустить маршрут по шаблону **Статус "Завершена"**
Переход по умолчанию Запустить маршрут по шаблону **Статус "В работе"**
========================= =========== ========== ========================================================
.. note:: В каждом переходе в поле **ID** должен быть указан компонент формы заявки типа "Выпадающий список",
где содержится текущий статус заявки.
В качестве значения этого компонента используются коды элементов справочника "Статусы заявок".
#. сопоставление в реестр, идентификатор компонента - ``item_request_global_reglink``;
#. условный переход, переходы:
.. table:: Переходы
========================= ============== ========== ================================
ID Условие Значение Действие
========================= ============== ========== ================================
``item_request_status`` Не совпадает ``03`` Перейти к этапу ``case``
Переход по умолчанию Перейти к этапу ``end_status``
========================= ============== ========== ================================
#. сопоставление в реестр, идентификатор компонента - ``item_request_global_reglink``, код этапа - ``end_status``.
Также следует настроить **маршрут изменения** записи. Этот маршрут состоит из одного этапа: сопоставление в реестр с
идентификатором компонента ``item_request_global_reglink``.
Бизнес-процесс обработки поступившей заявки должен настраиваться не в основном маршруте реестра этих заявок, а в
шаблонах маршрута для каждого из статусов заявки.
Добавление новой папки с документами для услуги
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
В случае, когда описание новой услуги предполагает наличие файлов, которые пользователь может скачать и просмотреть, следует
создать для этих файлов отдельную папку в модуле Хранилище - Файлы:
.. figure:: ../_static/showcase5.png
Папка с документами для услуги должна быть вложена в папку "Документы для услуг".
Добавление новой услуги для отображения на Витрине услуг
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Все услуги, публикуемые на витрине Showcase, настраиваются через реестр **"Каталог услуг"**. Для того, чтобы опубликовать
новую услугу, нужно создать в реестре новую запись для нее.
Сведения об услуге: Сведения об услуге:
- идентификатор - регулирует порядок следования услуг; - идентификатор - регулирует порядок следования услуг;
- название - отображается на плашке услуги и является заголовком на странице услуги; - название - отображается на плашке услуги и является заголовком на странице услуги;
- категория услуги - справочное поле (в текущей версии не используется); - флаг "Добавить на главную" - регулирует, будет ли услуга отображена в слайдере или в виде плашки в основной области
- URL - часть URL страницы услуги (в текущей версии не используется); главной страницы. В текущей версии не используется;
- флаг "Добавить на главную" - регулирует, будет ли услуга отображена в слайдере или в виде плашки в основной области главной страницы. Если флаг включен, услуга будет добавлена в слайдер;
- "Отображается на сайте" - справочное поле, регулирующее публикацию услуги на портале; - "Отображается на сайте" - справочное поле, регулирующее публикацию услуги на портале;
- изображение - изображение, которое будет использовано для услуги на главной странице. Если услуга добавляется в слайдер, рекомендуется использовать широкоформатные изображения с высоким разрешением; - изображение - изображение, которое будет использовано для услуги на главной странице. Рекомендуется использовать
- кнопка в плашке - используется для подписи кнопки перехода из плашки услуги на страницу этой услуги (например, "Подробнее", "Описание" и т.д.); широкоформатные изображения с высоким разрешением;
- кнопка в плашке - используется для подписи кнопки перехода из плашки услуги на страницу этой услуги (например,
"Подробнее", "Описание" и т.д.);
- кнопка в описании - используется для подписи кнопки подачи заявки на услугу (например, "Заказать"); - кнопка в описании - используется для подписи кнопки подачи заявки на услугу (например, "Заказать");
- ссылка на реестр - в выпадающем списке нужно выбрать реестр, который будет использоваться для заявок по этой услуге; - ссылка на реестр - в выпадающем списке нужно выбрать реестр, который будет использоваться для заявок по этой услуге;
- ценность - отображается на плашке услуги и является подзаголовком на странице услуги; - ценность - отображается на плашке услуги и является подзаголовком на странице услуги;
- описание - многострочное поле, в котором указывается подробное описание услуги; - описание - многострочное поле, в котором указывается подробное описание услуги;
- видео - в это поле может быть добавлена ссылка на видео, которое будет отображено на странице услуги; - ключевые слова - однострочное поле, в котором через запятую указываются ключевые слова, по которым пользователи могут
- презентация - текстовое поле, в которое нужно добавить блок ``iframe`` для публикации презентации. Например: найти услугу;
- путь к папке с документами для услуги - однострочное поле, в котором нужно указать путь к папке Хранилища, в которой
.. code-block:: html расположены документы по этой услуге, или путь к пустой папке.
<iframe src="//www.slideshare.net/slideshow/embed_code/key/9hhX1S0j5Ymxqw" width="100%" height="650px" frameborder="0" marginwidth="0" marginheight="0" scrolling="no" style="border:1px solid #CCC; border-width:1px; margin-bottom:5px; max-width: 100%;" allowfullscreen> </iframe>
.. note:: Если для услуги одновременно добавлены и видео, и презентация, то на странице этой услуги на портале будет отображено только видео.
.. hint:: Для получения кода для встраивания презентации можно воспрользоваться сервисом `Slideshare <http://www.slideshare.net>`_
- таблица "Документы", в которой нужно выбрать файл из Хранилища и указать название этого файла. Выбранные документы будут отображены на странице услуги в разделе "Материалы". .. important:: После создания новой записи в Каталоге услуг не забудьте вернуться к конфигурированию формы заявки на
эту услугу и указать созданную запись в поле ``item_request_itemName``.
После создания/редактирования записи реестра услуга будет сразу добавлена/изменена на портале. После создания/редактирования записи реестра услуга будет сразу добавлена/изменена на портале.
introduction-guide/src/portal.rst
View file @ da94acb1
Настройка внешнего вида и адреса витрины Настройка Витрины услуг
------------------------------------------ -----------------------
По умолчанию витрина доступна по адресу ``<host>:<port>/portal``. Для настройки веб-клиента Витрины услуг используется специальный инструмент - **Конструктор приложений**. Вся кастомизация
этого клиента выполняется в Конструкторе, доступном по адресу ``<host>:<port>/constructor``.
URL витрины регулируется именем соответствующего файла ``war`` в папке ``/opt/synergy/jboss/standalone/deployments``. Авторизация в Конструкторе должна быть выполнена с логином и паролем пользователя, имеющего роль "Конструктор web-клиента"
Для изменения URL необходимо: (см. раздел "Первоначальная настройка").
- указать новое имя для файла ``portal.war`` Вид клиента "Витрина услуг" в Конструкторе:
- в конфигурации nginx ``/etc/nginx/sites-enabled/synergy-base`` изменить ``location`` для портала. Пример настройки для нового имени **Showcase**:
.. code-block:: xml .. figure:: ../_static/constructor1.png
location /Showcase { В этом разделе всюду предполагается, что действия по настройке веб-клиента выполняются в интерфейсе Конструктора.
allow all;
proxy_pass http://127.0.0.1:8080/Showcase;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
}
Главная страница URL Витрины услуг
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
По умолчанию витрина доступна по адресу ``<host>:<port>/showcase``.
Для того, чтобы изменить URL веб-клиента, нужно:
#. в панели меню выбрать Клиент - Свойства;
#. в диалоге в поле "URL клиента" ввести нужный URL, сохранить изменения;
#. в панели меню нажать на кнопку **WAR**; на локальный компьютер будет скачан файл с именем ``<url>.war``;
#. добавить этот файл на сервер в папку ``/opt/synergy/jboss/standalone/deployments``.
.. hint::
Для копирования файла на сервер по ``ssh`` можно воспользоваться командой ``scp``:
.. code-block:: html
$ scp <url>.war root@<host>:/opt/synergy/jboss/standalone/deployments
Расположение плашек на Главной странице
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Главная страница витрины содержит настроенные услуги из Каталога услуг. Здесь отображаются только те услуги, в которых Главная страница витрины содержит настроенные услуги из Каталога услуг. Здесь отображаются только те услуги, в которых
было выбрано значение "Отображать на сайте". было выбрано значение "Отображать на сайте".
Главная страница состоит из двух основных блоков: **слайдера** и области **плашек услуг**. Слайдер содержит только те Все опубликованные услуги отображаются в виде **плашек**, содержащих картинку услуги, ее название, ценность и кнопку
услуги, для которых включен флаг "Отображать на главной", остальные услуги отображаются в виде плашек. перехода к странице услуги.
По умолчанию плашки располагаются по три в ряд. Для того, чтобы увеличить или уменьшить размеры плашек, нужно:
#. в навигаторе страниц слева открыть страницу "Список услуг", кликнув по иконке |open_page|:
.. figure:: ../_static/constructor2.png
#. мышкой выделить компонент плашки с кодом ``items`` (код компонента указан в блоке "Свойства" в правой части):
.. figure:: ../_static/constructor3.png
#. в свойстве выделенного компонента "Ширина" указать необходимую ширину **одной** плашки (в процентах или в пикселях):
.. figure:: ../_static/constructor4.png
.. hint:: Свойство компонента "Ширина", указанное в процентах, означает, какую часть ширины родительской панели
может занять текущий компонент. Компоненты плашек располагаются горизонтально слева направо, пока очередная
плашка помещается в строку, далее происходит перенос на следующую строку. Таким образом, регулируя ширину
одной плашки, можно настроить, сколько плашек может поместиться в одну строку: например, при ширине 51-100%
в каждой строке будет только одна плашка, а при ширине 21-25% - по четыре плашки ряд.
#. при необходимости изменить высоту плашек (по умолчанию внутри компонента ``items`` расположена дочерняя панель ``panel-2``,
где указана высота ``400px``):
Для каждой услуги отображается ее картинка, название, ценность и кнопка перехода к странице услуги. .. figure:: ../_static/constructor5.png
#. проверить, как будет выглядеть Витрина услуг после внесенных изменений, выключив "Режим конструктора" на верхней панели:
.. figure:: ../_static/constructor6.png
.. hint:: Здесь для компонента ``items`` указана ширина 80% - плашки услуг расположены по одной в строке.
#. снова включить "Режим конструктора", далее сохранить изменения в веб-клиенте, нажав на кнопку сохранения в правом верхнем углу.
Внесенные изменения будут отображены в собранном приложении ``<host>:<port>/<URL>`` сразу после сохранения клиента в
Конструкторе, повторная сборка приложения не требуется.
.. |open_page| image:: ../_static/open_page.png
Страница услуги Страница услуги
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
В общем случае страница услуги состоит из следующих блоков: В общем случае страница услуги состоит из следующих блоков:
#. Название услуги #. Название услуги
#. Ценность #. Ценность
#. Видео или презентация, если он добавлены для услуги #. Картинка услуги
.. note:: Если для услуги добавлены одновременно и ссылка, и презентация, то на странице услуги будет отображено только видео.
#. Описание услуги #. Описание услуги
#. Материалы #. Файлы, содержащиеся в папке с документами услуги
#. Кнопка подачи заявки #. Кнопка подачи заявки
Все эти сведения настраиваются отдельно для каждой услуги в реестре "Каталог услуг" (см. раздел "Добавление новой услуги"). Конструктор позволяет изменить порядок следования этих разделов, их внешний вид (например, размер картинки или начертание
надписи с ценностью услуги).
Сделать это можно, изменяя свойства компонентов на странице "Паспорт услуги". Для этого:
#. в навигаторе страниц слева открыть страницу "Паспорт услуги", кликнув по иконке |open_page|:
.. figure:: ../_static/constructor7.png
#. на странице выделить мышкой компонент, который нужно изменить:
.. figure:: ../_static/constructor8.png
.. hint:: Когда разработчик выделяет один из компонентов на странице, в правой части отображается раздел "Свойства".
Каждому типу компонента - например, надписи, изображению или кнопке - соответствует собственный набор свойств.
В примере на скрине видны свойства выделенного компонента "Надпись", в частности:
- стиль: выбран стиль "Подзаголовок 1"
- начертание: курсив, подчеркнутый, зачеркнутый
- является ли надпись многострочной, т.е. требуются ли переносы строк по словам
Этот же раздел позволяет перемещать компонент по странице или удалить его. Для этого используются кнопки в верхней
части раздела.
#. изменить свойства выделенного компонента:
.. figure:: ../_static/constructor9.png
С помощью свойств компонента текст с ценностью услуги теперь отображается курсивом.
#. если требуется переместить компонент на странице - с помощью кнопок |up| и |down| перенести выделенный компонент внутри
его панели (например, ниже картинки услуги):
.. figure:: ../_static/constructor10.png
Теперь ценность услуги отображается после ее картинки.
.. hint:: Если панель, на которой расположен компонент, ориентирована по горизонтали (т.е. в свойствах компонента-панели
указано "Горизонтальная"), то вместо кнопок |up| и |down| могут быть использованы кнопки перемещения влево и вправо.
Они применяются таким же образом, как и перемещение вверх и вниз.
.. hint:: Другой способ переместить компонент - вырезать его кнопкой |cut|, потом выделить целевую панель и вставить в нее
кнопкой |paste|.
.. |up| image:: ../_static/up.png
.. |down| image:: ../_static/down.png
.. |cut| image:: ../_static/cut.png
.. |paste| image:: ../_static/paste.png
Стили Витрины услуг
~~~~~~~~~~~~~~~~~~~
При внедрении Synergy Showcase может возникнуть потребность изменить стиль приложения - в частности, цвета и шрифты - на те,
которые используются в организации.
Централизованно это можно сделать в **ресурсах** Конструктора, используя стандартные возможности CSS. Для этого:
#. в свойствах компонентов, требующих доработки стиля, задать название CSS-классов для них (можно указать несколько классов через пробел):
.. figure:: ../_static/constructor11.png
Например, по умолчанию для компонента плашек услуг используются классы ``card`` и ``adaptive``.
#. в разделе "Ресурсы" (левая часть рабочей области Конструктора, ниже разделов "Страницы" и "Компоненты") открыть элемент
``showCaseKmtlcKz.css``, нажав на иконку |open_page|:
.. figure:: ../_static/style1.png
В этом файле собраны стили всех компонентов Витрины услуг.
#. изменить стили существующего класса или добавить описание нового класса:
.. figure:: ../_static/style2.png
Выделено описание класса ``card``, указанного в свойствах компонента плашки услуги.
.. hint:: Пример определения классов в ресурсах CSS:
.. code-block:: css
*{
font-family: 'Lora', serif;
}
.text-style{
color: #002d37;
}
.contur{
background: none;
}
.primary{
border: 1px solid #002d37;
color: #002d37;
}
.secondary{
border: 1px solid #037690;
color: #037690;
}
.primary:hover{
background:#002d37;
color: #fff;
}
.secondary:hover{
background:#037690;
color: #fff;
}
.card {
border: 2px solid rgb(3, 118, 144);
margin:5px;
}
.auth-card {
box-shadow: 0px 0px 15px rgba(0,0,0,.2);
border-radius: 5px;
overflow: hidden;
margin-top: 20px;
padding: 10px;
}
#. сохранить изменения в веб-клиенте, нажав на кнопку сохранения в правом верхнем углу
#. скачать ``WAR`` приложения и разместить его на сервере (см. инструкцию в разделе "URL Витрины услуг").
.. attention:: Изменения в файлах ресурсов приложения - в его стилях или скриптах ``js`` применяются только после повторной
сборки приложения.
Если необходимо изменить внешний вид компонента точечно, без применения классов CSS и без пересборки приложения, можно
добавить описание CSS в свойствах компонента, поле "Стили":
.. figure:: ../_static/style3.png
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment