[#36] showcase release update

install-guide/index.rst

@@ -4,36 +4,51 @@
    contain the root `toctree` directive.
 
 Инструкция по установке приложения Arta Synergy Showcase
-===================================================
+========================================================
 
 Общие сведения
--------------
+--------------
+
+Приложение Synergy Showcase для настройки внешнего вида и функциональности Витрины услуги использует инструмент 
+**Конструктор приложений**. Конструктор приложений позволяет создавать веб-приложения в визуальном интерфейсе. 
+Использование основных возможностей Конструктора не требует от разработчика Synergy навыков написания кода на 
+JavaScript, Java и так далее. При этом в случае необходимости кастомизации приложения - использования 
+дополнительного скриптинга или настройки стилей приложения - она не потребует больших усилий разработчика. 
+
 
 Synergy Showcase устанавливается отдельным пакетом. Возможны следующие варианты установки.
 
-1. ``Install/Upgrade Configuration`` - установка приложения и загрузка его конфигурации (без БД, хранилища, каких-либо индексов и дашбордов).
+1. ``Install/Upgrade Configuration`` - установка приложения и загрузка его конфигурации (без БД и хранилища).
+
+    .. hint:: Данный вариант установки отличается от других тем, что загружается конфигурация через Synergy API, 
+              не удаляя при этом информацию пользователя.
 
-    .. hint:: Данный вариант установки отличается от других тем, что загружается конфигурация через Synergy API, не удаляя при этом информацию пользователя.
+2. ``Clean`` - полная установка приложения без демо-данных («чистая» установка с загрузкой конфигурации и 
+   преднастроенных БД, хранилища, конфигурации приложения).
 
-2. ``Manual`` - установка только приложения без автоматической загрузки конфигурации, дашбордов и всего остального.
+Предварительная установка пакета Конструктора приложений не требуется - он будет установлен вместе с пакетом Synergy Showcase. 
 
 Предварительные требования
--------------
+--------------------------
 
 Важно! Для работы данного приложения требуется:
 
 * установить Arta Synergy 4.0 hamming (`инструкция по установке <http://tdd.lan.arta.kz/docs/synergy/tags/hamming/admin-manual/html/install-and-setup.html#install-and-setup.install>`_)
-* в подсистеме администрирования обновить БД и процессы, завести Системного пользователя (с произвольными логином/паролем, с доступом в систему, с ролью “Разработчик Synergy”)
-* в разделе конфигуратора "Формы завершения" создать новую форму завершения: тип - *Без результата*, код - *no_result*, название - *Без подтверждения*, галочка *Требовать подтверждения результата* выключена
+* в подсистеме администрирования обновить БД и процессы
+* для варианта установки ``Install/Upgrade configuration``: завести Гостевого пользователя (с произвольными логином/паролем, 
+  с доступом в систему, с ролью "Администратор")
+* пользователю, ответственному за кастомизацию приложения, добавить роли ""Разработчик Synergy" и "Конструктор web-клиента"
 
 Установка приложения
--------------
+--------------------
 
-Установочный пакет находится в репозитории *unstable*. В файле ``/etc/apt/sources.list`` необходимо добавить либо раскомментировать следующую строку:
+В первую очередь необходимо подключить репозитории, в которых расположены пакеты Synergy Showcase и Конструктора приложений. 
+Для этого в файле ``/etc/apt/sources.list`` необходимо добавить либо раскомментировать следующую строку:
 
-``deb http://deb.arta.kz/tengri unstable main contrib non-free``
+    .. code-block:: html 
 
-    .. note:: Для предотвращения дальнейшей нечаянной установки нестабильных версий пакетов из репозитория *unstable*, после установки ``arta-synergy-apps-showcase`` рекомендуется его закомментировать в том же файле ``/etc/apt/sources.list``.
+        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
 
 Для установки приложения необходимо выполнить команду:
 
@@ -42,6 +57,16 @@ Synergy Showcase устанавливается отдельным пакето
 	# apt-get update
 	# apt-get install arta-synergy-apps-showcase
 
+В ходе установки необходимо выбрать тип установки из предложенного списка: 
+
+    .. figure:: ../_static/showcase1.png
+
+
+
+Вариант установки Clean
+~~~~~~~~~~~~~~~~~~~~~~~
+
+
 В ходе установки необходимо выполнить следующее:
 
 * Выбрать тип установки из предложенного списка
@@ -67,6 +92,7 @@ Synergy Showcase устанавливается отдельным пакето
         Рис. Ввод пароля
 
 После установки
--------------
+---------------
 
 После установки приложения обязательно выполнить пункты `инструкции по внедрению <http://rtd.lan.arta.kz/docs/showcase-introduction-guide/ru/v1.0/>`_.
+

introduction-guide/_static/configuration.xml

+<?xml version="1.0" encoding="utf-8"?>
+<configuration version="1" date="2019-06-04 04:59:10" synergyVersion="4.0">
+    <objects version="1" date="2019-06-04 04:59:10" synergyVersion="4.0">
+        <dictionary code="work_completion" name="Формы завершения работ" comment="Формы завершения работ">
+            <columns>
+                <column code="additional_params"
+                    name="Дополнительные параметры" order="null"
+                    comment="Дополнительные параметры" localized="false"/>
+                <column code="button_name" name="Название кнопки"
+                    order="null" comment="Название кнопки" localized="true"/>
+                <column code="is_result_free"
+                    name="Подтверждение не требуется" order="null"
+                    comment="Подтверждение не требуется" localized="false"/>
+                <column code="form_type_name" name="Название" order="0"
+                    comment="Название формы завершения" localized="true"/>
+                <column code="form_type" name="Тип" order="1"
+                    comment="Тип" localized="false"/>
+                <column code="code" name="Код" order="2"
+                    comment="Наименование формы завершения" localized="false"/>
+            </columns>
+            <items>
+                <item>
+                    <itemValue column="form_type_name"
+                        value="Без подтверждения"
+                        _c_value="Без подтверждения" _c_setByUser="true"
+                        _ru_value="Без подтверждения"
+                        _ru_setByUser="false"
+                        _kk_value="Без подтверждения"
+                        _kk_setByUser="false"
+                        _en_value="Без подтверждения" _en_setByUser="false"/>
+                    <itemValue column="additional_params" value=""/>
+                    <itemValue column="form_type" value="4"/>
+                    <itemValue column="code" value="no_result"/>
+                    <itemValue column="button_name" value="" _c_value=""
+                        _c_setByUser="true" _ru_value=""
+                        _ru_setByUser="false" _kk_value=""
+                        _kk_setByUser="false" _en_value="" _en_setByUser="false"/>
+                    <itemValue column="is_result_free" value="1"/>
+                </item>
+                <item>
+                    <itemValue column="form_type_name" value="Файл"
+                        _c_value="Файл" _c_setByUser="true"
+                        _ru_value="Файл" _ru_setByUser="true"
+                        _kk_value="Файл" _kk_setByUser="true"
+                        _en_value="File" _en_setByUser="true"/>
+                    <itemValue column="form_type" value="1"/>
+                    <itemValue column="code" value="file"/>
+                </item>
+                <item>
+                    <itemValue column="form_type_name"
+                        value="Комментарий" _c_value="Комментарий"
+                        _c_setByUser="true" _ru_value="Комментарий"
+                        _ru_setByUser="true" _kk_value="Түсініктеме "
+                        _kk_setByUser="true" _en_value="Comments" _en_setByUser="true"/>
+                    <itemValue column="form_type" value="0"/>
+                    <itemValue column="code" value="comment"/>
+                </item>
+            </items>
+        </dictionary>
+    </objects>
+    <dependencies/>
+</configuration>

introduction-guide/conf.py

@@ -44,7 +44,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'Инструкция по внедрению Synergy Showcase'
-copyright = u'2018, ARTA Software'
+copyright = u'2019, ARTA Software'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -232,7 +232,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'readthedocstemplate', u'Спецификация требований Synergy Showcase',
+    ('index', 'readthedocstemplate', u'Инструкция по внедрению Synergy Showcase',
      [u'Read the Docs'], 1)
 ]
 

introduction-guide/src/first_tuning.rst

 Первоначальная настройка 
------------------------------
-
-Настройки для портала 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Прописать логин и пароль системного пользователя для Showcase в файле ``/opt/synergy/jboss/standalone/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 /portal {
-        allow               all;
-        proxy_pass          http://127.0.0.1:8080/portal;
-        proxy_set_header    Host       $host;
-        proxy_set_header    X-Real-IP  $remote_addr;
-    }
-
-Настройки для модуля sap 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Прописать логин и пароль системного пользователя для sap в файле ``/opt/synergy/jboss/standalone/configuration/external/synergy-api-proxy.properties``: 
-
-.. code-block:: js
-
-    # Адрес Synergy для доступа к REST API
-    synergy.url=http://127.0.0.1:8080/Synergy
-    # Логин пользователя от имени которого будет выполняться запрос к REST API Synergy
-    synergy.user.login=showcase_login
-    # Пароль пользователя от имени которого будет выполняться запрос к REST API Synergy
-    synergy.user.password=showcase_password
-
-Также необходимо проверить, что в файле ``/etc/nginx/sites-enabled/synergy-base`` настроен доступ для sap и прочих кэшируемых запросов: 
-
-.. code-block:: xml
-
-    location ~* /sap/proxy/uservice/image {
-        add_header X-Cache-Status $upstream_cache_status;
-        proxy_set_header        Host       $host;
-        proxy_set_header        X-Real-IP  $remote_addr;
-        proxy_pass              http://127.0.0.1:8080;
-        proxy_cache portal;
-        proxy_ignore_headers Cache-Control Expires Set-Cookie;
-        proxy_cache_valid 200 1d;
-        proxy_cache_lock on;
-    }
-    location ~* /Synergy/rest/api/registry/data_ext {
-        add_header X-Cache-Status $upstream_cache_status;
-        proxy_set_header        Host       $host;
-        proxy_set_header        X-Real-IP  $remote_addr;
-        proxy_pass              http://127.0.0.1:8080;
-        proxy_cache portal;
-        proxy_ignore_headers Cache-Control Expires Set-Cookie;
-        proxy_cache_valid 200 1h;
-        proxy_cache_lock on;
-    }
-    location ~* /Synergy/rest/api/formPlayer/documentIdentifier {
-        add_header X-Cache-Status $upstream_cache_status;
-        proxy_set_header        Host       $host;
-        proxy_set_header        X-Real-IP  $remote_addr;
-        proxy_pass              http://127.0.0.1:8080;
-        proxy_cache portal;
-        proxy_ignore_headers Cache-Control Expires Set-Cookie;
-        proxy_cache_valid 200 1h;
-        proxy_cache_lock on;
-    }
-
-.. hint:: Настройки кэширования nginx задаются в файле ``/etc/nginx/nginx.conf`` строкой:
-
-	.. code-block:: xml
-
-		proxy_cache_path /var/temp/nginx levels=1 keys_zone=portal:30m max_size=1G use_temp_path=off inactive=1d;
-
-    Подробное описание параметров можно `прочитать по ссылке <http://nginx.org/ru/docs/http/ngx_http_proxy_module.html#proxy_cache_path>`_.
+------------------------
+
+Clean
+~~~~~
+
+#. Прописать логин и пароль гостевого пользователя в настройки скрипта интерпретатора ``event.blocking.interpreter.createItemDoc``. 
+
+#. Добавить ``war`` приложения Showcase на сервер: 
+
+    #. Перейти по адресу ``http[s]://<host>:<port>/constructor``. Откроется страница авторизации в Конструкторе приложений. 
+
+    #. На странице авторизации ввести логин и пароль пользователя Admin (1/1): 
+
+         .. figure:: ../_static/showcase1.png
+
+       В результате успешной авторизации откроется конструктор приложения Showcase: 
+
+         .. figure:: ../_static/showcase2.png
+
+    #. На верхней панели нажать на кнопку **WAR**. В результате на локальный компьютер будет скачан файл ``showcase.war``. 
+
+    #. Скопировать этот файл на сервер в папку ``/opt/synergy/jboss/standalone/deployments``. 
 
 Install/upgrade configuration 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-#. Добавить системного пользователя в группу ``Showcase``. Этой группе должны быть предоставлены все права на все реестры продукта. 
+#. В **SynergyAdmin** добавить роль "Конструктор web-клиента" гостевому пользователю и разработчику Synergy. 
 
-#. Прописать логин и пароль системного пользователя в настройки скриптов интерпретатора ``event.blocking.interpreter.createContact`` и ``event.form.formdata.change``. 
+#. Добавить гостевого пользователя в группу "Клиенты Showcase" ``showcase_clients``. 
+
+#. Добавить ``war`` приложения Showcase на сервер в папку ``/opt/synergy/jboss/standalone/deployments`` (см. алгоритм для **Clean**). 
+
+    Авторизоваться в Конструкторе приложений можно от имени пользователя с ролью "Конструктор web-клиента". 
+
+#. Прописать логин и пароль гостевого пользователя в настройки скрипта интерпретатора ``event.blocking.interpreter.createItemDoc``. 
+
+#. Для шаблонов маршрутов ``showcase_templates_status01``, ``showcase_templates_status02`` и ``showcase_templates_status03`` указать 
+   ответственного оператора для услуг. 
+
+#. В разделе "Настройки платформы" создать новую роль "Просмотр услуг" с 
 
 Manual
-~~~~~~~~~~~~~~~~
+~~~~~~
 
 #. Импортировать приложение Showcase из архива ``/opt/synergy/apps/showcase/app-showcase.7zip``. 
 
     .. hint:: 
 
         #. При импорте приложения рекомендуем руководствоваться `документацией`_.
+
         #. Если на сервере уже был установлен продукт, следует сверить номера версий приложения в архиве и на сервере, при необходимости нужно увеличить номер версии в архиве.
 
 #. Добавить системного пользователя в группу ``Showcase``.
@@ -105,8 +60,10 @@ Manual
 .. _`документацией`: http://tdd.lan.arta.kz/docs/synergy/tags/hamming/release-notes/html/app_export_import.html#app_import
 
 Настройки каталога услуг
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 После установки необходимо в клиентской части создать одну запись в реестре **"Настройки каталога услуг"**, где указывается количество плашек услуг в одной строке при их отображении на портале. 
 
 После этого в Synergy IDE нужно убрать права на создание и удаление записей в этом реестре. 
+
+