hello knowledge-introduction-guide

introduction_guide/Makefile

+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ReadtheDocsTemplate.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ReadtheDocsTemplate.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/ReadtheDocsTemplate"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ReadtheDocsTemplate"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

introduction_guide/_static/theme_overrides.css

+/* override table width restrictions */
+@media screen and (min-width: 767px) {
+
+   .wy-table-responsive table td {
+      /* !important prevents the common CSS stylesheets from overriding
+         this as on RTD they are loaded after this stylesheet */
+      white-space: normal !important;
+   }
+
+   .wy-table-responsive {
+      overflow: visible !important;
+   }
+}
\ No newline at end of file

introduction_guide/conf.py

+# -*- coding: utf-8 -*-
+#
+# Read the Docs Template documentation build configuration file, created by
+# sphinx-quickstart on Tue Aug 26 14:19:49 2014.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as Strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Инструкция по внедрению Synergy Knowledge'
+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
+# built documents.
+#
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1-alpha'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'sphinx_rtd_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+html_context = {
+    'css_files': [
+        '_static/theme_overrides.css',  # override wide tables in RTD theme
+        ],
+     }
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'ReadtheDocsTemplatedoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  ('index', 'ReadtheDocsTemplate.tex', u'Read the Docs Template Documentation',
+   u'Read the Docs', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'readthedocstemplate', u'Спецификация требований Synergy Showcase',
+     [u'Read the Docs'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'ReadtheDocsTemplate', u'Read the Docs Template Documentation',
+   u'Read the Docs', 'ReadtheDocsTemplate', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False

introduction_guide/index.rst

+.. Read the Docs Template documentation master file, created by
+   sphinx-quickstart on Tue Aug 26 14:19:49 2014.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Инструкция по внедрению Synergy Knowledge
+==========
+
+.. toctree::
+   :maxdepth: 2
+   :glob:
+   :numbered:
+
+   src/first_tuning
+   src/clean
+   src/new_content
+   src/portal

introduction_guide/src/clean.rst

+Вариант установки "Clean": настройки системы
+-----------------------------
+
+Настройки, автоматически установленные в подсистеме администрирования
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Во-первых, созданы следующие пользователи:
+
+* Администратор (с ролями "Администратор" и "Разработчик Synergy", логин/пароль: 1/1)
+* Системный Пользователь (с ролями "Администратор" и "Разработчик Synergy", логин/пароль: hcm_service_user/1)
+
+Во-вторых, заведена следующая орг.структура:
+
+* ROOT (подразделение, руководитель Администратор)
+   * Системный пользователь (должность, назначен Системный Пользователь)
+
+Настройки, автоматически установленные в конфигураторе
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Во-первых, импортировано приложение ``Knowledge``.
+
+Во-вторых, созданы следующие группы пользователей:
+
+* HCM полный доступ (Системный Пользователь)
+* HCM частичный доступ
+
+В-третьих, созданы 2 пункта меню кнопки "Создать":
+
+* Карточка пользователя
+   * код: ``hcm_create_userCard``
+   * реестр: "Карточка пользователя"
+   * галочка "Добавить в "Избранное" пользователя по умолчанию" включена
+   * права: автогруппе "ROOT"
+
+* Сформировать ИПР
+   * код: ``hcm_create_idp``
+   * реестр: "ИПР"
+   * галочка "Добавить в "Избранное" пользователя по умолчанию" включена
+   * права: автогруппе "ROOT"

introduction_guide/src/first_tuning.rst

+Первоначальная настройка 
+-----------------------------
+
+Настройки для портала 
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Прописать логин и пароль системного пользователя для Knowledge в файле ``/opt/synergy/jboss/standalone/deployments/lms.war/init.js``: 
+
+.. code-block:: js
+
+    var _SYNERGY_ACCESS_LOGIN_ = 'knowledge_login'; 
+    var _SYNERGY_ACCESS_PASS_ = 'knowledge_password';
+
+Также необходимо проверить, что в файле ``/etc/nginx/sites-enabled/synergy-base`` настроен доступ к порталу: 
+
+.. code-block:: xml
+
+    location ~* /lms {
+        proxy_pass          http://127.0.0.1:8080;
+    }
+
+Настройки для модуля sap 
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Прописать логин и пароль системного пользователя для sap в файле ``/opt/synergy/jboss/standalone/configuration/external/synergy-api-proxy.properties``: 
+
+.. code-block:: xml
+
+    # Адрес Synergy для доступа к REST API
+    synergy.url=http://127.0.0.1:8080/Synergy
+    # Логин пользователя от имени которого будет выполняться запрос к REST API Synergy
+    synergy.user.login=knowledge_login
+    # Пароль пользователя от имени которого будет выполняться запрос к REST API Synergy
+    synergy.user.password=knowledge_password
+
+Также необходимо проверить, что в файле ``/etc/nginx/sites-enabled/synergy-base`` настроен доступ для sap: 
+
+.. code-block:: xml
+
+    location /sap {
+        proxy_pass              http://127.0.0.1:8080;
+    }
+
+Clean
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+#. Проверить корректность URL до Synergy в настройках внешнего модуля ``LMS``.
+
+Install/upgrade configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+#. Добавить системного пользователя в группу ``HCM полный доступ``.
+
+#. Проверить, что группе пользователей ``HCM полный доступ`` предоставлены все права на реестры. 
+
+#. Проверить корректность URL до Synergy в настройках внешнего модуля ``LMS``.
+
+#. Прописать логин и пароль системного пользователя в настройках всех скриптов интерпретатора:
+
+   * ``event.blocking.interpreter.addIndexCUS``
+   * ``event.blocking.interpreter.anketaCUS``
+   * ``event.blocking.interpreter.changeCUS``
+   * ``event.blocking.interpreter.changePictureCourse``
+   * ``event.blocking.interpreter.checkSertificationUser``
+   * ``event.blocking.interpreter.courseCompleted``
+   * ``event.blocking.interpreter.removeIndexCUS``
+   * ``event.blocking.interpreter.rprofileCUS``
+   * ``event.blocking.interpreter.setImageCUS``
+   * ``event.blocking.interpreter.workCoursesNotify``
+   * ``event.blocking.interpreter.wprofileCUS``
+
+#. Создать 2 пункта меню кнопки "Создать":
+
+   * Карточка пользователя
+      * код: ``hcm_create_userCard``
+      * реестр: "Карточка пользователя"
+      * галочка "Добавить в "Избранное" пользователя по умолчанию" включена
+      * права: автогруппе "ROOT"
+
+   * Сформировать ИПР
+      * код: ``hcm_create_idp``
+      * реестр: "ИПР"
+      * галочка "Добавить в "Избранное" пользователя по умолчанию" включена
+      * права: автогруппе "ROOT"
+
+Manual
+~~~~~~~~~~~~~~~~
+
+#. Импортировать приложение Knowledge из архива ``/opt/synergy/apps/showcase/app-knowledge.7zip``. 
+
+    .. hint:: 
+
+        #. При импорте приложения рекомендуем руководствоваться `документацией <http://tdd.lan.arta.kz/docs/synergy/tags/hamming/release-notes/html/app_export_import.html#app_import>`_.
+        #. Если на сервере уже был установлен продукт, следует сверить номера версий приложения в архиве и на сервере, при необходимости нужно увеличить номер версии в архиве.
+
+#. Добавить системного пользователя в группу ``HCM полный доступ``.
+
+#. Проверить, что группе пользователей ``HCM полный доступ`` предоставлены все права на реестры. 
+
+#. Заменить URL до Synergy в настройках внешнего модуля ``LMS``.
+
+#. Прописать логин и пароль системного пользователя в настройках всех скриптов интерпретатора:
+
+   * ``event.blocking.interpreter.addIndexCUS``
+   * ``event.blocking.interpreter.anketaCUS``
+   * ``event.blocking.interpreter.changeCUS``
+   * ``event.blocking.interpreter.changePictureCourse``
+   * ``event.blocking.interpreter.checkSertificationUser``
+   * ``event.blocking.interpreter.courseCompleted``
+   * ``event.blocking.interpreter.removeIndexCUS``
+   * ``event.blocking.interpreter.rprofileCUS``
+   * ``event.blocking.interpreter.setImageCUS``
+   * ``event.blocking.interpreter.workCoursesNotify``
+   * ``event.blocking.interpreter.wprofileCUS``
+
+#. Создать 2 пункта меню кнопки "Создать":
+
+   * Карточка пользователя
+      * код: ``hcm_create_userCard``
+      * реестр: "Карточка пользователя"
+      * галочка "Добавить в "Избранное" пользователя по умолчанию" включена
+      * права: автогруппе "ROOT"
+
+   * Сформировать ИПР
+      * код: ``hcm_create_idp``
+      * реестр: "ИПР"
+      * галочка "Добавить в "Избранное" пользователя по умолчанию" включена
+      * права: автогруппе "ROOT"
+
+#. В Kibana создать следующие шаблоны индексов:
+
+   * ``r-hcm_registry_usercards_custom``
+   * ``r-hcm2_registry_competence``
+   * ``r-hcm_registry_idp``
+
+#. В шаблоне индексов ``r-hcm_registry_usercards_custom`` добавить следующие ``Scripted fields``:
+
+   * ``course_finished``
+      * language: painless;
+      * type: number;
+      * script:
+
+         .. code-block:: js
+
+	   int fvalue=0;
+	   if (doc['hcm_form_userCard_status_key.keyword'].value == '2' ||  doc['hcm_form_userCard_status_key.keyword'].value == '3') {
+	      fvalue=1;
+	   }
+	   return fvalue;
+
+   * ``user_certified``
+      * language: painless;
+      * type: number;
+      * script:
+
+         .. code-block:: js
+
+	   int tvalue=0;
+	   if (doc['hcm_form_userCard_certified_key.keyword'].value == '1') {
+	      tvalue=1;
+	   }
+	   return tvalue;
+
+#. Проверить, что установлен плагин Kibana ``gauge`` (имеется непустая папка ``/usr/share/kibana/plugins/gauge-sg``).
+
+   .. note:: При необходимости установить плагин самостоятельно по `ссылке <https://github.com/sbeyn/kibana-plugin-gauge-sg>`_.
+
+#. Импортировать визуализации из файла ``/opt/synergy/apps/crm/knowledge_visualizations.json``.
+
+#. Импортировать дашборды из файла ``/opt/synergy/apps/crm/knowledge_dashboards.json``.
+
+.. hint:: Дополнительные подробности доступны в подробной документации о `Kibana <http://rtd.lan.arta.kz/docs/guide/ru/hamming/dashboards.html>`_.
+
+
+
+

introduction_guide/src/new_content.rst

+Добавление контента
+------------------------------
+
+Общий порядок добавления нового контента в систему:
+
+#. создать каталог умений;
+#. создать каталог обучающих курсов;
+#. добавить в каждое умение ссылку на соответствующий курс;
+#. создать группы курсов;
+#. создать каталог должностей, указать обязательный набор курсов;
+#. создать профили обучающихся
+
+Дополнительные возможности:
+
+* создать тестовые вопросы;
+* создать группы тестовых вопросов, привязав ее к какому-либо курсу;
+* создать инструменты оценки курсов;
+
+Реестры, в которых данные формируются исключительно автоматически:
+
+* "Анкета эффективности курсов"
+* "ИПР"
+* "Форма оповещений курсов"
+
+
+

introduction_guide/src/portal.rst

+Настройки портала обучения
+------------------------------------------
+
+По умолчанию портал доступен по адресу ``<host>:<port>/lms``. 
+
+URL витрины регулируется именем соответствующего файла ``war`` в папке ``/opt/synergy/jboss/standalone/deployments``. 
+Для изменения URL необходимо: 
+
+* указать новое имя для файла ``lms.war`` 
+* в конфигурации nginx ``/etc/nginx/sites-enabled/synergy-base`` изменить ``location`` для портала. Пример настройки для нового имени **academy**: 
+
+   .. code-block:: xml
+
+      location /academy {
+         proxy_pass          http://127.0.0.1:8080/;
+      }
+
+Портал содержит следующие основные страницы:
+
+#. Авторизация
+#. Регистрация
+#. "Профиль"
+#. "Мои курсы"
+#. "Все курсы"
+#. "Библиотека"
+#. Страница курса
+
+Список должностей для страницы регистрации формируется из реестра "Карточка должности". 
+Страницы "Профиль", "Мои курсы" и "Библиотека" берут значения из записи реестра "Карточка 
+пользователя", соответствующей авторизованному пользователю. Страница "Все курсы" - из 
+реестров "Группы курсов" и "Обучающие курсы". Страница курса - из реестра "Обучающие курсы".
+
+Авторизация
+~~~~~~~~~~~~~~~~~~~~~~~~ 
+
+Страница авторизации содержит следующую форму ввода:
+
+* "Логин"
+* "Пароль"
+* Кнопка перехода к странице регистрации
+* Кнопка входа в портал
+
+Авторизация произойдет успешно только при одновременном выполнении следующих условий:
+
+* на хосте существует введенная учетная запись пользователя
+* на хосте имеются все реестры из списка:
+   * "Умения" (код ``hcm_skills``)
+   * "Обучающие курсы" (код ``hcm2_registry_competence``)
+   * "Группы курсов" (код ``hcm_registry_courseGroups``)
+   * "Инструменты оценки курсов" (код ``hcm_registry_edu_instruction``)
+   * "Карточка должности" (код ``hcm_registry_positions``)
+   * "Карточка пользователя" (код ``hcm_registry_userCards``)
+   * "ИПР" (код ``hcm_registry_idp``)
+* в реестре "Карточка пользователя" имеется запись, поле ``hcm_form_userCard_user`` которого совпадает с учетной записью авторизующегося пользователя
+
+Регистрация
+~~~~~~~~~~~~~~~~~~~~~~~~ 
+
+Страница авторизации содержит следующую форму ввода:
+
+* "Логин / E-mail"
+* "Фамилия"
+* "Имя"
+* "Должность"
+* "Пароль"
+* Кнопка перехода к странице авторизации
+* Кнопка регистрации
+
+Процесс регистрации создает новую учетную запись пользователя в подсистеме администрирования, 
+а также новую запись в реестре "Карточка пользователя" на основе введенных данных.
+
+Профиль
+~~~~~~~~~~~~~~~~~~~~~~~~ 
+
+В профиль попадают все поля из статической таблицы ``hcm_form_userCard_profile``. Новое поле таблицы 
+необходимо добавлять наподобие уже добавленных в неё полей:
+
+* задать имя основному компоненту
+* добавить отдельный компонент для лейбла, задать ему имя в формате ``имя_основного_компонента-label``
+
+После полей профиля отображается кнопка выхода на страницу авторизации.
+
+Дополнительно на странице профиля отображается статистика прохождения курсов. Данные считываются из 
+статической таблицы ``hcm_form_userCard_certificateTable``.
+
+Мои курсы
+~~~~~~~~~~~~~~~~~~~~~~~~ 
+
+Страница делится на 2 категории:
+
+* обязательные курсы (автоматически формируемый список на основе должности пользователя): из динамической таблицы ``hcm_form_userCard_competenceTable``
+* дополнительные курсы (добавленные пользователем вручную): из динамической таблицы ``hcm_form_userCard_competenceTable_other``
+
+Для каждого курса отображается его фоновая картинка, название, статус, прогресс прохождения (при наличии), 
+при наведении на плашку дополнительно - автор.
+
+Все курсы
+~~~~~~~~~~~~~~~~~~~~
+
+Страница содержит список всех курсов в двух видах:
+
+* сгруппированный список
+* сплошной список
+
+Для каждой группы курсов отображается ее фоновая картинка, количество курсов в группе, название, описание.
+
+Для каждого курса отображается его фоновая картинка, название, статус, прогресс прохождения (при наличии), 
+при наведении на плашку дополнительно - автор.
+
+Библиотека
+~~~~~~~~~~~~~~~~~~~~~~~~ 
+
+На страницу библиотеки попадают файлы / ссылки из динамической таблицы ``hcm_form_userCard_books``.
+
+Страница курса
+~~~~~~~~~~~~~~~~~~~~~~~~ 
+
+Страница содержит 2 блока:
+
+#. содержание курса (список уроков)
+#. описание курса / содержимое выбранного урока
+
+Содержание и содержимое уроков считывает данные динамических таблиц ``hcm_form_competence_tableCourseContent`` 
+и ``hcm_form_competence_tableRes``. Допускается добавление новых строк в блоки таблиц, поддерживаемые 
+компоненты - однострочное поле, многострочное поле, файл, ссылка:
+
+* задать имя основному компоненту (полю ввода)
+* добавить отдельный компонент для лейбла, задать ему имя в формате ``имя_основного_компонента-label``
+* для файла задать имя в формате ``имя_основного_компонентаfile``
+* для ссылки задать имя в формате ``имя_основного_компонентаlink``
+
+В описание попадают поле ``hcm_form_compitience_pasport``, а также данные статических таблиц 
+``hcm_form_competence_tableMain`` и ``hcm_form_competence_tableAdditional``. Допускается добавление 
+новых поле в таблицу ``hcm_form_competence_tableAdditional``:
+
+* задать имя основному компоненту
+* добавить отдельный компонент для лейбла, задать ему имя в формате ``имя_основного_компонента-label``
+
+