Commit 0ce722b8 authored by Kristina Markova's avatar Kristina Markova

showcase инструкция по внедрению - релизная ветка

parent be6c310e
......@@ -19,7 +19,7 @@
Введение
-------------
Продукт **ARTA Showcase** предоставляет витрину с ассортиментом услуг со следующими ключевыми возможностями:
Продукт **Synergy Showcase** предоставляет витрину с ассортиментом услуг со следующими ключевыми возможностями:
* просмотр каталога услуг с детальным описанием каждой услуги;
* оформление и регистрация заявки на услугу с маршрутизацией до исполнителя;
......
Первоначальная настройка
-----------------------------
текст
После установки продукта Showcase необходимо создать гостевого пользователя **Showcase**, от имени которого будут выполняться запросы данных для витрины.
Логин и пароль этого пользователя нужно прописать в файле ``/opt/synergy/jboss/standalone/deployments/deployments/portal.war/js/init.js``:
.. code-block:: js
var SYNERGY_ACCESS_LOGIN = 'showcase_login';
var SYNERGY_ACCESS_PASS = 'showcase_password';
Также необходимо проверить, что в файле ``/etc/nginx/sites-enabled/synergy-base`` настроен доступ к порталу:
.. code-block:: xml
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;
}
Install/upgrade configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#. Добавить гостевого пользователя в группу ``Showcase``. Этой группе должны быть предоставлены все права на все реестры продукта.
#. Прописать логин и пароль гостевого пользователя в настройки скриптов интерпретатора ``event.blocking.interpreter.createContact`` и ``event.form.formdata.change``.
Manual
~~~~~~~~~~~~~~~~
#. Импортировать `приложение Showcase`_.
.. hint::
#. При импорте приложения рекомендуем руководствоваться `документацией`_.
#. Если на сервере уже был установлен продукт, следует сверить номера версий приложения в архиве и на сервере, при необходимости нужно увеличить номер версии в архиве.
#. Добавить гостевого пользователя в группу ``Showcase``.
#. Прописать логин и пароль гостевого пользователя в настройки скриптов интерпретатора ``event.blocking.interpreter.createContact`` и ``event.form.formdata.change``.
.. _`приложение Showcase`: _static/app-showcase.7zip
.. _`документацией`: http://tdd.lan.arta.kz/docs/synergy/tags/hamming/release-notes/html/app_export_import.html#app_import
#. Проверить, что группе пользователей ``Showcase`` предоставлены все права на реестр **"Каталог услуг"**, а также на все реестры заявок.
Настройки каталога услуг
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
После установки необходимо в клиентской части создать одну запись в реестре **"Настройки каталога услуг"**, где указывается количество плашек услуг в одной строке при их отображении на портале.
После этого в Synergy IDE нужно убрать права на создание и удаление записей в этом реестре.
Добавление новой заявки
------------------------------
текст тест
\ No newline at end of file
Каждой услуге соответствует некоторый реестр заявок. Для разных услуг может использоваться как некоторая типовая форма заявки, так и уникальные формы с собственными реестрами и маршрутами.
Здесь будет рассмотрен случай настройки уникальной формы заявки на услугу.
Справочник статусов заявок
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Для указания статуса любой заявки используется справочник **"Статусы заявок"**. Поля этого справочника регулируют поведение заявки и ее отображение в Личном кабинете портала:
#. Значение ``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". Для ускорения конфигурирования новой формы заявки можно сделать копию одной из этих форм.
Каждая форма заявки обязательно должна содержать следующие компоненты:
- ``nav-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``.
Созданный реестр нужно указать в сведениях о соответствующей услуге (реестр "Каталог услуг", поле "Ссылка на реестр").
Добавление новой услуги
-----------------------------
текст
Все услуги, публикуемые на витрине 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>`_
- таблица "Документы", в которой нужно выбрать файл из Хранилища и указать название этого файла. Выбранные документы будут отображены на странице услуги в разделе "Материалы".
После создания/редактирования записи реестра услуга будет сразу добавлена/изменена на портале.
Настройка внешнего вида витрины
-----------------------------------
Настройка внешнего вида и адреса витрины
------------------------------------------
По умолчанию витрина доступна по адресу ``<host>:<port>/portal``.
URL витрины регулируется именем соответствующего файла ``war`` в папке ``/opt/synergy/jboss/standalone/deployments``.
Для изменения URL достаточно указать новое имя для файла ``portal.war``.
Для изменения URL необходимо:
- указать новое имя для файла ``portal.war``
- в конфигурации nginx ``/etc/nginx/sites-enabled/synergy-base`` изменить ``location`` для портала. Пример настройки для нового имени **Showcase**:
.. code-block:: xml
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;
}
Главная страница
~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~
Слайдер
""""""""""""""
Главная страница витрины содержит настроенные услуги из Каталога услуг. Здесь отображаются только те услуги, в которых
было выбрано значение "Отображать на сайте".
Плашки услуг
""""""""""""""
Главная страница состоит из двух основных блоков: **слайдера** и области **плашек услуг**. Слайдер содержит только те
услуги, для которых включен флаг "Отображать на главной", остальные услуги отображаются в виде плашек.
Для каждой услуги отображается ее картинка, название, ценность и кнопка перехода к странице услуги.
Страница услуги
~~~~~~~~~~~~~~~~~~~~
В общем случае страница услуги состоит из следующих блоков:
#. Название услуги
#. Ценность
#. Видео или презентация, если он добавлены для услуги
.. note:: Если для услуги добавлены одновременно и ссылка, и презентация, то на странице услуги будет отображено только видео.
#. Описание услуги
#. Материалы
#. Кнопка подачи заявки
Все эти сведения настраиваются отдельно для каждой услуги в реестре "Каталог услуг" (см. раздел "Добавление новой услуги").
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