Карточка информационного объекта или документа v2.0

Документ

Документ - это информационный объект платформы Carabi Solutions Web, который описывает конкретный элемент предметной области. Документ имеет уникальный в системе идентификатор, структурированный набор атрибутов и полей, может иметь связи с другими Документами и описывается через Карточку документа. Над Документом могут совершаться различные действия в зависимости от настроенных бизнес-процессов в системе.

Карточка документа

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

Пример Карточки документа

Структура карточки документа

Идентификатор документа
Вид документа
Статус документа
Панель управления документом:
- Навигатор
- Действия
- Отчеты
- Обновить
- Журнал
- Задачи
- Вложения
- Комментарии
Поля описывающие основное содержимое документа
Вкладки дополнительной информации о документе

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

Идентификатор документа - уникальный номер Документа на всей платформе Carabi Solutions Web, позволяющий отличать его от других Документов. Идентификатор часто используется для поиска требуемого Документа в системе.

! Используйте Идентификатор документа в сообщении администратору платформы Carabi Solutions Web, если обнаружена ошибка, связанная с конкретным документом.

Вид документа

Вид документа - конкретный элемент предметной области, который создается специалистами Carabi Solutions Platform на стадии проектирования бизнес-процессов, организованных в предприятии и реализованных в Carabi Solutions Platform.

Примеры Видов документов

Клиент
Заказ
Договор
Склад
Сотрудник
Номенклатура
График работ
Накладная
Остатки склада
Комплектация изделия

Статус документа

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

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

1.Для бизнес-процесса Согласование договора:

Создан
Оформлен
Подтвержден
Отклонен
В архиве

2.Для бизнес-процесса Комплектация изделия на производстве:

Создан
Подготовлен
Оформлено конструктором
Обрабатывается технологом
Актуализировано технологом
Корректировка технологом

Панель управления документом

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

Навигатор

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

Действия

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

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

Отчеты

Кнопка Отчеты отображается в Панели управления документом при наличии хотя бы одного созданного отчета для этого Документа. На состав списка Отчетов влияет Вид документа, Статус документа и Роль пользователя. Пример:

Обновить

Кнопка Обновить позволяет обновить данные в документе.

Встречаются ситуации, когда вы работаете в документе и, в то же время, какие-либо процессы или другие пользователи меняют данные связанные с вашим документом. Например, вы находитесь в документе "Счет", и ждете оплаты этого счета бухгалтером. Бухгалтер оплачивает счет и переводит статус документа "Счет" в "оплачен". Чтобы увидеть смену статуса, вам нужно либо перезайти в документ, либо нажать на кнопку "Обновить".

Журнал

Журнал сохраняет историю изменений Документа. На вкладке "Статусы" можно увидеть историю по изменению Статуса документа:

На вкладке Журнала "Значения" вы можете посмотреть историю изменений значений полей Документа:

Задачи

Вложения

Нажав на кнопку Вложения появится окно для прикрепления файлов к Документу. По кнопке "Добавить" можно прикрепить один или несколько файлов из файловой системы устройства, на котором вы работаете:

После добавления файлов на кнопке Вложения будет указано количество прикрепленных к Документу файлов:

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

! После скачивания файлы попадут в папку, которая в вашей операционной системе по умолчанию предназначена для загруженных файлов из интернета. Например, для Windows 10, это папка называется "Загрузки".

Если файлов достаточно много для загрузки их по одиночке, то можно выделить требуемые файлы галочками и нажать на кнопку "Скачать архивом":

При необходимости, файл из документа можно удалить, нажав на иконку "Корзина":

Комментарии

Если требуется оставить какой-либо неформальный, текстовый комментарий к Документу, то для этого предназначена кнопка Комментарии. При нажатии на кнопку Комментарии в правой части окна Карточки документа появится окно с историей комментариев пользователей и кнопкой добавления комментария:

Добавление Документа на Рабочий стол

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

Содержимое документа

Содержимое каждого Документа описывается с помощью набора информационных полей различного типа. Набор полей создается для каждого определенного Вида документа разработчиками Carabi Solutions Web.

Примеры типов информационных полей Документа:

Число
Текст
Дата
Справочник
Ссылка на другой Документ
и т.д.

Подробнее про поля Документа смотрите ...

Для удобства, поля Документа разделены на две группы:

Основная информация по документу
Дополнительная информация о документе сгруппированная по вкладкам

Основная информация по документу

Используется для отображения наиболее важных для пользователя данных.

Дополнительная информация о документе

Часто для удобства пользователя в Карточке документа требуется отобразить расширенную информацию о документе. Примеры:

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

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

Наименование выбранной активной вкладки выделено синим цветом с нижним подчеркиванием:

Информация на вкладке может быть представлена двумя способами:

Одиночный Документ с отображением полей
Список Документов с отображением в виде таблицы

Пример вкладки с полями одиночного документа

Для строительного заказа во вкладке "Объект работ" размещено подробное описание проекта в виде набора полей:

Пример вкладки со списком документов

Нужно показать Документ "Накладная" вместе с составами накладной. Тогда составы накладной можно разместить в виде таблицы во вкладке "Состав накладной". Каждая строка таблицы представляет собой информацию по одному составу накладной:

В этом случае можно кликнуть по любому Составу накладной и в соседней вкладке приложения откроется Документ "Состав накладной". Работу с представлениями Документов в виде таблицы подробнее смотрите ...

! Отображение набора информационных полей и вкладок Карточки документа могут различаться в зависимости от роли пользователя. При необходимости, для изменения Карточки документа или прав доступа для роли пользователя обратитесь к администратору платформы Carabi Solutions Web.

Информационные поля документа

Особенности информационных полей Документа:

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

У информационного поля есть наименование и значение:

Значение поля – это конкретные данные, хранимые в поле.

Например, каждый Документ "Физическое лицо" соответствует некоторому конкретному физическому лицу. У одного Документа поле с наименованием "Фамилия" обладает значением - "Иванов", у другого Документа может быть значение "Петров", у третьего - "Сидоров" и т.д.

Типы данных полей

Данные, хранимые в значениях полей, могут быть различных типов.

Простой тип данных
Является базовым типом и предназначен для хранения значений простых типов. Например:

Число
Текст
Дата
Денежный
Телефон
Да/Нет

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

Число:

Текст:

Дата:

Редактирование поля типа Дата:

Словарный тип данных
Представляет собой словарь, список всех возможных значений некоторых данных, которые должны быть описаны точно и однозначно. При нажатии на поле, которое содержит словарное значения, открывается выпадающее окно, где следует выбрать нужное значение или множество значений из словаря и нажать кнопку "Применить". Например, поле словарного типа "Условия оплаты":

! Если необходимо изменить состав словарного поля, то обратитесь к администратору платформы Carabi Solutions Web.

Ссылочный тип данных

Ссылочный тип данных - это такой тип данных поля в Документе, который не содержит самих значений, он ссылается на другой Документ на платформе Carabi Solutions Web.

Наличие в Документе поля ссылочного типа означает, что между несколькими Документами устанавливается логическая связь. Связи могут быть двух типов:

Связь “Один к одному” - когда по ссылочному полю Документа устанавливается связь только с одним другим Документом. Например, Документ "Договор" может ссылаться только на один Документ "Заказчик", т.к. у договора всегда только один заказчик.
Связь “Один ко многим” - когда по ссылочному полю Документа устанавливается связь с множеством других Документов. Например, Документ "Накладная" может ссылаться на множество Документов "Состав накладной".

Примеры связей и их отображения в Карточке документа

1.Так выглядит связь "один к одному" в Навигаторе Карточки документа:

Для изменения ссылочного поля нужно кликнуть по нему:

Откроется окно с выбором всех доступных Документов вида "Заказчик". Здесь можно либо выбрать один Документ, либо создать новый по кнопке "Новый документ":

2.Так выглядит связь "один ко многим" в Навигаторе Карточки документа:

Если в Карточке документа требуется отобразить ссылку "один ко многим", то для этого используются вкладки в нижней части экрана. Так выглядят составы накладной в Карточке документа "Накладная":

Тип данных - медиа-поле

Тип данных - отображение из другого объекта

Иногда в Документе следует отобразить информацию из другого Документа для справки, без возможности редактирования этого отображаемого поля.

Обязательность заполнения полей

Бывают обязательные к заполнению поля и необязательные. При создании и сохранении документа система проверяет, все ли обязательные поля заполнены. Если хотя бы одно обязательное поле не заполнено, то система выдает предупреждение и не сохраняет Документ.

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

Действия с полями и уровни доступа по редактированию

В зависимости от Роли пользователя и статуса Документа поля могут быть доступны к редактированию и недоступны к редактированию.

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

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

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

Управляющие элементы поля

В правой части поля, в зависимости от типа данных и доступа, могут располагаться управляющие полем элементы.

- элемент "Корзина" отвечает за очистку значения поля

- этот элемент может находится только в ссылочном поле.

Если кликнуть на элемент, то сразу открывается Документ, на который установлена ссылка:

Если кликнуть по значению поля, то открывается список Документов, для установления ссылки на нужный Документ:

Сохранение документа
После изменения значений полей документа необходимо нажимать кнопку "Сохранить", расположенной в правом углу экрана.

Стадии документа

Стадия документа - это свойство документа, которое отражает информацию о том, в каком состоянии на данный момент времени он находится. Стадия документа связана со спецификой его обработки в бизнес-процессе предприятия.

Текущая стадия документа отображается в левой верхней части карточки документа.

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

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

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

Смена стадии документа
Для изменении стадии вручную необходимо нажать кнопку "Действия" и выбрать нужную стадию.

Например, переведем документ "Маршрутный лист" из стадии "В подготовке" в стадию "Оформлен". В данном случае согласно логике бизнес-процесса составление маршрутного листа было завершено логистом и маршрутный лист готов к выдаче водителю для доставки груза.

Изменения стадий (журнал)
Историю изменения стадий документа можно просмотреть с помощью журнала.

Отчеты по документу
Система отчетов Carabi позволяет получить необходимые данные из системы в упорядоченном виде для последующего анализа, контроля и принятия управленческого решения. Отчеты по документам предназначены для просмотра запрашиваемых данных с помощью внешних приложений. Отчеты могут быть получены в популярных форматы "Word", "Excel", "PDF".

Виды отчетов
Одиночный отчет - это бланк-форма исходящего или внутреннего печатного документа (например, товарная накладная).

Групповой отчет содержит аналитически обработанные в Carabi данные множества документов, подготовленные в электронном виде для просмотра или печати (например, анализ продаж).

Данный раздел посвящен одиночным отчетам. Групповые отчеты описываются отдельном разделе.

https://docs.carabisol.ru/link/4#bkmrk--30

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

Для получения отчета по документу, необходимо нажать кнопку "Отчеты".

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

Доступ к отчетам для различных пользователей может различаться в зависимости от роли пользователя.

Для добавления необходимых отчетов обратитесь к Вашему бизнес-аналитику.