Рекомендации для разработчиков
В этой статье вы найдете общие рекомендации для всех разработчиков функциональности решений SimpleOne.
Перед началом работы
Перед началом работы с экземпляром, создайте отдельные пользовательские аккаунты для разработчиков. Одновременная работа нескольких разработчиков с одного и того же аккаунта может привести к коллизиям и другим нежелательным последствиям.
После создания аккаунтов, необходимо дать им следующие роли: admin, security_admin, impersonator.
Особенности работы с локальными пакетами
Следуйте следующим рекомендациям при создании локальных пакетов:
- Собирайте изменения по каждой задаче в отдельный локальный пакет.
- Название локального пакета должно содержать акроним приложения и короткое описание задачи.
- Заполняйте поля Описание и Название, чтобы предоставить всю необходимую информацию по пакету. В поле Название можно добавить до 80 символов.
| Рекомендация | Пример |
|---|---|
| Рекомендуется | Добавление переводов названий всех кнопок в таблице Задачи |
| Не рекомендуется | Последние исправления |
Для удобства всех разработчиков рекомендуем помещать номер задачи в название локального пакета, например: [ITSM] - Incident notification fixes - INC0001234.
Не выполняйте никакие конфигурационные изменения в локальном пакете Default.
Политика защиты записей
После завершения разработки убедитесь, что:
- В локальном пакете нет никаких лишних изменений.
- Ни одна из версий записи не имеет значения Изменена в поле Политика защиты записи.
- При наличии таких записей, откройте бургер-меню на странице вверху слева. Нажмите Экспортировать → Как новое приложение. Атрибуты записи будут исправлены автоматически.
При формировании локального пакета, содержащего изменения любого объекта приложения, созданного вендором, не меняйте значение поля Политика защиты записи на Открыта для записей. Это может привести к утере статуса версии при обновлении приложения.
Не меняйте "коробочную" конфигурацию, чтобы избежать конфликтов при обновлении версии приложения от вендора. Если вам необходимо изменить такую конфигурацию, выполните следующие шаги:
- Скопируйте конфигурацию, которую необходимо обновить. Для этого откройте бургер-меню слева наверху страницы и выберите Сделать копию.
- Отключите исходную конфигурацию:
- Вернитесь на страницу формы этой конфигурации.
- Снимите флажок Актуальная.
- Нажмите Сохранить или Сохранить и выйти, чтобы сохранить изменения.
- Внесите изменения в созданную копию (не в оригинальную запись).
Тестирование конфигурационных пакетов перед установкой
Избегайте настройки приложений непосредственно на рабочем экземпляре, когда доступен экземпляр для разработки. Сначала объедините все изменения в конфигурационные пакеты на экземпляре разработки. После этого разверните их на тестовом экземпляре (если он у вас есть). Развертывание на рабочем экземпляре должно быть последним шагом после устранения всех ошибок и коллизий.
Такой подход обеспечивает быстрое решение проблем на экземпляре разработки без риска простоя рабочего экземпляра.