Модуль расширения возможностей Sprint Migration для CRM Bitrix24

Описание установки и настройки

Название модуля

Модуль расширения возможностей Sprint Migration для CRM Bitrix24

Назначение

Модуль используется как расширение sprint.migration и добавляет возможности переноса CRM-настроек между стендами Bitrix24. После установки в интерфейсе Sprint Migration появляются дополнительные варианты создания миграций для CRM-сущностей.

Предварительные условия

Перед установкой необходимо проверить:

1. На проекте установлен модуль sprint.migration.
2. На проекте доступен CRM-модуль Bitrix24.
3. У пользователя есть права администратора.
4. Версия PHP соответствует требованиям модуля: PHP 8.1 или выше.

Установка модуля

Для установки необходимо:

1. Разместить модуль в каталоге local/modules/mcart.migration.
2. Перейти в административную часть Bitrix.
3. Открыть раздел установленных решений или модулей.
4. Найти модуль mcart.migration.
5. Нажать кнопку установки.
6. Подтвердить установку на следующем шаге.

Во время установки модуль:

- проверяет наличие sprint.migration;
- проверяет права администратора;
- создает служебные данные, необходимые для работы миграций;
- регистрирует обработчики событий;
- добавляет административный инструмент для установки кодов CRM-сущностей.

Настройки модуля

Настройки находятся в административной части Bitrix на странице настроек модуля mcart.migration.

В модуле предусмотрены следующие вкладки:

1. Основные настройки

Содержит опцию:

- Пример строковой настройки в 20 символов

Данная настройка является служебной/примерной и не влияет на основной сценарий работы CRM-миграций.

2. Права доступа

На этой вкладке настраиваются стандартные права доступа к модулю средствами Bitrix.

Основная работа с модулем выполняется не через настройки, а через интерфейс Sprint Migration и дополнительный административный инструмент для установки кодов.

Использование модуля

После установки необходимо перейти в интерфейс Sprint Migration. В списке доступных типов миграций появятся дополнительные CRM-возможности:

- миграция смарт-процессов;
- миграция пользовательских полей смарт-процессов;
- миграция CRM-воронок;
- миграция CRM-стадий;
- миграция настроек вида карточки CRM;
- миграция обязательности полей на стадиях.

Общий порядок использования:

1. Открыть административный интерфейс Sprint Migration.
2. Выбрать нужный тип CRM-миграции.
3. Указать сущности, которые необходимо перенести.
4. Сформировать миграцию.
5. Проверить созданную миграцию.
6. Применить миграцию на нужном стенде стандартными средствами sprint.migration.

Рекомендуемый порядок подготовки CRM-миграций

Для смарт-процессов рекомендуется соблюдать следующий порядок:

1. Создать и настроить смарт-процесс.
2. Задать код смарт-процесса.
3. Создать миграцию смарт-процесса.
4. Создать миграции воронок, если они используются.
5. Создать инициализационную миграцию стадий, если используются стадии.
6. Настроить стадии, поля, обязательность полей и карточку CRM.
7. Создать остальные необходимые миграции.

Административный инструмент установки кодов

Модуль добавляет в административное меню Sprint Migration пункт:

MCArt установка кодов

Этот инструмент нужен для задания стабильных кодов CRM-сущностям. Коды используются для корректного переноса настроек между стендами, чтобы миграции не зависели только от внутренних ID.

В инструменте доступны разделы:

1. Смарт процессы - Позволяет выбрать смарт-процесс без кода и задать для него код.

2. Категории смарт процессов - Позволяет выбрать категорию смарт-процесса без кода и задать для нее код.

3. Категории сделок - Позволяет выбрать категорию сделок без кода и задать для нее код.

Перед созданием миграций рекомендуется проверить, что у переносимых смарт-процессов и воронок заполнены коды.

Компоненты модуля

Модуль содержит компонент mcart:migration.code.setter.

Компонент используется внутри административного инструмента для установки кодов CRM-сущностей. Он не предназначен для самостоятельного размещения пользователем на публичных страницах сайта.

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

Удаление модуля

При удалении модуля доступны опции сохранения данных:

- Не удалять orm — сохраняет служебные ORM-таблицы модуля;
- Не откатывать sql — сохраняет данные, созданные SQL-скриптами модуля;
- Не удалять настройки — сохраняет настройки модуля.

Если эти опции не выбрать, соответствующие данные будут удалены при деинсталляции.