Commit da94acb1 authored by Kristina Markova's avatar Kristina Markova

showcase docs

parent 3e7c7950
......@@ -47,8 +47,8 @@ Synergy Showcase устанавливается отдельным пакето
.. 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 showcase-2.0 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
Для установки приложения необходимо выполнить команду:
......@@ -59,40 +59,44 @@ Synergy Showcase устанавливается отдельным пакето
В ходе установки необходимо выбрать тип установки из предложенного списка:
.. figure:: ../_static/showcase1.png
.. figure:: _static/showcase1.png
Дальнейшие шаги зависят от выбранного типа установки.
Вариант установки 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/>`_.
......@@ -13,7 +13,6 @@
src/first_tuning
src/new_service
src/new_request
src/portal
Введение
......
Первоначальная настройка
------------------------
В первую очередь после установки пакета Synergy Showcase следует проверить используемую лицензию ARTA Synergy
(Административное приложение - Обслуживание системы - Информация о лицензии - Максимальное количество
пользовательских лицензий).
Мы рекомендуем использовать лицензию на неограниченное количество пользователей. Поскольку портал Витрины услуг
предполагает возможность самостоятельной регистрации клиентов, при превышении количества доступных лицензий
новые клиенты при попытке регистрации будут получать ошибку.
Инструкция по обновлению лицензии приведена в `документации <http://tdd.lan.arta.kz/docs/synergy/tags/hamming/admin-manual/html/s33.html>`_
Clean
~~~~~
......@@ -22,6 +32,18 @@ Clean
#. Скопировать этот файл на сервер в папку ``/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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......@@ -29,6 +51,9 @@ Install/upgrade configuration
#. Добавить гостевого пользователя в группу "Клиенты Showcase" ``showcase_clients``.
#. Добавить операторов, обрабатывающих заявки на услуги, и контент-менеджеров, настраивающих описание услуг, в группу
"Операторы Showcase" ``showcase_operators``.
#. Добавить ``war`` приложения Showcase на сервер в папку ``/opt/synergy/jboss/standalone/deployments`` (см. алгоритм для **Clean**).
Авторизоваться в Конструкторе приложений можно от имени пользователя с ролью "Конструктор web-клиента".
......@@ -38,32 +63,29 @@ Install/upgrade configuration
#. Для шаблонов маршрутов ``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 нужно убрать права на создание и удаление записей в этом реестре.
#. В этом же разделе "Настройки платформы" - "Хранилище" - "Папки" в папке "Документы для услуг" создать дочернюю папку "Пустая".
Добавление новой заявки
------------------------------
Каждой услуге соответствует некоторый реестр заявок. Для разных услуг может использоваться как некоторая типовая форма заявки, так и уникальные формы с собственными реестрами и маршрутами.
Здесь будет рассмотрен случай настройки уникальной формы заявки на услугу.
Справочник статусов заявок
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Для указания статуса любой заявки используется справочник **"Статусы заявок"**. Поля этого справочника регулируют поведение заявки и ее отображение в Личном кабинете портала:
#. Значение ``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``.
Созданный реестр нужно указать в сведениях о соответствующей услуге (реестр "Каталог услуг", поле "Ссылка на реестр").
This diff is collapsed.
This diff is collapsed.
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