Сущности Comindware Platform. Определения и термины

Здесь представлены определения основных понятий, сущностей и терминов, используемых в Comindware Platform.

Для терминов, встречающихся в API, формулах, выражениях N3 и C#-скриптах, по необходимости указаны английские синонимы.

А

Аккаунт

Учётная запись пользователя в системе, обеспечивающая идентификацию и контроль доступа пользователя к ресурсам Comindware Platform.

Аккаунт содержит данные пользователя, такие как имя пользователя (логин), пароль, Ф. И. О, адрес эл. почты, телефон, изображение профиля и т. п.

Аккаунты могут быть привязаны к шаблонам аккаунтов для хранения дополнительных атрибутов.

См.:

• Аккаунты. Администрирование, назначение лицензий
• Шаблон аккаунта

Атрибут

Простейший элемент данных об объекте, аналог поля в реляционной базе данных.

Атрибуты и их значения хранятся в шаблонах.

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

Для ввода и просмотра значений атрибутов используются поля на формах и в таблицах.

Термины в API:

• property

См.: Атрибуты. Определения, типы, настройка, архивирование, удаление

В

Виджет

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

Набор и расположение виджетов определяется конфигурацией страницы (дашборда).

См.: Информационные страницы. Определения и настройка

Витрина

Информационный блок на странице (дашборде), показывающий данные в виде наглядного набора плиток.

На витрине можно настроить фильтры, визуальное представление и состав плиток.

См.: Информационные страницы. Определения и настройка

Вкладка

Область на форме или странице (дашборде), которая позволяет сгруппировать поля, вложенные формы и другие элементы.

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

См.: Статические элементы формы: области, вкладки, колонки, статичный текст. Настройка представления

Выражение

Конструкция, написанная на одном из поддерживаемых языков (язык формул, язык N3, язык C# или таблицы DMN), которая выполняет вычисления, проверки или операции с данными.

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

См.:

• Редактор выражений. Использование
• Язык N3. Справочник
• Язык формул. Справочник
• Скрипты на C#. Справочник

Д

Диаграмма процесса

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

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

Диаграмма привязана к шаблону процесса и создаётся вместе с ним.

Термины в API:

• scheme

См.:

• Диаграмма процесса. Определения, просмотр, редактирование, публикация
• Шаблон процесса

З

Запись

Набор данных (значений атрибутов) о некоторой сущности.

Запись представляет собой аналог строки в реляционной базе данных.

Записи могут быть представлены в виде таблиц и форм.

Термины в API:

• record

См.: Шаблон записи

Задача

Элемент процесса, который должен быть выполнен пользователем или системой.

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

При завершении задачи токен переходит к следующему элементу на диаграмме процесса.

Задачи могут содержать формы для ввода данных и правила для их обработки.

Термины в API:

• UserTask
• task

См.:

• Пользовательская задача
• Задача-выполнение сценария
• Задача-вызов сервиса

И

Идентификатор

Уникальный признак объекта, по которому его можно отличить от других.

Идентификатор аналогичен ключевому полю в реляционных базах данных.

Идентификатор представляет собой строку и формируется автоматически для каждого объекта при его создании.

Идентификаторы используются в выражениях на N3, формулах, C#-скриптах, вызовах API, HTTP-запросах.

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

См.:

• Идентификаторы и системные имена
• Форматы идентификаторов

Информационная страница (дашборд)

Страница для отображения сводных данных из приложений.

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

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

См.: Информационные страницы. Определения и настройка

К

Кнопка

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

Для каждого шаблона предусмотрен отдельный набор кнопок.

Названия, цвета и значки кнопок настраиваются в области кнопок, а не на самой кнопке.

Термины в API:

• user command.

См.: Кнопки. Определение, настройка, удаление

Область кнопок

Набор кнопок, расположенный на таблице, форме или области формы.

В области кнопок настраиваются названия, цвета, значки и порядок отображения кнопок.

Каждый шаблон содержит области кнопок, используемые по умолчанию для форм и таблиц. При настройке формы или таблицы ей можно назначить другую область кнопок.

См.: Области кнопок. Определение, настройка, клонирование, удаление

П

Переменная приложения

Атрибут с заданным значением, которые не привязаны к какому-либо шаблону.

Переменные приложения можно использовать в C#-скриптах и выражениях на языке N3 в любом шаблоне или сценарии.

Переменные одного приложения доступны во всех остальных приложениях.

См.: Переменные приложения. Просмотр списка, настройка и использование

Пользователь

Пользователь — это человек, работающий в Comindware Platform под своим аккаунтом и выполняющий задачи в приложениях.

Доступ пользователя к данным и функциям Comindware Platform определяется его аккаунтом, назначенными группами, ролями и правами доступа.

См.: Аккаунты. Администрирование, назначение лицензий

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

Совокупность всех разрешений, предоставленных аккаунту или группе аккаунтов.

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

См.: Роли в приложении. Определения, настройка, объединение, удаление

Поле

Элемент формы или таблицы, привязанный к атрибуту и предназначенный для ввода и отображения значений атрибута.

При перетаскивании атрибута на форму или в таблицу создаётся поле или столбец, представление которого зависит от типа атрибута.

Поля могут иметь различные режимы доступа: требовать ввод, разрешать ввод, только чтение или быть скрытыми.

См.: Динамические элементы формы: поля атрибутов и вложенные формы. Настройка представления

Приложение

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

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

Термины в API:

• solution;
• container

См.: Приложения. Определения, создание, настройка, администрирование, удаление

Р

Раздел навигации

Набор пунктов, позволяющих переходить к сущностям Comindware Platform, например формат, таблицам, страницам, рабочему столу, внутренним и внешним страницам.

Разделы навигации отображаются в панели навигации.

Отображение разделов навигации определяется правами доступа аккаунта текущего пользователя.

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

Роль

Совокупность разрешений, назначенная аккаунту или группе аккаунтов.

См.: Роли в приложении. Определения, настройка, объединение, удаление

Разрешение

Полномочие на совершение определённого действия с объектом: полный доступ, создание, просмотр, изменение, удаление и т. п.

Разрешения задаются в ролях для конкретных ресурсов и определяют, какие действия может выполнять пользователь с определённым аккаунтом в Comindware Platform.

См.: Роли в приложении. Определения, настройка, объединение, удаление

С

Системное имя

Признак объекта, уникальный и отличающий его от других объектов в заданном контексте.

Системное имя аналогично имени объекта или переменной в программировании.

Системное имя задаёт создатель объекта. Оно является более наглядным, чем идентификатор.

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

Термины в API:

• alias;
• global alias (глобальный псевдоним) — путь к объекту, состоящий из его типа, имени родительской системы и имени системы объекта.

См.: Идентификаторы и системные имена

Связанная запись

Связанная запись — это запись из другого шаблона записи, на которую ссылается атрибут типа «Запись». Атрибут типа «Запись» содержит одну или несколько ссылок на записи в связанном шаблоне записи. Связанные записи могут отображаться в полях на формах и в таблицах в виде гиперссылок или простого текста с заголовком записи.

См.: Атрибут типа «Запись»

Сценарий

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

Помимо обработки данных внутри Comindware Platform сценарии позволяют обмениваться данными с внешними системами.

Сценарий составляется из блоков с помощью визуального конструктора.

Термины в API:

• event;
• trigger;
• behaviour

См.: Сценарии. Определения, создание, настройка, использование

Т

Таблица

Представление данных в виде столбцов и строк.

Строка таблицы содержит данные одной записи шаблона.

Столбец таблицы содержит значения одного атрибута записей.

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

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

Термины в API:

• dataset;
• vew

См.: Таблицы. Определения, настройка, клонирование, удаление

Токен

Маркер текущей позиции выполнения процесса в нотации BPMN.

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

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

См.: Диаграмма процесса. Определения, просмотр, редактирование, публикация

Ф

Форма

Веб-страница для ввода и отображения данных.

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

См.: Формы. Определения, редактирование, удаление

Флажок

Элемент управления на форме или в таблице, состояние которого соответствует логическому (булеву) значению true или false.

Пользователь может установить (true) или снять флажок (false).

См.: Атрибут типа «Логический»

Ш

Шаблон

Основной элемент приложения, который определяет свойства и модель бизнес-сущности или процесса.

Шаблон содержит атрибуты, формы, таблицы, кнопки и другие компоненты для работы с данными и процессами.

Шаблоны служат для хранения и обработки записей (бизнес-данных) и экземпляров процессов.

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

Шаблоны могут быть связаны между собой аналогично реляционной модели.

Термины в API:

• template;
• container

См.: Шаблоны. Определения, настройка, перенос, архивирование, очистка

Шаблон аккаунта

Шаблон для определения и хранения особых атрибутов аккаунтов, изначально не предусмотренных в Comindware Platform.

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

См.: Шаблон аккаунта

Шаблон записи

Шаблон для определения модели, хранения и обработки данных бизнес-сущностей.

Шаблон записи представляет собой аналог таблицы в реляционной базе данных.

См.: Шаблон записи

Шаблон модели

Шаблон для определения свойств и хранения моделей и элементов корпоративной архитектуры.

Шаблон модели содержит атрибуты, формы и другие данные модели.

Элементы корпоративной архитектуры (процессы, группы процессов, задачи, события, оргединицы и т.п.) хранятся как записи в шаблонах моделей.

Шаблон модели процесса можно преобразовать в шаблон автоматизированного процесса.

См.: Шаблоны моделей

Шаблон оргединицы

Шаблон для определения модели и хранения данных организационных единиц.

Записи в шаблоне оргединиц описывают организационную структуру предприятия.

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

См.: Шаблон организационной единицы

Шаблон роли

Шаблон для определения и хранения особых атрибутов ролей.

В шаблон роли можно добавить дополнительные атрибуты ролей, изначально не предусмотренные в Comindware Platform.

В каждом приложении предусмотрен один системный шаблон роли под названием «Справочник ролей», который создается автоматически.

См.: Шаблон роли

Шаблон процесса

Шаблон для описания и исполнения бизнес-процессов.

Шаблон процесса содержит диаграмму процесса в нотации BPMN 2.0 и свойства, определяющие логику выполнения процесса.

Каждый шаблон процесса должен и может быть связан только с одним шаблоном записи.

В шаблоне процесса хранятся запущенные экземпляры процесса.

См.: Шаблон процесса

Э

Экземпляр процесса

Конкретный процесс, запущенный и выполняемый на основе шаблона и диаграммы процесса.

Каждый экземпляр процесса выполняется по определённой версии диаграммы процесса и связан с конкретной записью, хранящейся в связанном шаблоне записи.

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

Экземпляры процессов могут взаимодействовать друг с другом и с внешними системами.

См.:

• Использование диаграммы экземпляра процесса
• Шаблон процесса
• Диаграмма процесса. Определения, просмотр, редактирование, публикация

Термины, используемые в API

В документации API и Swagger используются следующие термины:

• activity — элемент диаграммы процесса;
• alias — системное имя;
• behaviour — сценарий, элемент диаграммы процесса;
• container — шаблон, приложение;
• dataset — таблица в шаблоне;
• global alias (глобальный псевдоним) — путь к объекту, состоящий из его типа, имени родительской системы и имени системы объекта;
• inline — особый тип документа, который отображается на форме как текстовый блок и который можно редактировать в форме;
• list — массив;
• object — набор пар свойство/значение;
• property — атрибут;
• record — запись;
• revision — версия файла, прикреплённого к атрибуту;
• scheme — диаграмма процесса;
• solution — приложение;
• stream — файл, хранящийся в системе;
• template — шаблон;
• transfer — управление версиями приложения;
• trigger — термин в продукте не используется, но есть в URL и некоторых API;
• user command — кнопка;
• view — таблица;
• worker — системный сервис.