# Инструкции по настройке Synergy Customers

## Описание Synergy Customers

### Главная страница

На главной странице Synergy Customers расположен одиз из основных элементов продукта - Канбан-доска. Канбан-доска позволяет наглядно представить элементы Customers в разбивке по статусам. Элементы доски содержат необходимую информацию - сумму, ФИО ответственного менеджера, ссылки на контакт и организацию.

В заголовке столбца содержится информация о количестве элементов и сумма по столбцу.

На левой панели расположены разделы Synergy Customers:

- Сделки (Канбан-доска)
- Лиды (Канбан-доска)
- Организации (список)
- Контакты (список)
- Договоры (список)
- Активности (список)

При необходимости боковую панель можно свернуть/развернуть.

Рис. 1

### Фильтры

При наличии в выбранном разделе доступных пользователю фильтров соответствующего реестра - выбор фильтров будет отображаться слева от поисковой строки.

По умолчанию отображается верхний доступный фильтр.

Рис. 2

### Расширенный поиск

Расширенный поиск с выбором условий доступен по нажатию на пиктограмму справа от поисковой строки.

На открывшейся панели есть возможность добавить/удалить условия фильтрации по тем полям формы (например, с кодом поля field), для которых есть соотвествующее поле с типом неизменяемый текст и с кодом поля fieldLabel.

Рис. 3

### Создание контакта

Создать новую карточку контакта в Synergy Customers можно несколькими способами:

1. из раздела «Контакты» по нажатию на кнопку `+ Создать`;
2. из действующей карточки Сделки по нажатию на кнопку `+ Создать` в поле «Контакт».
3. из карточки Лид по нажатию на кнопку `+ Создать` в поле «Контакт».

Система отобразит список совпадений по ФИО и/или ИИН контакта, при наличии. Наличие совпадений не ограничивает создание карточки.

### Создание организации

Создать новую карточку организации в Synergy Customers можно несколькими способами:

1. из раздела «Организации» по нажатию на кнопку `+ Создать`;
2. из действующей карточки Контакта по нажатию на кнопку `+ Создать` в поле «Организация»;
3. из действующей карточки Сделки по нажатию на кнопку `+ Создать` в поле «Организация».
4. из карточки Лид по нажатию на кнопку `+ Создать` в поле «Организация».

Система отобразит список совпадений по наименованию и/или БИН организации, при наличии. Наличие совпадений не ограничивает создание карточки.

### Создание сделки

Создать новую карточку сделки в Synergy Customers можно несколькими способами:

1. из раздела «Сделки» по нажатию на кнопку `+ Создать`;
2. из действующей карточки Организации по нажатию на кнопку `Создать` в блоке «Сделки» - с автоматической привязкой данной организации;
3. из действующей карточки Контакта по нажатию на кнопку `Создать` в блоке «Сделки» - с автоматической привязкой данного контакта и связанной с ним Организации.

### Смена стадии сделки

Сменить стадию сделки в Synergy Customers можно несколькими способами:

1. из карточки Сделки, выбрав нужную стадию в поле «Стадия»;
2. в разделе Сделки перемещением плашки Сделки из стадии А в стадию Б;

### Создание лида

Создать карточку лида можно в разделе Лид, нажав на кнопку `+ Создать`

Рис. 4

## Описание компонентов Synergy Customers

### Рекомендации по настройке форм

Общее описание редактора форм, компонентов и их свойств приведено в спецификации на платформу.

Ниже приведены правила и рекомендации к настройке формы для того, чтобы у пользователей был одинаковый опыт их использования как с экранов мониторов, так и с мобильных устройств.

- Создавайте вертикально-ориентированные формы:
  - группируйте поля в таблицы;
  - добавляйте не более 2 компонентов на одну строку;
  - добавляйте заголовок (подпись) над компонентом.
- Настройте единый вид всей формы, используя:
  - единый шрифт и размер текста;
  - отступы как от края формы, так и между компонентами:
    - относительные (в %) горизонтальные отступы;
    - абсолютные (в пикселях) вертикальные отступы;
- Ответственно подойдите к именованию компонентов:
  - имя компонента должно явно описывать его суть;
  - имя заголовка (подписи) должно содержать в себе имя связанного с ним компонента + суффикс `Label`.

Подсказка

Компонент для ввода БИН организации лучше назвать `crm_form_account_main_bin`, а подпись к такому компоненту - `crm_form_account_main_binLabel`.

- Скройте ненужные и неиспользуемые компоненты (не удаляйте и перенесите в самый низ формы). Эти компоненты могут использоваться в различных функциях / скриптах. Таким образом вы избавитесь от потенциальных проблем и ошибок в дальнейшем использовании продукта.

Все формы в продукте настроены с учетом приведенных рекомендаций. Посмотрите, как они сделаны, и изменяйте их в том же ключе.

Возможные вопросы и проблемы:

1. Как изменить поля в карточках?

### Cправочник «Стадии сделки»

Описание справочника «Стадии сделки»
Столбец | Описание | Доп.свойства
--- | --- | ---
Название | Название стадии | Переводимое поле
Порядковый номер | Определяет порядок следования стадий |
Качество | Определяет, является ли стадия успешной или неуспешной | Неуспешная должна быть только одна
Законченность | Определяет, является ли стадия конечной или неконечной | Конечная стадия должна быть только одна; для неуспешной стадии можно не указывать
Название кнопки | В данный момент нигде не используется |
Цвет | Цвет стадии, который будет использоваться в заголовке витрины, а также в воронке продаж | Формат HTML `#123ABC`
Описание | Описание стадии, которое будет использоваться в заголовке витрины продаж, а также в карточке сделки | Переводимое поле

Возможные вопросы и проблемы:

1. Как изменить стадии сделки?

### Cправочник «Стадии договора»

Описание справочника «Стадии договора»
Столбец | Описание | Доп.свойства
--- | --- | ---
Название | Название стадии | Переводимое поле
Порядковый номер | Определяет порядок следования стадий |
Качество | Определяет, является ли стадия успешной или неуспешной | Неуспешная должна быть только одна
Законченность | Определяет, является ли стадия конечной или неконечной | Конечная стадия должна быть только одна; для неуспешной стадии можно не указывать
Цвет | В данный момент нигде не используется | Формат HTML `#123ABC`
Описание | Описание стадии, которое будет использоваться в карточке договора | Переводимое поле

Возможные вопросы и проблемы:

1. Как изменить стадии договора?

### Cправочник «Стадии лида»

Описание справочника «Стадии сделки»
Столбец | Описание | Доп.свойства
--- | --- | ---
Название | Название стадии | Переводимое поле
Порядковый номер | Определяет порядок следования стадий |
Качество | Определяет, является ли стадия успешной или неуспешной | Неуспешная должна быть только одна
Законченность | Определяет, является ли стадия конечной или неконечной | Конечная стадия должна быть только одна; для неуспешной стадии можно не указывать
Название кнопки | В данный момент нигде не используется |
Цвет | Цвет стадии, который будет использоваться в заголовке витрины, а также в воронке продаж | Формат HTML `#123ABC`

### Импорт данных

Функция импорта, реализованная в продукте, универсальная и позволяет загружать данные из Excel в любой реестр Synergy.

Импорт работает со следующими компонентами формы:

- текстовые однострочные и многострочные поля;
- числовые поля;
- дата/время;
- справочники (выпадающий список, выбор вариантов, переключатель вариантов);
- ссылка на реестр.

Требования к файлу Excel:

1. Формат файла: `*.xls`.

2. Первая строка файла - заголовки; далее - строки для импорта в записи реестра.

   Примечание

   1 строка в Excel = 1 запись реестра.

3. Столбцы, которые не нужно импортировать обозначить заголовком `no`.

4. Остальные заголовки должны содержать в себе точный код поля формы (например, `crm_form_account_main_adress`).

5. Для корректного импорта чисел значение поля в файле должно быть в числовом формате.

6. Для корректного импорта дат значение поля в файле должно быть в формате даты.

7. Для корректного импорта справочников значение поля в файле должно точь-в-точь совпадать с его «наименованием» у справочника.

8. Для корректного импорта нескольких значений в компонент выбора вариантов (чекбокс) в файле их нужно прописать в одной ячейке через `;` с пробелом.

9. Желательно избегать содержания в файле спец.символов json: `"`, `\`, `\b`, `\t` и т.д.

Использование:

1. Заполнить код формы и код реестра, в который будет проводиться импорт. Коды можно взять в конфигураторе.

2. Заполнить логин и пароль пользоваться, от имени которого будут выполняться все запросы. Пользователь должен иметь права на все реестры (куда происходит импорт и если в файле имеются ссылки на прочие реестры).

3. Если импортируемые записи необходимо запустить по маршруту, требуется поставить галочку «Активировать импортированные записи».

4. Если присутсвуют ссылки на реестр обязательно нужно заполнить поле для поиска в формате:

   `(код компонента на форме, куда производится импорт):(код компонента на форме, на которую указывает компонент ссылки на реестр, по которому должен производится поиск)`

   Для каждой ссылки на реестр необходимо через запятую с пробелом необходимо указать подобные пары.

5. При поиске записей для ссылок на реестр может найтись несколько записей реестра. Укажите в соотвествующем пункте действия на этот случай. Если не найдена ни одна запись, значение останется пустым.

6. Выберите заранее подготовленный файл `*.xls` и нажмите на кнопку «Импортировать». Импорт начнет в нескольких потоках обрабатывать переданные записи. Следить за процессом можно через логи системы Synergy.

## Настройка и кастомизация Synergy Customers

### Можно ли изменить дизайн продукта?

Теги: изменить дизайн, изменить интерфейс.

Уровень: разработчик.

Продукт реализован на платформе Arta Synergy и конструкторе приложений в частности. Данный конструктор приложений обеспечивает дизайн «по умолчанию», используется встроенный framework UIKit.

При этом конструктор приложений позволяет менять дизайн продукта. Для этого необходимо:

- подключить разработчика со знаниями HTML/CSS и JavaScript;
- в приложении конструктора `Customers` переопределить стили в ресурсах и свойствах всех используемых компонентов:
  - «CSS Класс» и «Стили» - у стандартных компонентов;
  - «HTML» и «Стили» - у пользовательских компонентов.

Совет

Изменить цвета витрины продаж можно без разработчика штатными средствами, см. подробнее здесь.

### Как изменить URL-адрес приложения?

Теги: адрес приложения, URL, /customers.

Уровень: системный администратор.

В качестве примера изменим URL с `customers` на `sales`.

1. Авторизоваться в Конструкторе приложений и перейти в актуальную версию приложения «Customers 3.0» (с кодом `customers`).

2. Открыть свойства приложения и поменять значение поля URL с дефолтного `customers` на новое `sales`.

3. Передеплоить приложение.

   Вариант 1. В Конструкторе приложений использовать меню Клиент -> Деплой.

   Вариант 2. Передеплоить приложение со стороны сервера:

   - Перейти в папку `deployments`:

     >     # cd /opt/synergy/jboss/standalone/deployments

   - Выполнить команду:

     >     # touch sales.war.dodeploy

4. Со стороны сервера перейти в конфигурационный файл nginx:

   >     # nano /etc/nginx/sites-enabled/synergy-base

   и поменять дефолтный контекст `/customers` на новый `/sales`.

   Было customers:

   >     location /customers {
   >             proxy_pass http://127.0.0.1:8080/customers;
   >     }

   Стало sales:

   >     location /sales {
   >             proxy_pass http://127.0.0.1:8080/sales;
   >     }

5. Проверить корректность настроек nginx:

   >     # nginx -t

   При необходимости исправить ошибки.

6. Если проверка прошла успешно, перезагрузить настройки nginx:

   >     # nginx -s reload

### Как изменить поля в карточках?

Теги: добавить новое поле, изменить заголовок поля, изменить порядок следования полей.

Уровень: аналитик.

Продукт реализован на платформе Arta Synergy и редактора форм в частности. Данный редактор форм обеспечивает гибкую настройку состава полей любых карточек.

1. Авторизоваться в Конфигураторе приложений и перейти в приложение «Customers» (с кодом `customers`).
2. Найти и открыть нужную форму.
3. Изменить состав полей и их свойства согласно рекомендаций.

### Как изменить стадии сделки?

Теги: сделка, изменить название стадии, переименовать стадию, изменить порядок следования стадий, изменить описание стадии, добавить новую стадию, удалить стадию.

Уровень: аналитик.

Решение: отредактировать элементы справочника «Стадии сделки».

1. Авторизоваться в Конфигураторе приложений и перейти в приложение «Customers» (с кодом `customers`).
2. Найти и открыть справочник «Стадии сделки» (с кодом `customers_dict_dealStatus`).
3. Нажать на кнопку «Элементы». Откроется таблица со списком стадий сделок. Для удобства отсортируйте таблицу по столбцу «Порядковый номер».
4. Изменить элементы согласно описания справочника стадий сделок.

### Как изменить стадии договора?

Теги: договор, изменить название стадии, переименовать стадию, изменить порядок следования стадий, изменить описание стадии, изменить цвет стадии, добавить новую стадию, удалить стадию.

Уровень: аналитик.

Решение: отредактировать элементы справочника «Стадии договора».

1. Авторизоваться в Конфигураторе приложений и перейти в приложение «Customers» (с кодом `customers`).
2. Найти и открыть справочник «Стадии договора» (с кодом `customers_dict_contractStatus`).
3. Нажать на кнопку «Элементы». Откроется таблица со списком стадий договора. Для удобства отсортируйте таблицу по столбцу «Порядковый номер».
4. Изменить элементы согласно описания справочника стадий договора.

### Как изменить стадии лида?

Теги: лид, изменить название стадии, переименовать стадию, изменить порядок следования стадий, добавить новую стадию, удалить стадию.

Уровень: аналитик.

Решение: отредактировать элементы справочника «Стадии лида».

1. Авторизоваться в Конфигураторе приложений и перейти в приложение «Customers» (с кодом `customers`).
2. Найти и открыть справочник «Стадии лида» (с кодом `customers_dict_leadStatus`).
3. Нажать на кнопку «Элементы». Откроется таблица со списком стадий лида. Для удобства отсортируйте таблицу по столбцу «Порядковый номер».
4. Изменить элементы согласно описания справочника стадий лида.

Read the Docs v: latest

Versions
  latest
  v3.12
  v3.11
  v3.10
  v3.9
  v3.8
  v3.7
  v3.6
  v3.5
  v3.4
  v3.3
  v2.3
  master

Downloads
  pdf
  docx
  htmlzip
  epub

On Read the Docs
  Project Home
  Builds

Free document hosting provided by Read the Docs.