Информационные системы

ООО «ГИНТЕЛЛ»

Руководство пользователя

Программа для ЭВМ «ДОКУМЕНТАТОР»

Оглавление
1.Введение
2.Термины и сокращения
3.Начало работы с системой
3.1 Вход в систему
3.2 Выбор схемы
3.3 Управление схемами
4.Вход в Схему и Общие сведения
4.2 Страница объектов схемы
4.3 Поведение при открытии объектов
5.Таблицы
5.1 Общий вид таблицы и интерфейс
5.2 Поведение полей и особенности заполнения
5.3 Проверки, ошибки и предупреждения
5.4 Фильтрация и сортировка данных в таблицах
6.Импорт и экспорт
6.1 Импорт данных
6.2 Экспорт данных

Версия документа


1.ВВЕДЕНИЕ
Программное обеспечение (ПО) «Документатор» предназначено для описания, хранения и обработки информации о геологических объектах — таких как скважины, горные выработки и другие элементы горно-геологической среды.

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

Функциональные задачи
·Стандартизация информации за счёт использования единых справочников и структур;
·Повышение достоверности данных с помощью настраиваемых правил проверок;
·Импорт и экспорт данных в популярных форматах;
·Работа в автономном режиме на пользовательском устройстве.

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

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

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


2.ТЕРМИНЫ И СОКРАЩЕНИЯ


3.НАЧАЛО РАБОТЫ С СИСТЕМОЙ
3.1. Вход в систему
Для начала работы пользователь должен активировать лицензию, введя код активации учетной записи на стартовом экране приложения.

В случае успешной активации необходимо авторизоваться в системе введя логин и пароль в соответствующие поля и, опционально, указать адрес подключения к Плите. Опционально можно подключить приложение к системе Плита, введя адрес в строку «Адрес Плиты».

Пример авторизации и заполнения Адреса Плиты

После успешного входа открывается окно выбора схемы.

В правом верхнем углу интерфейса доступна кнопка настроек приложения, где можно выбрать внешний вид интерфейса:

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

При выборе схемы в правой части экрана отображаются её краткое описание и кнопка «Открыть схему».

Дополнительно доступны следующие действия:
· Копирование схемы;
· Импорт схемы;
· Экспорт схемы;
· Удаление схемы.

3.3 Управление схемами
Пользователям дополнительно доступна функциональность по управлению схемами:
Копирование схемы:
· Выберите нужную схему;
· Нажмите кнопку с тремя вертикальными точками в правом нижнем углу боковой панели;

В открывшемся окне выберите действие «Копировать»;

Укажите уникальное название для новой схемы;
При необходимости включите опцию «Копировать с табличными данными» — это позволит перенести в новую схему все записи и настройки из таблиц исходной схемы;

Нажмите кнопку «Копировать» для завершения операции. Скопированная схема появится в списке доступных схем.

Импорт схемы:

• Импорт выполняется с помощью кнопки «Импортировать»;
• При нажатии на кнопку открывается окно проводника;
• Необходимо выбрать файл схемы в формате. json, экспортированный ранее;
• После выбора файл будет загружен, и схема появится в списке доступных для использования.

Экспорт схемы:

• Экспорт производится из того же меню, что и копирование — с помощью кнопки с тремя вертикальными точками в правом нижнем углу боковой панели;
• В открывшемся окне выберите действие «Экспортировать»;

• При подтверждении создаётся файл схемы в формате .json, пригодный для последующего импорта.

Удаление схемы:

• Удаление схемы осуществляется из меню, вызываемого кнопкой с тремя вертикальными точками в правом нижнем углу боковой панели;
• В открывшемся окне выберите действие «Удалить»;

• Удаление необратимо и приводит к потере всех объектов и данных схемы.

4. Вход в Схему и Общие сведения
4.2 Страница объектов схемы
После открытия схемы отображается основное окно с перечнем объектов, сгруппированных по типам:

• Таблицы — предназначены для ввода, просмотра и редактирования данных;
• Импорты — настроенные сценарии загрузки данных во внутренние таблицы;
• Экспорты — сценарии выгрузки данных из таблиц схемы во внешние источники или файлы;
• Наборы — группы импортов и/или экспортов, объединённые для запуска в одном потоке.

В открывшемся окне Вы увидите страницу Объектов существующей Схемы, разделённых по типу на Таблицы, Импорты, Экспорты, и Наборы.

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

4.3 Поведение при открытии объектов
· При выборе таблицы она открывается в режиме просмотра и редактирования данных (если администратором не установлено ограничение «только для просмотра»).
· При выборе объекта импорта или экспорта автоматически запускается соответствующий сценарий передачи данных.
Примечания:
·Настройка объектов и их параметров (структура таблиц, правила импорта и т.д.) выполняется администратором и недоступна пользователю.


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

5.1 Общий вид таблицы и интерфейс
После выбора таблицы открывается основное окно табличного представления данных. В верхней части окна отображается название таблицы. Ниже представлена структура с данными, организованными по строкам и столбцам. Боковая панель открывается при выборе или добавлении строки.

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

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

Некоторые особенности:
· Типы столбцов. Столбцы могут быть текстовыми, числовыми, логическими, датами, списками значений или формулами. Пользователь видит соответствующий редактор в панели ввода. Например, поле ввода для столбца «Интервал От».

· Формульные поля. Значения в таких столбцах рассчитываются автоматически на основе заданной логики. Они недоступны для редактирования. Например, поле «Длинна интервала» Рассчитывается автоматически и недоступна для редактирования

· Значения по умолчанию. Некоторые поля могут автоматически заполняться при добавлении строки (например, текущей датой, предыдущим значением или приращением).
· Списки значений. В полях со списками отображаются предустановленные варианты выбора. Их состав задаётся администратором. Например, выпадающий список доступных для выбора кодов пород.

Примечание:
Если поле недоступно для редактирования или заполняется автоматически, это означает, что соответствующее поведение было предусмотрено при настройке схемы.
Предупреждение о несохраненных данных
Если при редактировании строки в таблице вы попытаетесь перейти на другую строку, страницу или выйти из таблицы, не нажав кнопку «Сохранить», система предупредит о наличии несохраненных данных.
Это помогает избежать случайной потери изменений и позволяет выбрать: сохранить, отменить или выйти без сохранения.

5.3 Проверки, ошибки и предупреждения
Для обеспечения достоверности данных администратор схемы может настроить автоматические правила проверки.
При несоответствии введённых данных этим правилам:

Строки с ошибками не допускаются к экспорту. Строки с предупреждениями могут быть экспортированы, но потребуют подтверждения.
При исправлении ошибок в окне «Ошибки и предупреждения» отобразится следующее сообщение:

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


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

Фильтрация данных
Чтобы применить фильтр к таблице, нажмите кнопку с иконкой фильтра  в панели управления.
В открывшемся окне фильтров:

• выберите столбец, по которому нужно фильтровать;
• укажите тип фильтра (например, список, диапазон и т.д. — в зависимости от типа данных);
• выберите нужные значения или условия;
• при необходимости установите флажок «Глобальный фильтр».

Нажмите кнопку Применить для применения условий фильтрации.

Примечание:
Глобальный фильтр применяется ко всем таблицам схемы, где присутствует выбранный столбец. Это удобно, если вы работаете, например, только с одним участком — фильтр будет автоматически действовать во всех таблицах.
Сортировка данных
Для включения сортировки нажмите кнопку с иконкой , расположенную рядом с кнопкой фильтра.
В открывшемся окне сортировки доступна настройка одного или нескольких правил сортировки:
· выберите столбец;
· укажите направление сортировки (по возрастанию / убыванию, от А до Я)
· при необходимости добавьте дополнительные уровни сортировки.
· можно перетаскивать строки в списке, чтобы изменить приоритет сортировок.

Нажмите кнопку Применить для активации сортировки в таблице.

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

• Фильтрация и сортировка не изменяют данные в таблице — они влияют только на отображение данных.
• Настройки не сохраняются между сессиями и сбрасываются при перезапуске приложения.
• Типы доступных фильтров зависят от типа данных столбца.

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

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

Общие сведения:
· Объекты импорта предварительно настраиваются администратором;
· Пользователь запускает готовые импорты без возможности их редактировать;
· Один объект импорта связан с конкретной таблицей назначения.
· Пользователь может запускать импорт двумя способами.

Способы запуска импорта:
1. Через вкладку «Импорты»:
· Перейдите во вкладку «Импорты»;

· Выберите нужный объект из списка;
· Нажмите на него — откроется окно выбора файла (если импорт работает с файлами);
· Укажите путь к файлу и подтвердите запуск.

2. Напрямую из таблицы:
· Откройте нужную таблицу;
· Нажмите кнопку импорта  в панели инструментов;
· Выберите нужный объект импорта из списка;
· Нажмите кнопку «Импортировать».

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

Это подтверждает, что данные были загружены корректно.

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

6.2 Экспорт данных
Экспорт позволяет выгрузить данные из таблиц схемы во внешние файлы или базы данных.
Общие сведения:
· Объекты экспорта также настраиваются администратором;
· Один объект экспорта связан с конкретной таблицей;
· Пользователь может запускать экспорт двумя способами.

Способы запуска экспорта:
1. Через вкладку «Экспорты»:
· Перейдите во вкладку;

· Выберите нужный объект;
· Нажмите на него и укажите место сохранения файла (если необходимо).

Пример экспорта через вкладку «Экспорты»

2. Напрямую из таблицы:
· Откройте нужную таблицу;
· Нажмите кнопку экспорта в панели инструментов;
· Выберите один из доступных объектов экспорта;
· Нажмите кнопку «Экспортировать».

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

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

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

Поведение при проверках:
· Если в таблице есть ошибки — экспорт будет заблокирован;

· Если есть предупреждения — появится запрос подтверждения перед экспортом;