Руководство по использованию платформы через её сайт

Содержание

1. Введение

Основная работа с платформой ведётся с помощью доступа к её сайту и взаимодействию с ним. Интерфейс сайта разделён на 4 области: Сайт платформы представляет собой совокупность онлайн средств управления, реализующих ту или иную часть функционала платформы.
Доступ к средствам управления осуществляется через ссылки, расположенные в левом меню сайта (и в шапке). В режиме анонимного пользователя доступен лишь ограниченный функционал. При выполнении входа на сайт — левое меню расширяется дополнительными ссылками. Функционал сайта позволяет выполнять следующие основные действия: Базой платформы являются единицы хранения (ЕХ) — ресурсы (инфоресурсы), описывающие ту или иную информацию в виде графов. Аналог — файлы. Различие (усложнение) заключается в возможности ссылаться из одного графа на другой, а также в применении 2-уровневой модели формирования.

Инфоресурс помимо собственно содержимого (вершин, их меток, дуг, комментариев) имеет (или может иметь):

2. Пользователи

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

3. Полный список средств управления

Примечания:

4. Общий Фонд

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

Инфоресурсы раздела предназначены для всеобщего использования. Оно начинается с получения ссылки в персональный фонд и права на чтение. Такое право даёт затем возможность использовать эти ресурсы в личном фонде при формировании новых сервисов, а также для создания новых инфоресурсов на основе исходных (путём создания ссылок на вершины, зависимых клонов вершин, полного или частичного копирования содержимого таких ЕХ).

Для просмотра содержимого Фонда необходимо использовать СУ "Фонд" (доступно по ссылке из отдельного пункта левого меню сайта).
Интерфейс данного СУ разделён на 2 части: левая часть представляет собой дерево разделов, папок и подпапок, а правая часть - список содержимого текущей выбранной сущности Фонда (раздела или папки).
С элементами данной сущности (папками и инфоресурсами) можно выполнять навигационные действия, а также действия, доступные через контекстное меню элемента и через верхнее меню (элемент должен быть выделен). Набор действий зависит от роли текущего пользователя: Модификация общего Фонда состоит в публикации единицы хранения (или некоторой папки, содержащей подпапки и единицы хранения), созданной в личном фонде, в некоторый (существующей или новой) раздел Фонда. Данный функционал доступен из личного кабинета (см. далее).

5. Личный (персональный) Фонд

Фонд пользователя имеет сокращенную по сравнению с общим Фондом структуру — отсутствуют разделы. Навигация по его содержимому выполняется также (время авто-обновления содержимого текущей отображаемой папки составляет 30 секунд). Множество доступных операций почти полностью иное.

5.1. Создание единиц хранения (инфоресурсов)

В корне персонального фонда, а также в (под)папке пользователь может создавать подпапки и единицы хранения (две папки в корне персонального фонда являются системным и в них этот функционал недоступен — Загрузки и Корзина). Создание новой сущности выполняется путём использования пункта верхнего меню "+".

В платформе выделяются следующие два деления единиц хранения (инфоресурсов) на виды: В соответствии с этим делением можно создавать инфоресурсы следующих типов: информация (с указанием метаинформации), метаинформация, агент, шаблон сообщения, решатель задач, сервис (в будущем: работа, технология, экземпляр агента, сообщение). При создании единицы хранения её тип можно выбрать с помощью кнопки-переключателя (radio-button). Также для создания информации и программных сущностей можно выбрать тип "Создание информации по метаинформации" и указать метаинформацию для такой ЕХ: Список доступных инфоресурсов типа метаинформация формируется из всех таких инфоресурсов, находящихся в личном фонде пользователя. Для использования ресурсов, находящихся в общем Фонде, необходимо получить их в доступ (они будут помещены в папку "Загрузки").

Имя новой ЕХ не должно: Не рекомендуется использовать такие спец. символы как угловые скобки, фигурные скобки, хеш-теги (#), символ "собачье ухо" (@), знак доллара ($), точка с запятой (;), двоеточие, двойные кавычки — это может негативно сказаться на текстовых представлениях данного инфоресурса.

Особые случаи создания нового ЕХ в личном фонде: Особые случаи появления ЕХ в личном фонде: В этом случае необходимо понимать, что в персональном фонде находится не новая ЕХ, а ссылка на ЕХ из чужого или общего фонда, причём изначально такая ссылка появляется в папке "Загрузки", а затем её можно переместить в другую папку (см. раздел "Манипуляции с сущностями персонального фонда").

5.2. Модификация и просмотр единиц хранения

Модификация единиц хранения выполняется при помощи средств редактирования, доступных для тех или иных ЕХ (в зависимости от их типа). В настоящее время это следующие редакторы: Базовый редактор, Редактор JS, Редактор шаблонов сообщений, Редактор агентов, Редактор решателей, Редактор сервисов. Все перечисленные редакторы, кроме Редактора JS и Редактора сервисов, запускаются при совершении клика по имени ЕХ (запускается редактор, соответствующий типу ЕХ). Также такой редактор запустится при использовании пункта контекстного или верхнего меню "Редактор". Для задействования Редактора сервиса (для ЕХ типа "сервис") и Редактора JS (для ЕХ типов "информация", "метаинформация") необходимо использовать пункт контекстного или верхнего меню (по клику на имени ЕХ они не запускаются). В случае если редактор ЕХ уже был запущен ранее, то очередной переход к её редактированию откроет редактор в предыдущем состоянии.

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

Примечания:
1. особым случаем модификации ЕХ в личном кабинете является его до-импорт из json-файла, подготовленного вне платформы — для задействования данного функционала необходимо использовать соответствующую кнопку-иконку в меню СУ "Мой Фонд", при этом важно понимать, что: 2. при создании новой ЕХ пользователь автоматически получает (теневой) сервис на её редактирование, причём:

5.3. Совместная работа

Совместная работа заключается в "расшаривании" инфоресурса его владельцем, что даёт сторонним пользователям возможность осуществлять просмотр содержимого инфоресурса или его модификацию. Для реализации этого механизма используется концепция "списки доступа". Их формированием занимается владелец ЕХ — через контекстное меню ЕХ в СУ "Мой Фонд" (или в Редакторе) он может выдавать данную ЕХ в доступ на чтение и в полный доступ (на чтение и запись) другим пользователям. Для этого необходимо лишь ввести в соответствующей форме e-mail другого пользователя платформы и выбрать тип доступа.

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

Владелец инфоресурса может также отобрать доступ у определенного пользователя или передать ЕХ во владение другому пользователю. Это выполняется в той же форме, что и выдача ЕХ в доступ — через контекстное меню ЕХ в СУ "Мой Фонд". При публикации инфоресурса в Общий Фонд происходит автоматическая замена владельца на администратора раздела, в который публикуется инфоресурс.

Кроме того владелец может управлять такими свойствами ИР как "приватность" и "блокировка". Первое отвечает за свободную доступность на просмотр данной ЕХ, когда она размещена в общем Фонде, а второе — блокирует использование ЕХ у всех других пользователей (также в рамках сформированных сервисов). Это выполняется в специальном пункте меню Редактора данной ЕХ.

Помимо СУ "Мой Фонд" и Редакторов ЕХ управление совместным доступом можно осуществлять, используя соответствующее СУ — "Совместный доступ". В левой части интерфейса данного СУ отображается объединенный список пользователей, которые либо выдали текущему пользователю в доступ свои ЕХ, либо получили от текущего пользователя в доступ его ЕХ. При клике на ФИО такого пользователя в правой части интерфейса отображается список ЕХ (выданных или полученных в доступ) с указанием типа доступа, имени ЕХ (клик не нему позволяет осуществлять редактирование или просмотр данного ЕХ). Также здесь можно изменить доступ пользователя к данному ЕХ.

Примечания:

5.4. Публикация в Фонд

Публикация ЕХ (здесь и далее — или набора ЕХ, помещённого в некоторую папку) служит для фиксирования состояния ЕХ и помещение их в Общий Фонд для всеобщего доступа, что убирает необходимость самостоятельно выдавать в совместный доступ к ЕХ каждому пользователю с инициативы владельца.

Публикация единицы хранения (папки с единицами хранения и подпапками) в Фонд выполняется из контекстного меню сущности персонального фонда в СУ "Мой Фонд". В появившейся форме необходимо указать раздел, в который планируется помещение ЕХ, описать причину публикации в данном разделе и подать заявку путём нажатия соответствующей кнопки. В этот момент будет выполнена проверка, что все указанные ЕХ не содержат ссылок на неопубликованные ранее и непубликуемые (в рамках данного запроса) ЕХ, не находящиеся в Общем фонде. В случае отсутствия таковых будет создана заявка на публикацию и поставлена в очередь таких заявок администратору указанного раздела. В случае, если публикацию ЕХ из своего фонда выполнял сам администратор раздела — такая заявка будет сразу же автоматически удовлетворена. В противном случае — необходимо дождаться появления оповещения системы о решении администратора раздела (см. соответствующий раздел). В случае одобрения заявки — ЕХ появится в корне раздела Фонда (однако, администратор раздела может её переместить в рамках этого раздела). В случае отклонения заявки администратором раздела пользователь может ознакомиться с комментарием администратора о причине отклонения и, при необходимости, подать новую заявку в случае отправки администратором раздела или администратором проекта заявки на доработку пользователь может ознакомиться с комментарием администратора и в соответствии с ними переоформить свою заявку (см. "Работа с поданными заявками").

Примечания:

5.5. Манипуляции с сущностями персонального фонда

К множеству манипуляций относятся: создание копий, перемещение, переименование, удаление, просмотр свойств.
Данные операции применимы как к отдельным ЕХ, так и к папкам; групповое выделение в настоящие момент не поддерживается, так что манипулировать можно лишь одной сущностью одного из указанных типов.

Для выполнения любой из указанных операций необходимо выделить ЕХ или папку, а затем кликнуть по соответствующему пункту контекстного меню или кнопке-иконке верхнего меню СУ "Мой Фонд".

Копирование и перемещение

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

Особым случаем копирования является копирование ИР агентов и шаблонов сообщений. При копировании такой ЕХ значение её вершины, созданной по мета-вершине "внутреннее имя", заменяется на строку "требуется изменить внутреннее имя (и код!) программной единицы, так как она получена путём клонирования (дата: ...)", также не копируются значения вершин с байт-кодом.

Примечания:

Переименование

Переименование папок и ЕХ осуществляется с помощью соответствующего пункта контекстного меню или кнопки-иконки верхнего меню СУ "Мой Фонд".

На новые имена сущностей накладываются ограничения, налагаемые на имена новых сущностей (см. выше).
Кроме того, не допускается переименование ссылок на ЕХ, находящиеся в общем или чужих фондах (это доступно только владельцам тех ЕХ).
Если ЕХ была выдана в доступ другим пользователям, то задание ей нового имени владельцем также ограничивается именами всех ЕХ, расположенных в той же папке у каждого стороннего пользователя, который получил её в доступ, - они не должны совпадать. То есть, если пользователем А была выдана ЕХ "1" пользователю "Б", которая попала к пользователю Б в папку "Загрузки", где уже находится ЕХ "2", то пользователь А не сможет задать ЕХ "1" новое имя "2".

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

Удаление

Удаление сущностей личного фонда выполняется с помощью соответствующего пункта контекстного меню или кнопки-иконки верхнего меню СУ "Мой Фонд" и состоит из 2 шагов: Окончательное удаление папки подразумевает вначале удаление всего её содержимого (подпапок и ЕХ), а затем удаление опустевшей папки.

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

Свойства ЕХ

Просмотр свойств ЕХ позволяет узнать владельца, описание, дату создания, дату последней модификации ЕХ.
С числом вершин и дуг в инфоресурсе можно ознакомиться, уже используя Редактор.

6. Работа с сервисами

Сервисы на платформе используются для запусков агентных решателей, интегрированных с некоторыми входными и/или выходными инфоресурсами. (Аналог — исполнимый файл вместе с параметрами командной строки, передаваемыми ему во время запуска.)

Работа с сервисами включает в себя виды работ с ЕХ других типов, доступная через средства СУ "Мой Фонд", а также запуск/возобновление/остановка сервиса.

Запуск сервиса осуществляется путём клика по его имени, отображаемом в СУ "Мой Фонд". При этом, так как в платформе различают решатели с интерфейсом и без, то в случае сервиса, построенного на основ решателя первого типа, осуществляется переход к его (начальному) интерфейсу, а в случае второго — лишь обновится состояние папки личного фонда (у ЕХ сервиса появится кнопка его останова — в виде квадратика).

Возобновление сервиса во многом аналогично запуску — осуществляется путём клика по его имени, отображаемом в СУ "Мой Фонд". При этом в случае сервиса, построенного на решателе с интерфейсом, осуществляется переход к его интерфейсу, а в случае сервиса с решателем без интерфейса — будет получено сообщение о невозможности отображения интерфейса.

Остановка работающего сервиса выполняется путём нажатия на иконку квадратика, расположенную правее имени ЕХ сервиса в персональном фонде. Альтернативным способом для сервиса, построенного на решателе с интерфейсом, является остановка путём нажатия на кнопку-иконку с крестиком, расположенную правее имени вкладки сервиса (в интерфейсе сервиса).

Дополнительным средством работы с работающими сервисами является СУ "Работающие сервисы". В нём отображается список работающих сервисов пользователя и для тех из них, что построены на базе решателя с интерфейсом, присутствует кнопка-иконка возобновления (для перехода к их интерфейсу) и иконка останова, а для тех, что построены на решателях без интерфейса — только кнопка останова.

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

Создание сервисов и их (в том числе программных) компонент и работа с ними подробно описывается в разделе "Разработка" документации.

7. Просмотр и изменение личного профиля

Для просмотра (и изменения) личных данных пользователя используется СУ "Профиль". (В нём возможно просматривать или модифицировать лишь данные своего аккаунта, аккаунты посторонних пользователей недоступны.)
В настоящее время данное СУ позволяет изменить собственные ФИО, пароль, а также настроить режим получения уведомлений на e-mail (включить или отключить).

8. Работа с поданными заявками

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

9. Новости проекта

Просмотр новостей проекта доступен всем зарегистрированным пользователям и гостям — при использовании СУ "Новости".

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

К новостям относятся: Примечания:

10. Сообщения

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

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

Условно поступившие пользователю сообщения можно разделить на следующие группы: Для создания нового сообщения в рамках данного СУ следует использовать кнопку-иконку "+". В появившейся форме необходимо ввести текст отправляемого сообщения, задать адресата (указав его e-mail) и нажать кнопку отправки. (Если сторонний пользователь не отказался от получения уведомлений платформы на e-mail, то он помимо сообщения получит также и письмо с текстом сообщения.

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

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

11. Администрирование раздела Фонда

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

В задачи администратора раздела входит управление содержимым раздела — структурой папок, именами ЕХ и папок, рассмотрение заявок на модификацию (пополнение новыми ЕХ) раздела Фонда. Так как администратор раздела при выполнении публикации становится владельцем ЕХ и единственным пользователем, который может её модифицировать, то на нём также лежит ответственность за внесение корректировок в эту ЕХ (что не приветствуется), управление доступом к ней: выдачу в доступ на чтение (не приветствуется выдача в полный доступ), установка/снятие флага приватности (для выдачи в доступ лишь по запросу или свободной выдачи в доступ), установка/снятие флага блокировки (для наложения/снятия блокировки на использования всеми кроме владельца).

11.1. Рассмотрение заявок

Для рассмотрения заявок на публикацию единиц хранения (или их групп) необходимо использовать СУ "Администрирование". В нём будут отображаться поступившие заявки на публикацию в разделы, в которых текущий пользователь является администратором. Если пользователь не является ни администратором проекта, ни администратором некоторого раздела, то данное СУ будет недоступно. В противном случае пользователь увидит в левой части СУ список разделов, в которых он является администратором, а в правой — табличный список поступивших заявок для выбранного слева раздела. Если сумма заявок по всем разделам более 0, то это число будет отображаться в конце имени СУ "Администрирование", а само имя будет выделено жирным (вплоть до удаления или подтверждения всех поступивших заявок).

Каждая заявка на публикацию в раздел Общего Фонда представлена в таблице строкой со следующими полями: дата подачи заявки, ФИО подателя, краткая информация по заявке. Через контекстное меню данной сторки можно заявку "Одобрить", "Удалить", "Отправить на доработку". В случае удаления или отправки заявки на доработку необходимо вписать комментарий и причинах принятия такого решения в поле ввода до нажатия соответствующей кнопки. Пользователь в любом случае получит информационное сообщение о принятом администратором решении.

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

11.2. Управление единицами хранения, папками, описаниями

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

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

12. Задачи, решаемые администратором проекта

12.1. Рассмотрение заявок

Для рассмотрение заявок на создание новых разделов Общего Фонда, поступивших администратору проекта, ему необходимо использовать СУ "Администрирование". В его левой части первым пунктом будет "Администратор проекта", при клике на котором в правой части отобразится список поступивших заявок. Данный табличный список может быть пустым (в случае отсутствия поступивших заявок). В противном случае помимо отображения информации по заявкам также их число будет (в сумме с количеством заявок по разделам Фонда, если администратор проекта управляет и некоторыми разделами) отображаться в конце имени СУ "Администрирование", а само имя будет отображаться жирным шрифтом.

Каждая из поступивших заявок представлена в этом списке следующими полями: дата подачи заявки, ФИО подателя, информацию по заявке. Контекстное меню для строки с описанием заявки содержит кнопки: "Одобрить", "Удалить", "Отправить на доработку". В случае удаления или отправки заявки на доработку необходимо вписать комментарий и причинах принятия такого решения в поле ввода до нажатия соответствующей кнопки. В случае одобрения заявки — создаётся новый раздел. После принятия администратором проекта некоторого решения — уведомление об этом направляется пользователю-подателю.

Примечания:

12.2. Удаление разделов

Для удаления раздела Общего Фонда администратору проекта необходимо убедиться, что данный раздел пуст (в результате его чистки администратором раздела). Удаление разделов "Платформа IACPaaS", "Проблемно-независимая предметная область" и "Тестовая предметная область" запрещено. Способ удаления раздела не описывается данной общей инструкцией.

12.3. Управление новостями проекта

Удаление новостей проекта осуществляется при помощи СУ "Новости" и уже описано выше - в разделе "Новости проекта". Добавление новости выполняется с помощью пункта "Информирование" (доступно только администратору проекта в рамках СУ "Администрирование").

12.4. Переназначение администраторов разделов

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

13. Прочее