АС Автоматизированная система

САУП Система автоматизированного управления проектированием

ПО Программное обеспечение

SD Service Desk 

АННОТАЦИЯ

Документ содержит руководство пользователя системы автоматизированного управления проектированием (далее по тексту — САУП) и отражает её основные функциональные возможности. Документ разработан и включен в комплект рабочей документации в соответствии с требованиями ГОСТ Р 34.601–90 «Автоматизированные системы. Стадии создания», ГОСТ Р 59795– 2021 «Информационные технологии. Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Требования к содержанию документов».

1. ВВЕДЕНИЕ

1.1. Область применения средства автоматизации

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

1) Организация единого хранилища система класса CAD: САУП автоматизирует процесс организации доступа к единому хранилищу CAD систем с возможностью последующего использования программных продуктов.

2) Управление доступами к внутрикорпоративным АС и сервисам: САУП оптимизирует процесс предоставления доступа и авторизации в общедоступных корпоративных сервисах и профильных системах.

3) Подбор сервисов для исполнения должностных обязанностей: САУП реализует бесшовную интеграцию внедренных сервисов и систем, формируя единые информационный периметр и комплексную базу программных продуктов.

4) Управление процессом обращений в SD: САУП позволяет реализовать комплексный подход к формированию обращений в техническую поддержку по всем доступным системам в рамках разработанного ПО.

Область применения САУП обширна и может адаптироваться под различные сценарии бизнеса. В данном случае, для группы компаний солнечного бизнеса, САУП может эффективно управлять внутренними процессами, в том числе проектированием.

1.2. Краткое описание возможностей средства автоматизации

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

1) Управление проектированием:

Создание, хранение и управление объектами деятельности проектирования компонентов.

2) Управление доступами:

Организация бесшовной аутентификации между интегрированными системами и сервисами.

3) Управление программными ресурсами:

Консолидация доступных автоматизированных систем и сервисов в едином информационном ресурсе.

Интеграция с другими информационными системами предприятия.

4) Информационная безопасность:

Защита данных и обеспечение конфиденциальности, целостности и доступности информации.

Соблюдение стандартов безопасности и законодательства по защите информации.

Ниже приведено описание минимального уровня подготовки пользователя:

Владение базовыми навыками работы со стандартным (веб-браузер, офисные пакеты, редакторы, и т.п.) и специализированным ПО (CAD, BI системы).

САУП предназначена для автоматизации широкого спектра деятельности и функций в организации. Ниже приведены основные виды деятельности и функций, для которых предназначено данное средство автоматизации:

1) Управление проектированием:

САУП автоматизирует процесс организации доступа к единому виртуальному хранилищу CAD систем с возможностью предоставления доступа к использованию программных продуктов.

2) Управление доступами:

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

3) Подбор сервисов для выполнения должностных обязанностей:

САУП реализует бесшовную интеграцию внутригрупповых сервисов, доступных в режиме «единого окна»;

4) Управление процессом обращений в SD:

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

5) Автоматизация процессов:

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

6) Интеграция с другими информационными системами:

Обеспечение совместимости и взаимодействия с другими информационными системами компании.

Операционная среда и общесистемные программные средства:

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

ПО: Веб-приложение САУП, разработанное с использованием JavaScript, NodeJS, HTML и др.

Входная информация:

Учетные данные пользователя: уникальные идентификатор пользователя в соответствии с Active Directory и набор символов для аутентификации и авторизации в системе.

Требования к подготовке специалистов:

Администраторы: Необходимы специалисты по обслуживанию серверной инфраструктуры, знакомые с установкой, настройкой и обновлением операционных систем и баз данных.

Пользователи: Обучение пользователей работе с интерфейсом системы и индивидуальной настройки системы.

Прочие условия:

Интеграция с другими системами: Возможность интеграции с существующими системами предприятия для оптимизации процесса получения доступа и первичной настройки ПО.

Безопасность данных: Реализация механизмов аутентификации и авторизации для защиты конфиденциальных данных.

Условия применения:

Надежность и доступность: Обеспечение непрерывной работы системы с минимальным временем простоя.

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

3. ПОДГОТОВКА К РАБОТЕ

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

1) Исполняемые файлы программ:

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

Клиентская часть: Файлы, предназначенные для установки на компьютеры пользователей и обеспечивающие интерфейс взаимодействия с системой.

2) Конфигурационные файлы:

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

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

3) Справочная и документационная информация:

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

Техническая документация: Описание архитектуры системы, принципов работы, структуры базы данных и прочие технические аспекты.

4) Установщики и обновления:

Установщики программ: Файлы, необходимые для установки серверной части системы.

Файлы обновлений: Пакеты данных, предназначенные для обновления программных компонентов серверной составляющей до новых версий.

5) Лог-файлы:

Логи серверной части: Файлы, в которых фиксируются события, происходящие на стороне сервера, для отслеживания ошибок, производительности и безопасности.

6) Формат носителя данных :

CD, DVD или USB-накопители: Физические носители для дистрибуции программ и данных.

Порядок загрузки программ и данных для веб-приложения САУП выглядит следующим образом:

1) Подготовка к установке:

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

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

2) Регистрация и авторизация:

Пользователь проходит процесс авторизации в системе по своей доменной учётной записи (рис. 1).

Экранная форма авторизации пользователя в системе:

Рисунок 1 - Страница авторизации*

3) Интерфейс веб-приложения (Рис. 2):

После успешной авторизации, пользователь видит интерфейс веб- приложения.

Рисунок 2 - Основная экранная форма САУП*

4) Настройка параметров:

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

Запуск «CAD системы» из меню происходит по следующему алгоритму: САУП автоматически реализует механизм организации доступа к системам класса CAD при нажатии на соответствующую кнопку. Для минимизации ручных действий рекомендуется единоразово установить следующие надстройки:

Перейти в окно загруженных файлов браузере:

В модальном окне загруженных материалов найдите файл с наименованием «КАД системы» и кликните правой кнопкой мыши. Из выпадающего списка выберете «Всегда открывать файлы этого типа»:

5) Обучение и поддержка:

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

6) Тестирование функционала:

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

7) Внедрение в работу:

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

8) Техническая поддержка и обновление:

Предоставляется техническая поддержка для решения возможных

проблем.

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

включать улучшения и новые функции.

3.3. Порядок проверки работоспособности

Порядок проверки работоспособности САУП включает следующие этапы:

1) Запуск веб-клиента в веб-браузере:

Проверка доступности страницы веб-приложения в веб-браузере.

2) Авторизация и аутентификация:

Вход пользователя в систему под доменной учётной записью.

3) Интерфейс пользователя:

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

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

Для завершения активного сеанса в САУП необходимо левой кнопкой мыши кликнуть по кнопке "Выйти" в правом верхнем углу экранной формы выбора сервиса.

4. ОПИСАНИЕ ОПЕРАЦИЙ

1) Вход в систему:

Для входа необходимо перейти по предоставленному администратором веб-адресу.

Необходимо ввести свой логин и пароль от доменной учётной записи

для авторизации в системе.

2) Обзор интерфейса:

После прохождения авторизации открывается главная страница, на которой представлены доступные пользователю сервисы (рис. 2).

3) Управление проектированием:

Необходимо кликнуть по кнопке «CAD системы».

4) Интеграция корпоративных систем:

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

5) Выход из системы:

Для выхода из системы необходимо нажать кнопку «Выход» в правом верхнем углу интерфейса.

*подробное описание с примерами иллюстраций интерфейса системы вы найдете в разделе База знаний нашего сайта

ОБОЗНАЧЕНИЯ И СОКРАЩЕНИЯ

САУП Система автоматизированного управления проектированием

ПО Программное обеспечение

АС Автоматизированная система

АСУП Автоматизированная система управления предприятием

СФМ Система финансового мониторинга 

АННОТАЦИЯ

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

1. НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ ПРОГРАММ

САУП предназначена для централизованного управления доступом к корпоративным сервисам и специализированным инструментам проектирования, обеспечивая оптимизацию рабочих процессов. Основные функции САУП включают:

1) Унифицированный доступ к CAD-инструментам:

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

2) Управление правами доступа:

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

3) Интеграция корпоративных сервисов:

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

4) Интеграция с информационными системами:

Система поддерживает взаимодействие с другими корпоративными платформами, такими как автоматизированная система управления предприятием (АСУП) и система финансового мониторинга (СФМ), для обмена данными и повышения эффективности процессов.

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

Для обеспечения функционирования САУП необходимы следующие условия:

Аппаратные требования: Минимальный объем оперативной памяти — 4 ГБ; современный многоядерный процессор с тактовой частотой не менее 2 ГГц.

Программное обеспечение: Совместимая операционная система (Windows, macOS, Linux).

Сетевое подключение: Стабильное соединение с корпоративной сетью, пропускной способностью не менее 100 Мбит/с.

Веб-интерфейс: Поддержка современных веб-браузеров (например, Яндекс) с минимальной скоростью интернет-соединения 1 Мбит/с для работы с графическими и текстовыми данными.

2. ХАРАКТЕРИСТИКА ПРОГРАММЫ

Система автоматизированного управления проектированием (САУП) представляет собой программный комплекс, обеспечивающий централизованное управление доступом к корпоративным сервисам и специализированным инструментам проектирования. Основные характеристики включают:

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

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

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

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

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

3. НАСТРОЙКА И ОБРАЩЕНИЕ К ПРОГРАММЕ

Процедуры обращения к программе в САУП представляют собой механизмы передачи входных параметров данных для выполнения определенных операций или функций.

Структура проекта для развёртывания системы в периметре заказчика:

project/

├── node_modules

├── private

│ ├── products.html

├── public

│ ├── index.html

│ ├── products.html

│ ├── style.css

│ ├── style2.css

│ └── logo.jpg

├── temp

├── server.js

├── ldap_auth.log

├── package-lock.js

├── package.js

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

1. const LDAP_URL = "ldap://ldap.company.local:***"; // Ввести сервер AD

2. const dnFormats = [

`CN=${sanitizedUsername},DC=company,DC=local`,

`${sanitizedUsername}@company.local`,

`company\\${sanitizedUsername}`

]; // Ввести доменные компоненты

3. app.use(session({

secret: "CompanySecretKey123!@#",

resave: false,

saveUninitialized: false,

cookie: { secure: true } // Если используется HTTPS

}));

const PORT = ****; // Ввести нужный порт

app.listen(PORT, () => {

log("INFO", `Server started on http://localhost:${PORT}`);

});

4. const logFile = "/var/log/ldap_auth.log"; // Ввести путь к лог-файлу

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

4. ВХОДНЫЕ И ВЫХОДНЫЕ ДАННЫЕ

Организация входной и выходной информации в САУП играет важную роль для эффективной работы ПО. Основные аспекты организации входных и выходных данных приведены ниже:

1) Входная информация:

Формат: Учетные данные пользователя (идентификатор и пароль) в текстовом формате, предоставляемые на этапе авторизации.

Валидация: Система выполняет проверку входных данных на соответствие информации, хранящейся в корпоративной службе каталогов (Active Directory), с выводом уведомления в случае несоответствия.

2) Выходная информация:

Формат: Интерактивный программный интерфейс, предоставляющий доступ к списку доступных корпоративных сервисов и специализированных CAD-инструментов.

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

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

5. СООБЩЕНИЯ

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

1) Оповещения о некорректных введенных данных при авторизации:

Содержание сообщения: «Неверный логин или пароль».

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

ОБОЗНАЧЕНИЯ И СОКРАЩЕНИЯ

АС Автоматизированная система

САУП Система автоматизированного управления проектированием 

АННОТАЦИЯ

Документ «Описание языка» составлен в соответствии с требованиями ГОСТ 19.506–79 и содержит информацию о языках программирования, используемых в системе автоматизированного управления проектированием (далее по тексту — САУП). В документе представлено назначение и описание общих характеристик каждого языка, а также основные возможности и области их применения в рамках разработки и функционирования САУП.

1. ОБЩИЕ СВЕДЕНИЯ

Для САУП используются следующие языки программирования:

1) Jav * aScript:

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

Характеристики: Поддерживает объектно-ориентированное, функциональное и императивное программирование. Динамическая типизация обеспечивает гибкость при обработке данных, таких как учетные записи Active Directory.

2) HTML:

Назначение: Язык разметки, применяемый для структурирования веб-интерфейса САУП, обеспечивающего доступ к корпоративным сервисам и инструментам проектирования.

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

3) CSS:

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

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

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

1) Jav * aScript:

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

Новые возможности Jav * aScript: функциональность языка непрерывно совершенствуется по мере принятия стандарта ECMAScript.

2) HTML:

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

Формы и элементы ввода: HTML предоставляет широкий спектр элементов для создания форм и сбора информации от пользователей.

Встраивание мультимедиа: с помощью HTML можно встраивать изображения, видео, аудио и другие мультимедийные элементы на веб- страницу.

3) CSS:

Установка параметров внешнего вида: CSS позволяет задавать цвета, шрифты, стили, расположение отдельных блоков и других аспектов представления внешнего вида веб-страниц.

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

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

1) Jav * aScript:

Область применения: универсальный язык программирования, позволяющий работать с серверной и клиентской частью системы, API и сетью.

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

2) HTML:

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

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

3) CSS:

Область применения: CSS предназначен для представления внешнего вида документа, написанного на HTML или XML.

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

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

2. ЭЛЕМЕНТЫ ЯЗЫКА

Ниже приведено описание синтаксиса языков программирования, используемых в САУП.

JavaScript — это язык программирования с открытым исходным кодом, широко применяемый для создания интерактивных веб-страниц. Он поддерживает динамическую работу с данными и позволяет добавлять функциональность на стороне клиента.

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

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

Описание семантики базовых и составных элементов языка:

1. Jav * aScript:

Базовые элементы: Переменные (для хранения данных, например, учетных записей), функции (для реализации логики, например, проверки авторизации), объекты (для структурирования данных, таких как параметры интеграции).

Семантика: Обеспечивает динамическую обработку пользовательских запросов, включая валидацию учетных данных через Active Directory и вызов API для интеграции с сервисами.

2. HTML:

Базовые элементы: Теги (например, <form> для авторизации, <div> для отображения ресурсов), атрибуты (например, data-* для хранения метаданных).

Семантика: Определяет структуру веб-интерфейса САУП, обеспечивая отображение портала с доступными сервисами и формами для взаимодействия.

3. HTML:

Базовые элементы: Селекторы (для выбора элементов интерфейса), свойства (например, display, color), значения (например, размеры, цвета).

Семантика: Формирует визуальное представление портала, обеспечивая единообразие и интуитивность интерфейса для пользователей.

3. СПОСОБЫ СТРУКТУРИРОВАНИЯ ПРОГРАММЫ

Способы вызова процедур передачи управления и другие элементы структурирования программы могут различаться в зависимости от используемого языка программирования. Ниже приведены общие принципы и элементы структурирования программы для языков JavaScript, HTML, CSS используемых в САУП:

1. Jav * aScript:

Вызов процедур передачи управления: В JavaScript процедуры вызываются с использованием синтаксиса вызова функций. Например: functionName().

Структурирование программы: Программы на JavaScript обычно структурируются с использованием функций, объектов и модулей. Функции задают логику выполнения, объекты группируют данные и методы, а модули помогают организовать код в независимые блоки.

2. CSS:

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

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

3. HTML:

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

Структурирование программы: HTML структурируется с использованием различных тегов для разметки контента веб-страницы. Элементы такие как <div>, <section>, <header> и <footer> используются для организации контента и создания структуры страницы.

4. СРЕДСТВА ОБМЕНА ДАННЫМИ

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

1) Ввод данных:

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

Поля ввода: Элементы, такие как <input> и <button>, обеспечивают взаимодействие пользователей с интерфейсом для инициации запросов.

2) Вывод данных:

HTML/CSS-отображение: Используются для представления списка доступных сервисов и инструментов проектирования в унифицированном интерфейсе.

3) Серверное взаимодействие:

Node.js: Обеспечивает асинхронную обработку запросов, например, проверку учетных данных через Active Directory.

Express.js: Реализует маршрутизацию для интеграции с корпоративными системами, обеспечивая доступ к сервисам и CAD-инструментам в виртуализированной среде.

5. ВСТРОЕННЫЕ ЭЛЕМЕНТЫ

Для САУП, которая использует JavaScript, встроенные элементы включают в себя функции, классы и другие конструкции языка. Ниже представлены их описание и правила использования:

1) Функции:

Описание: Функции в JavaScript могут быть объявлены с использованием ключевого слова function и принимать аргументы, возвращать значения.

Правила использования: Функции могут быть именованными или анонимными, а также вызываться из любого участка кода после их объявления или с учетом поднятия (hoisting).

2) Классы:

Описание: Классы в JavaScript используются для создания объектов с заданными свойствами и методами. Они поддерживают конструкторы для инициализации объектов.

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

3) Модули:

Описание: Модули в JavaScript служат для организации кода и разделения его на независимые части, позволяя экспортировать и импортировать функции, объекты или классы.

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

6. СРЕДСТВА ОТЛАДКИ ПРОГРАММЫ

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

Для разработки и поддержки САУП применяются следующие средства отладки Jav * aScript:

1) Консольные команды:

Описание: Разработчики могут использовать консольные команды для вывода значений переменных, объектов или результатов выполнения функций.

Семантика: Команда console.log() применяется для вывода сообщений в консоль браузера или среды выполнения.

Рекомендации по применению: Применять для мониторинга запросов к Active Directory.

2) Отладчик в браузере:

Описание: Современные браузеры и среды разработки предлагают встроенные инструменты отладки.

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

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

3) Использование debugger:

Описание: Ключевое слово debugger добавляется в код для создания точки останова, где выполнение программы приостанавливается.

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

Рекомендации по применению: Применяйте debugger для временной остановки программы в нужной точке и анализа ее состояния.

4) Использование инструкций console.assert() и console.error():

Описание: Эти инструкции служат для проверки условий и вывода сообщений об ошибках соответственно.

Семантика: console.assert() выводит сообщение в консоль, если условие ложно, а console.error() используется для явного указания ошибок.

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

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

ОБОЗНАЧЕНИЯ И СОКРАЩЕНИЯ

АРМ Автоматизированное рабочее место

САУП Система автоматизированного управления проектированием

АС Автоматизированная система

СУБД Система управления базами данных 

АННОТАЦИЯ

Система автоматизированного управления проектированием (далее по тексту — САУП) представляет собой программный комплекс, разработанный для централизованного управления процессами проектирования, обеспечения доступа к специализированным CAD-инструментам через виртуализированную среду и интеграции с корпоративными информационными ресурсами.

1. ОБЩИЕ ПОЛОЖЕНИЯ

1.1. Полное наименование программы

Полное наименование АС/ПО — Система автоматизированного управления проектированием.

1.2. Краткое наименование программы

Краткое наименование АС — САУП.

1.3. Основания для проведения работ

Работы выполняются на основании Приказа от 03.03.2025.

1.4. Наименование организаций — Заказчика и Разработчика

Заказчик:

ОГРН 1227700650869

ИНН/КПП 9728076107/ 772801001

Полное

наименование ОБЩЕСТВО С ОГРАНИЧЕННОЙ

ОТВЕТСТВЕННОСТЬЮ «СОЛТЕХ»

Сокращённое

наименование ООО «Солтех»

Адрес

местонахождения 17342, город Москва, Профсоюзная ул, д. 65 к. 1,

этаж 14, помещ. XL, ком. 7.10

Разработчик:

ОГРН 1227700650869

ИНН/КПП 9728076107/ 772801001

Полное

наименование ОБЩЕСТВО С ОГРАНИЧЕННОЙ

ОТВЕТСТВЕННОСТЬЮ «СОЛТЕХ»

Сокращённое

наименование ООО «Солтех»

Адрес

местонахождения 17342, город Москва, Профсоюзная ул, д. 65 к. 1,

этаж 14, помещ. XL, ком. 7.10

1.5. Цели, назначения и области использования автоматизированной системы

САУП разработана разработана для повышения эффективности процессов проектирования и управления доступом к корпоративным ресурсам. Основные цели и назначения системы включают:

1) Централизованное управление доступом:

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

2) Обеспечение доступа к инструментам проектирования:

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

3) Автоматизация взаимодействия с технической поддержкой:

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

4) Интеграция с корпоративными системами:

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

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

1.6. Подтверждение соответствия проектных решений действующим нормам и правилам техники безопасности, пожаро- и взрывобезопасности и т. п.

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

1) Техника безопасности:

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

Учёт требований к физической безопасности и защите от несанкционированного доступа.

2) Пожаро- и взрывобезопасность:

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

3) Защита информации:

Система защиты информации должна соответствовать классу защищённости 1Д по классификации Гостехкомиссии РФ.

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

Технические средства хранения исходного текста и объектного кода, а также компиляции исходного текста в объектный код, размещены на территории Российской Федерации.

4) Управление доступом:

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

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

5) Регистрация и учёт:

Функции регистрации и учёта субъектов доступа, включая регистрацию входа/выхода, должны осуществляться средствами системы.

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

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

Государственные стандарты:

1) ГОСТ Р 34.201–2020 «Виды, комплектность и обозначение документов при создании автоматизированных систем» — устанавливает порядок разработки документации для автоматизированных систем.

2) ГОСТ Р 34.601–2021 «Автоматизированные системы. Стадии создания» — определяет этапы создания автоматизированных систем.

3) ГОСТ Р 34.602–2020 «Техническое задание на создание автоматизированной системы» — регламентирует структуру и содержание технического задания.

4) ГОСТ Р ИСО/МЭК 25010–2023 «Виды испытаний автоматизированных систем».

5) ГОСТ Р 59795–2021 «Информационные технологии. Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Требования к содержанию документов».

6) ГОСТ 12.2.003 и ГОСТ 12.2.007 — стандарты, регламентирующие безопасность технического оборудования.

7) СанПиН 1.2.3685–21 — «Гигиенические требования к видеодисплейным терминалам, персональным электронно-вычислительным машинам и организации работы».

8) ГОСТ 12.2.032–78 — «Рабочее место при выполнении работ сидя. Общие эргономические требования».

9) ГОСТ 32594–2023 — стандарты, регламентирующие климатические условия эксплуатации и хранения компонентов автоматизированных систем.

10) ГОСТ Р 51904–2002 «Процессы и средства обеспечения качества программного обеспечения. Основные положения».

11) ГОСТ Р ИСО/МЭК 12207 «Инженерия программных систем и систем: Процессы жизненного цикла программных систем».

Федеральные законы:

1) Федеральный закон № 152-ФЗ «О персональных данных» — устанавливает правила обработки и защиты персональных данных.

Нормативные акты по информационной безопасности:

1) Федеральный закон № 187–ФЗ «О безопасности критической информационной инфраструктуры Российской Федерации» — определяет требования к обеспечению безопасности критической информационной инфраструктуры.

Стандарты по безопасности и защите информации:

1) ГОСТ Р ИСО/МЭК 27001–2016 «Информационная технология. Методы и средства обеспечения безопасности. Системы управления информационной безопасностью. Требования» — устанавливает требования к системам управления информационной безопасностью.

Стандарты по процессам управления:

1) ГОСТ Р ИСО 9001–2015 «Системы менеджмента качества. Требования» — предоставляет общие принципы систем управления качеством.

2) ГОСТ Р ИСО 14001–2016 «Системы экологического менеджмента. Требования и руководство по применению».

3) ГОСТ Р ИСО 45001-2020 «Системы менеджмента безопасности труда и охраны здоровья. Требования и руководство по применению».

Требования к хранению данных:

1) Федеральный закон № 149–ФЗ «Об информации, информационных технологиях и о защите информации» — определяет требования к хранению данных.

Прочие нормативные акты:

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

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

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

Наименование этапа Срок выполнения этапа

Формализация Технического задания на разработку Системы  03.03.2025–06.03.2025

Техническое проектирование 10.03.2025–13.03.2025

Разработка ПО 14.03.2025–05.04.2025

Разработка рабочей документации Рабочая документация 05.04.2025–07.04.2025

Таблица 1 – Этапы разработки системы и сроки их выполнения

1.8. Очередность создания автоматизированной системы и объем каждой очереди

Разработка системы осуществлялась в одну очередь в соответствии с этапами и сроками их выполнения, приведенными в Таблице 1. Объёмы работ, определённые на этапе разработки технического проекта, могут уточняться на этапе разработки рабочей документации АС. Модернизация промышленной версии, при выявлении потребности, осуществляется в три этапа; сроки определяются в дополнительной документации.

2. ОПИСАНИЕ ПРОЦЕССОВ ДЕЯТЕЛЬНОСТИ ОБЪЕКТА АВТОМАТИЗАЦИИ

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

Автоматизированное подключение к ресурсам: Система предоставляет унифицированный программный интерфейс, обеспечивающий оперативный доступ к специализированным CAD-инструментам в виртуализированной среде и интеграцию с корпоративными сервисами через синхронизацию с службой каталогов (Active Directory).

Неавтоматизированные операции: Первичная авторизация пользователей с вводом учетных данных и начальная настройка параметров системы администраторами.

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

3. ОСНОВНЫЕ ТЕХНИЧЕСКИЕ РЕШЕНИЯ

3.1. Решения по структуре автоматизированной системы и ее подсистем, по взаимодействию подсистем, по связям между компонентами автоматизированной системы

При разработке САУП были приняты следующие решения по структуре системы и взаимодействию ее подсистем:

1) Веб-ресурс:

Система реализована как веб-приложение, обеспечивающее централизованный интерфейс для взаимодействия с корпоративными сервисами и подключения к системам класса CAD в виртуализированной среде. Портал интегрируется с корпоративной службой каталогов (Active Directory) для управления доступом и синхронизации данных.

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

3.2. Решения по взаимодействию автоматизированной системы со смежными системами и обеспечению совместимости

При проектировании САУП были приняты следующие решения по взаимодействию со смежными системами и обеспечению их совместимости:

– Интеграция с корпоративными сервисами и CAD системами:

Система САУП интегрируется с используемыми системами для формирования единого информационного периметра компании.

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

Приведённые выше решения позволяют эффективно интегрировать САУП с внедренными системами и обеспечивают ее совместимость с различными технологиями и платформами.

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

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

– Качество данных:

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

– Надежность:

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

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

– Производительность:

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

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

– Удобство использования:

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

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

Эти меры обеспечивают соответствие САУП заданным в техническом задании потребительским характеристикам.

3.4. Состав функций, комплексов задач, реализуемых автоматизированной системой

САУП реализует следующие функции:

1) Управление доступом к ресурсам:

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

2) Доступ к инструментам проектирования:

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

3) Автоматизация запросов в поддержку:

Упрощение процесса формирования и обработки обращений в техническую поддержку для оперативного решения вопросов доступа и эксплуатации.

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

3.5. Решения по комплексу технических средств, его размещению на объекте

Разработка и внедрение комплекса технических средств (далее по тексту — ТС) для САУП требует внимательного подхода к выбору, размещению и обеспечению работоспособности необходимого оборудования. Ниже приведены используемые в данной АС решения по комплексу технических средств, его размещению на объекте:

– Автоматизированные «рабочие места» оператора (далее по тексту — АРМ ):

Выбор АРМ оператора: использование современных устройств с достаточной производительностью.

Настройка ПО: п и настройка необходимого ПО.

Обновление антивирусных программ: регулярное обновление и использование антивирусных программ для защиты от вредоносных программ.

– Техническое обслуживание:

Мониторинг оборудования: реализация системы мониторинга состояния оборудования для оперативного выявления и устранения неисправностей.

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

Обновление и модернизация: регулярное обновление и модернизация оборудования для соответствия требованиям и повышения производительности.

Приведённые выше решения обеспечивают надежность, безопасность, эффективность и долгосрочную работоспособность САУП. Технические средства хранения исходного текста и объектного кода системы, а также технические средства компиляции исходного текста в объектный код упомянутого ПО находятся на территории Российской Федерации.

3.6. Решения по составу информации, способам ее организации, входным и выходным документам и сообщениям

В САУП используются следующие способы организации информации и данных:

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

– Виртуальные рабочие пространства: Используется для оптимизации доступа к комплексу программных решений для проектирования. Взаимодействие пользователя осуществляется через интерфейс ПК.

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

При разработке САУП были приняты следующие решения по составу программных средств:

– Языки программирования:

Jav * aScript: Использован для реализации серверной логики и обработки запросов, включая управление доступом и интеграцию с внешними системами.

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

CSS: Использован как язык стилей для оформления интерфейса, обеспечивающего единообразное визуальное представление.

– Фреймворки и библиотеки:

Express: Фреймворк для маршрутизации и обработки серверных запросов.

 *подробное описание с примерами иллюстраций интерфейса системы вы найдете в разделе База знаний нашего сайта

ОБОЗНАЧЕНИЯ И СОКРАЩЕНИЯ

САУП Система автоматизированного управления проектированием

Бэклог Список задач по продукту

ЖЦ Жизненный цикл

ПО Программное обеспечение

Релиз Выпуск 

АННОТАЦИЯ

Документ содержит описание процессов жизненного цикла программного обеспечения (далее по тексту — ПО) системы автоматизированного управления проектированием (далее по тексту — САУП). Документ разработан и включен в комплект рабочей документации в соответствии с требованиями ГОСТ Р 34.601–90 «Автоматизированные системы. Стадии создания», ГОСТ Р 59795–2021 «Информационные технологии. Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Требования к содержанию документов». 

1. ВВЕДЕНИЕ

1.1. Область применения средства автоматизации

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

1) Централизованное управление доступом к системам класса CAD: САУП предоставляет унифицированный интерфейс для взаимодействия с репозиторием CAD-систем, обеспечивая автоматизированное подключение к необходимым программным продуктам в виртуализированной среде.

2) Оптимизация предоставления доступа: Система реализует структурированный подход к управлению правами доступа к корпоративным сервисам и специализированным CAD-инструментам, минимизируя временные затраты на настройку рабочей среды;

3) Интеграция корпоративных сервисов: САУП объединяет доступ к внутрикорпоративным системам через единый программный портал, обеспечивая согласованное и интуитивно понятное взаимодействие пользователей с сервисами;

4) Управление процессом обращений в SD: Автоматизация взаимодействия с технической поддержкой: Система поддерживает комплексный механизм обработки пользовательских запросов, связанных с эксплуатацией доступных сервисов и программных продуктов.

Область применения САУП может адаптироваться и масштабироваться под различные сценарии бизнеса. В данном случае, для группы компаний солнечного бизнеса, САУП дает возможность эффективного управления различными процессами, связанными с проектированием, предоставлением доступа к системам трекинга задач и управлением компанией, аналитическими и финансовыми системам.

2. ПЛАНИРОВАНИЕ ПРОЦЕССОВ ЖИЗНЕННОГО ЦИКЛА РАЗРАБОТКИ

Жизненный цикл (далее по тексту — ЖЦ ) включает период создания и использования САУП, начиная с момента возникновения потребности в продукте, заканчивая разработкой, тестированием и отладкой, поставкой программной продукции, ее эксплуатацией и технической поддержкой.

ЖЦ определен с учетом положений следующих стандартов:

ГОСТ Р ИСО/МЭК 12207–2010 «Информационная технология. Системная и программная инженерия. Процессы жизненного цикла программных средств»;

ГОСТ Р 56939–2016 «Защита информации. Разработка безопасного программного обеспечения. Общие требования»;

ГОСТ РВ 0015–002–2012 «Системы менеджмента качества. Общие требования».

ГОСТ Р 51904–2002 «Процессы и средства обеспечения качества программного обеспечения. Основные положения».

ГОСТ Р ИСО/МЭК 12207 – 2010 «Инженерия программных систем и систем: Процессы жизненного цикла программных систем».

В ООО «СОЛТЕХ» принята итерационная модель ЖЦ (рис. 1).

Рис. 1. Жизненный цикл программного обеспечения

Разработка САУП осуществляется в соответствии с итерационной моделью жизненного цикла, обеспечивающей регулярное обновление функциональности системы с заданной периодичностью (см. Рис. 1). Каждая итерация охватывает этапы планирования и оценки задач, реализации программных компонентов, проведения функционального и интеграционного тестирования, а также актуализации эксплуатационной документации.

Модель ЖЦ обеспечивает необходимый контроль над разработкой и сопровождением САУП.

В ООО «СОЛТЕХ» процессы управления конфигурацией сервиса осуществляются с использованием репозитория дистрибутивов, стенда сборки и системы контроля версий.

3. ФОРМИРОВАНИЕ И ОЦЕНКА ЗАДАЧ 

Ниже описан порядок формирования и оценки задач:

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

ответственный за продукт аналитик определяет требования к задачам; технический менеджер, ответственный за продукт аналитик совместно с

командой разработки проводят оценку задач;

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

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

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

Результатами этапа являются:

Сформированный бэклог на итерацию и релиз;

Спецификация требований и/или техническое описание по каждой задаче; Назначение по каждой задаче исполнителя.

4. ПРОЕКТИРОВАНИЕ И РАЗРАБОТКА

Процесс проектирования и разработки САУП включает следующие этапы:

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

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

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

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

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

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

Дев (с англ. Develop, в терминологии гитфлоу) — базовая ветка для разработки, от неё идут все ветки задач (feature ветки);

Стейдж (с англ. Stage, в терминологии гитфлоу) — ветка готовящегося

релиза;

Мастер (с англ. Master, в терминологии гитфлоу) — ветка последнего

стабильного релиза.

Порядок обновления ПО приведен ниже:

1) Модернизация программной архитектуры, а также разработка решений по построению всех составных компонентов;

2) Модернизация исходных кодов, написание файлов спецификации для

сборки пакетов прикладного ПО;

3) Сборка пакетов прикладного ПО и добавление их в репозиторий

ПО;

4) Сборка дистрибутивов из репозитория ПО;

5) Проверка работоспособности;

6) Устранение проблем (тестирование и отладка);

7) Рассылка уведомления пользователям об обновленной версии ПО.

5. ТЕСТИРОВАНИЕ И ОТЛАДКА

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

Процессом тестирования и отладки определен порядок:

сборка дистрибутивов ПО — ответственный за продукт инженер по внедрению проводит слияние develop в stage и сборку в stage окружении;

проведение тестирования ПО — ответственный за продукт инженер- тестировщик проводит тестирование в stage, а также дымовое тестирование (с англ. smoke testing) в stage всего продукта;

устранение выявленных недостатков ПО — описанием дефекта (недостатка ПО), далее проводится повторное дымовое тестирование (ре-тест);

при завершении дымового тестирования (в том числе повторного) проводится регрессионное тестирование всей функциональности продукта;

при положительном результате регрессионного тестирования проводится добавление в репозиторий эталонных версий дистрибутивов и исходных текстов ПО;

ответственный за продукт инженер по внедрению проводит слияние stage в master с проставлением тега релиза (x.y.z) и сборку в prod окружении;

корректировка программной документации.

По итогам тестирования и отладки сотрудник, ответственный за выпуск новой версии, формирует заключение о качестве версии с оценкой уровня исправления ошибок и запускает процесс согласования разрешения на выпуск версии со следующими лицами:

сотрудник проектной группы, ответственный за разработку ПО САУП; руководитель проекта;

руководитель подразделения, утверждающий разрешение на выпуск версии ПО САУП.

6. ЭКСПЛУАТАЦИЯ И СОПРОВОЖДЕНИЕ

6.1. Техническая поддержка

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

Помощь в доступе к веб-порталу;

Помощь в поиске и устранении проблем в случае некорректной работы веб-портала;

Описание функционала ПО, помощь в эксплуатации;

Предоставление актуальной документации по установке/настройке/работе

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

Описание проблемы (шаги воспроизведения проблемы); Предпринятые попытки решения проблемы; Дополнительная информация:

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

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

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

6.2. Персонал, обеспечивающий работу на местах

Ниже приведено описание минимального уровня подготовки пользователя:

Владение базовыми навыками работы со стандартным ПО (веб-браузер, офисные пакеты, редакторы, и т.п.).

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

1) Технические навыки:

Технический персонал должен обладать высоким уровнем квалификации и практическим опытом выполнения работ по установке, настройке и администрированию программных и технических средств, применяемых в системе, иметь обширные знания в области используемого стека технологий (описание предоставлено в Пояснительной записке) и опыт работы с серверами, базами данных, операционными системами, Active Directory, RDP.

2) Знание ПО:

Понимание логики работы системы управления проектированием, способность осуществлять её настройку и поддержание работоспособности технических средств, на которых устанавливается ПО.

Умение работать с веб-технологиями, Active Directory, RDP, а также знание принципов информационной безопасности.

3) Обеспечение безопасности:

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

4) Управление пользователями:

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

5) Техническая поддержка:

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

ОБОЗНАЧЕНИЯ И СОКРАЩЕНИЯ

САУП Система автоматизированного управления проектированием

ПО Программное обеспечение

АСУП Автоматизированная система управления предприятием

СФМ Система финансового мониторинга

SD Service Desk 

АННОТАЦИЯ

Документ «Описание программы» представляет собой документацию, посвященную программному обеспечению (далее по тексту — ПО) системе автоматизированного управления проектированием (далее по тексту — САУП). Данный документ предоставляет обзор основных характеристик системы, ее функций, компонентов, а также взаимосвязей с другими системами. Он содержит информацию о перечне объектов автоматизации, функциях системы, структуре и взаимосвязях ее частей, а также о предназначении системы. Документ разработан и включен в комплект рабочей документации в соответствии с требованиями ГОСТ Р 34.601–90 «Автоматизированные системы. Стадии создания», ГОСТ Р 59795–2021 «Информационные технологии. Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Требования к содержанию документов».

 1. 1. НАЗНАЧЕНИЕ АВТОМАТИЗИРОВАННОЙ СИСТЕМЫ

1.1. Вид деятельности, для автоматизации которой предназначена система

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

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

1) Обеспечение доступа к инструментам проектирования: САУП предоставляет унифицированный программный интерфейс для оперативного подключения к системам класса CAD в виртуализированной среде, минимизируя необходимость локальной настройки.

2) Управление правами доступа: Система оптимизирует предоставление доступа к корпоративным сервисам и специализированным инструментам, обеспечивая централизованное управление учетными данными.

3) Интеграция корпоративных ресурсов: САУП реализует централизованный портал для взаимодействия с внутрикорпоративными сервисами, обеспечивая согласованный доступ к функциональности.

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

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

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

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

1) Отдел проектирования программно-аппаратных комплексов.

2) Управление бизнес-приложений.

3) Управление по льготному финансированию и страхования.

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

5) Другие организационные подразделения.

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

1.3. Перечень функций, реализуемых автоматизированной системой

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

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

1) Централизованное управление доступом к системам класса CAD: САУП предоставляет унифицированный интерфейс для взаимодействия с репозиторием CAD-систем, обеспечивая автоматизированное подключение к необходимым программным продуктам в виртуализированной среде.

2) Оптимизация предоставления доступа: Система реализует структурированный подход к управлению правами доступа к корпоративным сервисам и специализированным CAD-инструментам, минимизируя временные затраты на настройку рабочей среды.

3) Интеграция корпоративных сервисов: САУП объединяет доступ к разнородным внутрикорпоративным системам через единый программный портал, обеспечивая согласованное и интуитивно понятное взаимодействие пользователей с сервисами.

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

2. ОПИСАНИЕ АВТОМАТИЗИРОВАННОЙ СИСТЕМЫ

2.1. Описание взаимосвязей автоматизированной системы с другими автоматизированными системами

В САУП настроен бесшовный доступ к различными информационными системами в рамках организации, что обеспечивает целостность информационного пространства и эффективное функционирование бизнес-процессов. Ниже приведены основные взаимосвязи САУП с другими информационными системами:

1) Корпоративные системы финансового учета и отчетности.

2) Система управления проектами.

3) Система кадрового электронного документооборота.

4) Система электронного документооборота.

5) Корпоративные порталы и веб-приложения.

6) Система бизнес-аналитики.

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

2.2. Структура автоматизированной системы и назначение ее частей

САУП состоит из нескольких взаимосвязанных компонентов, каждый из которых выполняет определенные функции. Ниже приведена структура САУП и описание ее основных частей:

1) Клиентский веб-интерфейс:

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

2) Серверная часть:

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

3) Интеграционный модуль:

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

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

2.3. Сведения об автоматизированной системе и её частях, необходимые для обеспечения эксплуатации

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

1) Цель системы:

Целью САУП является автоматизация процессов управления проектированием и доступами к приложениям и сервисам.

2) Функциональные возможности:

Система предоставляет возможности для проектирования различных объектов и компонентов с использованием разнообразных CAD систем.

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

3) Структура системы:

САУП состоит из веб-интерфейса, серверной части и интеграционных модулей.

4) Требования к оборудованию:

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

5) Требования к ПО:

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

6) Поддержка и обслуживание:

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

Данные сведения об АС и ее частях необходимы для обеспечения эффективной эксплуатации САУП и поддержания ее работоспособности в рамках группы компаний солнечного бизнеса.

2.4. Описание функционирования автоматизированной системы и ее частей

1) Клиентское веб-приложение:

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

Пользователи могут войти в систему, используя свои учетные данные, после чего получают доступ к функционалу САУП.

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

2) Серверная часть:

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

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

3) Интеграционные модули:

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

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

Описанные выше части АС взаимодействуют между собой для обеспечения эффективной работы и выполнения задач по управлению проектированием.

2.5. Перечень автоматизированных систем, с которыми взаимодействует данная система

Перечень АС, с которыми взаимодействует САУП, включает:

1) Корпоративные системы финансового учета и отчетности.

2) Система управления проектами.

3) Система кадрового электронного документооборота.

4) Система управления документооборотом.

5) Корпоративные порталы и веб-приложения.

6) Система бизнес-аналитики.

2.6. Описание связей между автоматизированными системами

Описание связей между АС представляет собой описание взаимодействия между ними и потоков информации между различными системами. В контексте САУП это описание включает в себя:

1) Интеграцию данных: Обмен учетных данных для обеспечения механизмов бесшовной авторизации в системах.

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

3. ОПИСАНИЕ ПОДСИСТЕМ

3.1. Структура подсистем и назначение их частей

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

1) Веб-итерфейс пользователя:

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

2) Бизнес-логика:

Обработка данных: Часть системы, отвечающая за обработку входных данных, выполнение бизнес-правил и формирование результатов.

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

3) Интеграция:

Внешние системы и сервисы: Предоставляет возможность взаимодействия с другими внешними системами и сервисами благодаря бесшовной интеграции.

4) Модуль управления проектированием:

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

5) Безопасность:

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

Эти части образуют основные функциональные блоки системы и обеспечивают ее эффективное функционирование.

3.2. Сведения о подсистемах и их частях, необходимые для обеспечения их функционирования

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

1) Интерфейс пользователя:

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

2) Бизнес-логика:

Модели данных: Определяет структуру данных и их отношения в системе, а также бизнес-правила и логику обработки данных.

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

3) Безопасность:

Механизмы аутентификации и авторизации: Содержат логику проверки подлинности пользователей ввиду интеграции с Active Directory и управления их доступом к ресурсам системы.

3.3. Описание функционирования подсистем и их частей

Функционирование подсистем и их частей в АС играет ключевую роль в обеспечении эффективности и надежности работы системы в целом. Вот общее описание функций каждой подсистемы и их составляющих:

6) Веб-итерфейс пользователя:

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

7) Бизнес-логика:

Обработка данных: Часть системы, отвечающая за обработку входных данных, выполнение бизнес-правил и формирование результатов.

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

8) Интеграция:

Внешние системы и сервисы: Предоставляет возможность взаимодействия с другими внешними системами и сервисами благодаря бесшовной интеграции.

9) Модуль управления проектированием:

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

10) Безопасность:

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

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

 *подробное описание с примерами иллюстраций интерфейса системы вы найдете в разделе База знаний нашего сайта