Как устроен CityScreen Deals

CityScreen Deals — настраиваемая платформа. Одни возможности — сделки, предложения, инвентарь, ценообразование — поставляются как фиксированные функции продукта и работают везде одинаково. Другие — виды документов, типы контрагентов, пользовательские поля, бизнес-процессы — определяет администратор каждой организации с помощью встроенной системы сущностей.

Чтобы читать остальную документацию, нужно понимать, какие части фиксированы, а какие настраиваются.

Организации

Организация в CityScreen Deals — это тенант: самостоятельное рабочее пространство со своими сотрудниками, инвентарём, сделками, типами сущностей, шаблонами и процессами. Каждая организация настраивается независимо. Что вы видите в своей организации, зависит от того, что настроил ваш администратор.

Сотрудник принадлежит ровно одной организации. Доступ сотрудника к данным внутри организации определяют роли и права, которые назначаются через группы сотрудников.

Что поставляется фиксированным

Следующие возможности входят в продукт, их нельзя изменить или удалить:

Сделки и этапы: Каждая сделка проходит фиксированную последовательность из 7 этапов: Заявка, Согласование, Резерв, Бронь, Оплачено, Выполнено и Отказ. Граф этапов фиксирован. Администратор может настроить названия, которые отображаются для каждого этапа, но сами этапы и их поведение остаются прежними.

Подробнее об этом — в разделах Сделки и этапы сделки.
Предложения и ценообразование: Сделка содержит одно или несколько предложений. Механизмы расчёта цены для цифровых размещений (частота, длительность, блоки, показы) и печатных размещений (суточные ставки, правила продажи) — фиксированная логика продукта. Ступени скидок, общие для организации лимиты скидок и ограничения скидок для отдельных клиентов встроены.

Структуру предложений и ценообразование описывает раздел Предложения.
Инвентарь: Цифровые экраны и печатные конструкции — полноценные объекты с фиксированным набором полей. Карта, таймлайн доступности и расчёты занятости — функции продукта.

Управление конструкциями и доступность описывает раздел Инвентарь.
Модель прав: Иерархия действий (чтение, изменение, удаление) и иерархия областей (свои, группа, все) фиксированы. То, как роли складываются и как права на уровне полей взаимодействуют с правами на уровне сущностей, — поведение продукта.

Модель описывает раздел Роли и права.
Вход и защита аккаунта: Политика паролей, двухэтапная проверка, защита от повторных неудачных входов, сессии и журнал входов есть в каждой организации. Никакая настройка их не отключает. Администратор выбирает их значения, например минимальную длину пароля и обязательность двухэтапной проверки.

Подробнее — в разделах Политика паролей и защита входа и Двухэтапная проверка.

Что настраивается для каждой организации

Следующее определяет администратор каждой организации. Организация начинает работу с механизмами продукта, а конкретику добавляет администратор.

Типы сущностей и пользовательские поля: Тип сущности — это схема, которая определяет вид записи: тип документа, тип контрагента, тип прайс-листа, тип отчёта или любую другую структурированную запись, нужную организации. У каждого типа сущности есть набор полей (в API они называются переменными): строки, числа, даты, ссылки на другие записи, множества, коллекции, словари или вычисляемые выражения.

Есть 8 супертипов, которые определяют, где отображается запись и как продукт с ней обращается: Документ, Контрагент, Справочник, Задача, Предложение, Прайс-лист, Отчёт и Группа сотрудников.

Этому механизму посвящён отдельный раздел Система сущностей.
Виды документов: Каждый счёт, договор, заказ на бронирование или кредит-нота в организации — это тип сущности, который определил администратор, с шаблонами и, при необходимости, бизнес-процессом, ведущим его жизненный цикл.

Работу с документами описывает раздел Документы.
Типы контрагентов: Клиент — один из видов контрагента. Администратор может задать дополнительные типы контрагентов для агентств, операторов наружной рекламы, субподрядчиков и любых других сторон, с которыми работает организация.

Эту тему описывает раздел Типы контрагентов.
Бизнес-процессы: Встроенный движок BPMN позволяет администратору моделировать и публиковать процессы, которые автоматизируют работу: назначение пользовательских задач, уведомления по электронной почте, формирование документов, обновление сущностей и переходы сделки между этапами. Процессы задаются для каждой организации и запускаются вручную или по событиям сущностей.

Моделирование и запуск процессов описывает раздел Автоматизация процессов.
Критерии: Критерии — это метки, которые можно присваивать сделкам, клиентам и позициям инвентаря. Доступные критерии задаёт администратор; отделы продаж используют их для фильтрации и сегментации.

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

Каждую настройку описывает раздел Настройки организации.
Сервисы идентификации (по лицензии): Приложения OAuth, OpenID Connect, LDAP-справочник, персональные токены доступа и пароли приложений позволяют другим программам обращаться к CityScreen Deals, входить в него от имени сотрудников или читать его справочник. Эти функции лицензируются. Если ваша лицензия их не включает, обратитесь в CityScreen. Приложения OAuth и потребителей LDAP регистрирует администратор, а токены и пароли приложений каждый сотрудник создаёт себе сам.

Их перечень приведён в разделе Идентификация и доступ к API.

Система сущностей как основа

Многие разделы документации описывают функции, внешний вид которых зависит от настроек администратора. Документы, контрагенты, отчёты и прайс-листы построены на типах сущностей. Страница, описывающая один из таких механизмов, содержит примечание со ссылкой на систему сущностей, чтобы вы могли увидеть, как устроена базовая структура.

Связь такая:

Тип сущности определяет вид записи и относится к одному из 8 супертипов.
Переменная (в интерфейсе — «тип данных») определяет поле типа сущности: его название, тип данных и поведение.
Запись — один экземпляр типа сущности со значениями для каждой из его переменных.

Эта трёхуровневая структура — тип, переменная, запись — повторяется во всех настраиваемых областях продукта.