Перед тем как приступить к созданию нового атрибута, обязательно уточните у заказчика сценарий использования атрибута: Кто, Как и Где будет заполнять этот атрибут.
Для описания сценариев мы рекомендуем использовать job story вида: Когда ___, я хочу ___, чтобы ___. Например:
- Пользователь: Когда я регистрирую инцидент, хочу добавить скриншот прямо в текст, чтобы сотрудникам поддержки было понятно описание ошибки.
- Специалист первой линии: Когда я регистрирую заявку от пользователя по телефону, хочу добавить скрытую от пользователя пометку, чтобы помочь специалисту на следующей линии.
- Руководитель службы поддержки: Когда пользователь регистрирует заявку в личном кабинете, он должен видеть только основные параметры, чтобы ему не было сложно и он не звонил в контактный центр.
- Руководитель службы поддержки: Когда оператор регистрирует заявку по телефону, он должен обязательно указывать категорию обращения, чтобы упростить маршрутизацию на вторую и третью линии поддержки.
Такие сценарии помогут вам лучше понять контекст задачи, сделать настройку практичной и удобной всем участникам процесса.
- Определите круг пользователей, которым будет доступен атрибут, кто сможет его редактировать, а кто - только просматривать.
- Зафиксируйте процесс, в котором будет участвовать атрибут: кто, на какой карточке/форме и в рамках какой операции будет работать с атрибутом.
- Определите класс и тип, в который нужно добавить атрибут.
- Найдите карточки и контенты, на которые нужно добавить атрибут. Например, по требованиям заказчика вам нужно добавить в класс «Задача» атрибут «Отчёт о выполнении». В зависимости от детальных требований, его нужно вывести на карточку задачи, а также на списки с задачами.
- Проверьте наследование в типе: тип может полностью или частично наследовать настройки карточек и форм класса. Убедитесь, что все нужные вам контенты присутствуют в нужных типах, при необходимости - добавьте их.
- Отметьте, в какие группы нужно добавить атрибут, чтобы отобразить в соответствующих контентах.
Обязательно изучите существующие атрибуты, возможно, вы сможете переиспользовать системные атрибуты, или существующие пользовательские атрибуты, которые вы или другие технологи создали ранее.
Чаще всего можно переиспользовать строковые и текстовые атрибуты. Но в зависимости от сценария, это могут быть атрибуты любого типа данных.
- Перейдите в «Интерфейс технолога».
- Откройте карточку нужного класса/типа.
- Нажмите кнопку «Добавить атрибут» в разделе «Атрибуты класса»
- Заполните название атрибута, при этом постарайтесь выбрать максимально понятное именование, чтобы пользователь или специалист смогли разобраться с его назначением без пояснения.
- Заполните код атрибута латиницей в camelCase, при этом старайтесь обеспечить согласование названия и кода,например, если название атрибута - «Адрес доставки», то в качестве кода используйте «deliveryAddres» (здесь из-за ограничения максимально возможной длины кода в слове address опущена последняя s)
- Выберите тип значения атрибута согласно решаемой задаче, например, для атрибута «Описание решения» логично использовать текст в формате RTF, чтобы у специалиста была возможность подробно описать проделанную работу, а для атрибута «Адрес» - простой текст.
- Укажите, какими свойствами должен обладать атрибут, например, могут ли пользователи его редактировать и является ли он обязательным.
- При необходимости, настройте параметры валидация атрибута, например, скрипты фильтрации, маски и тп.
- Если у атрибута есть значение по умолчанию - зафиксируйте его в соответствующем поле или настройте скрипт.
- Нажмите кнопку сохранить.
- Если в процессе сохранения атрибута вы увидите окно с ошибкой - внимательно ознакомьтесь с ее текстом, из него будет понятно, что делать дальше.
Перейдите на вкладку «Группы атрибутов» и добавьте атрибут в нужные группы. Если в данный момент, атрибут нужен только для определенного типа объектов, тогда вначале перейдите на карточку нужного типа, а затем на вкладку «Группы атрибутов».
Внимание: атрибут автоматически пронаследуется в группы атрибутов всех дочерних типов.
В некоторых кейсах пользователь заполняет тот или иной атрибут при входе или выходе из конкретного статуса. Например, исполнитель задачи должен заполнять атрибут «Отчёт о выполнении» при входе в статус «Выполнено», а автор задачи, должен заполнять комментарий при выходе из статуса «Согласование стоимости».
Чтобы настроить эту логику, перейдите в на вкладку «Жизненный цикл» нужно класса/типа, затем откройте вкладку «Управление параметрами в статусах». Здесь вы можете настроить не только обязательное или опционально заполнение параметра на входе/выходе из статуса, но также и обязательность заполнения атрибута в статусе, а также его видимость, например, атрибут «Отчёт о выполнении» задачи можно отображать только в статусе «Выполнено», при этом отключить его во всех остальных статусах.
Откройте карточку нужного типа, затем перейдите в настройки соответствующего интерфейса, например, вкладку «Карточка объекта» или «Форма добавления». Проверьте, что нужный атрибут отображается там, где с ним должны работать пользователи. Если атрибута нет, вернитесь на Шаг 4 и проверьте, что добавили атрибут в нужную группу.
Перейдите на вкладку «Права доступа» и настройте права на просмотр и редактирование для нужных профилей. В зависимости от текущий настроек, вы можете добавить атрибут в новый или существующий маркер прав.
Дополнительно, вы можете настроить контекстный поиск, если кейс предполагает возможность поиска по атрибуту (например, поиск по «Адресу доставки» или «Отчету о выполнении»).
Подробнее о настройках поиска вы можете прочитать в документации по платформе: настройки поиска, ниже мы приводим краткую инструкцию:
- Перейдите на вкладку «Поиск».
- Найдите свой атрибут и нажмите на иконку в виде карандаша.
- Укажите, кому будет доступен поиск по этому атрибуту (лицензированные и нелицензированные сотрудники).
- Укажите вес атрибута при поиске.
- Выберите тип анализатора, например, точный анализатор удобно использовать для поиска по полному совпадению (инвентарный номер), а неточный - по частичному вхождению.
Внимание! За работу поиска отвечают специальные индексы, серверу может потребоваться время, чтобы проиндексировать все существующие объекты.
Вы можете проверять работоспособность используя модуль проверки прав, или авторизуясь от имени конкретных пользователей или тестовых учетных записей. В данной инструкции мы рассмотрим способ тестирования через модуль проверки прав.
- Перейдите в «Интерфейс оператора», затем включите модуль проверки прав под одним из участников процесса.
- Выполните стандартные операции текущего процесса, например, создайте заявку нужного типа, продвиньте ее по статусам.
- Проверьте, что пользователь видит новый атрибут согласно запланированному сценарию, а сам сценарий удовлетворяет задаче заказчиков.
- Проверьте, что реализованные изменения не блокируют работу других участников процесса, например, пользователи могут создавать заявки, не видят «лишних» параметров, могут комментировать и тп.
Если все работает хорошо, попросите ключевых сотрудников протестировать изменения, при необходимости, задокументируйте их в базе знаний.