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

1 Введение 4

1.1 Область применения 4

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

1.3 Минимальные требования к уровню подготовки разработчика ПП, ИС, КИС 5

2 Назначение и условия применения 7

2.1 Виды деятельности, функции, для автоматизации которых предназначена программная платформа 7

2.2 Условия применения ПП, ИС, КИС 7

2.3 Комплект и лицензии ПП 8

2.4 Интеграция и совместимость 9

2.5 Стратегия внедрения и развития КИС в организации 9

3 Подготовка к работе 12

3.1 Подготовка к работе пользователя КИС 12

3.2 Подготовка к работе редактора/разработчика ИС/КИС 12

4 Описание операций установки и эксплуатации 14

4.1 Первичное получение и распаковка архива ПП разработчика ИС/КИС 14

4.2 Настройка ПП 14

5 Аварийные ситуации ПП разработчика КИС 15

6 Партнёрство и сотрудничество 15

7 Рекомендации по освоению 15

8 Авторы и разработчики 16

Список используемых сокращений и терминов

Сокращение, термин	Полное наименование, определение
ИС	Информационная система. Система обеспечивающая автоматизацию бизнес-процессов отдельного подразделения/департамента организации.
КИС	Комплексная информационная система. Объединение различных ИС в единую систему автоматизации всех бизнес-процессов предприятия.
ПП	Программная платформа. Комплект программ для автоматизации общих бизнес-процессов любой ИС в среде единой КИС. Создания специализированных ИС на основе базовых функций ПП. Объединения множеств ИС в КИС.
ITCOD	Наименование формата объектных баз данных и ПП. Зарегистрированная торговая марка разработчика.
WWII	Web Widget Interactive Interface ITCOD (автор: Вдовытченко Ю.Н. 2013-2015)

1Введение

1.1Область применения

Программная платформа ITCOD (ПП) предназначена для поэтапной и параллельной автоматизации бизнес-процессов организации любого размера, методом создания и совершенствования универсальной комплексной информационной системы (КИС) организации. КИС ITCOD это сервис-ориентированная web-среда обеспечивающая использование доступных локальных и глобальных ресурсов для формирования единого информационного пространства. ПП предназначена для объединения всех существующих автоматизированных бизнес-процессов предприятия в единую модульную информационную среду управления. ПП обеспечивает интерфейс взаимодействия множества отдельных (специализированных) информационных систем (ИС) предприятия между собой и их взаимодействие с пользователями КИС. Публикацию открытой информации в глобальных сетях и распространение приватной в интранет. Обеспечивает высокую надёжность и производительность ИС/КИС за счёт персонифицированной децентрализованой архитектуры формирования ИС предприятия.

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

Платформа реализует следующие возможности:

• 
  Обеспечивает создания универсального интерфейса взаимодействия специализированных сервис-ориентированных ИС (включая сервис-провайдеров) между собой в единой среде управления бизнес-процессами организации;
  
• 
  Формирование интерактивного полиморфного Web-интерфейса взаимодействия пользователей и КИС. Анализирует множество факторов (поведение пользователя, состояние интерфейса, доступность сервисов и данных, вводимой/выводимой и обрабатываемой информации, результатов обработки данных) и на основе их состояния обеспечивает изменение визуализации;
  
• 
  Предоставляет единый адаптивный кросс-платформенный интерфейс на любом оборудовании пользователя (компьютер, планшет, смартфон, сенсорный терминал) с любым или всеми методом взаимодействия (мыш/сенсор/хbox)
  
• 
  Постепенное развитие функций КИС методом унифицированных повторяемых интераций, в соответствии с декомпозицией текущих и перспективных потребностей организации;
  
• 
  Разработку программного обеспечения ПП и развитие КИС предприятия в целом, по методологии Agile;
  
• 
  Унификация, шаблонизация и тиражирование успешных решений и готовых элементов для построения интерфейсов обеспечивает переход от единичного к поточному производству совместимых ИС/КИС;
  
• 
  Позволяет повысить оперативность КИС за счёт снижения профессиональных требований к специалистам по обслуживанию и развитию ИС/КИС, разделить задачи развития на составляющие и эффективно использовать незадействованный интеллектуальный потенциал организации;
  
• 
  Позволяет формировать логические последовательные, параллельные и много-вариантные схемы получения и обработки данных из различных внешних и внутренних источников информации.
  
• 
  Позволяет объединять результаты работы различных ИС и формировать унифицированные банки данных используемые в дальнейшем различными ИС в среде КИС;
  
• 
  Обеспечивает двухступенчатую систему резервирования объектных баз данных без дополнительных затрат, и элементарные системы ручного и автоматизированного резервного копирования.
  
• 
  Предоставляет перспективы проектирования масштабируемых web-оболочек для управления различным оборудованием и развития коммерческих сервис-ориентированых ИС/КИС и интерфейсов нового поколения (3D-Интерфейсы/Игровые интерфейсы/etc...);
  
• 
  Предоставляет возможности независимого создания и применения узко-специализированных программных средств для отдельных ИС и БД а КИС, с применением различных средств разработки.
  

1.3Минимальные требования к уровню подготовки разработчика ПП, ИС, КИС

Установка, настройка и дальнейшее развитие функций ПП, ИС и КИС в целом, должна осуществляться сотрудниками, обладающими навыками и знаниями:

• 
  Понимание концепции сервис-ориентированных самодостаточных ИС и логики взаимодействия отдельных элементов КИС и элементов интерфейса.
  
• 
  Знание форматов данных HTML, CSS, CSV, CSV ITCOD, TXT, UTF8;
  
• 
  Владение языком программирования Java Script;
  
• 
  Создание и программирование виджетов интерактивного интерфейса WWII ITCOD (WWII – Web Widget Interactive Interface (DOM DIV HTML & JS)).
  
• 
  Навыки анализа и тестирования web-приложений на производительность — приветствуются.
  

Кроме того, при отсутствии в штате организации дизайнера, сотрудник должен обладать минимальными навыками редактирования текстовой и графической информации в простейших редакторах (Форматы: TXT, JPG, GIF).
Для разработчика сетевых сервисов знания и навыки определяются на уровне формирования задания на разработку и определения наиболее перспективных методов реализации. Базовые навыки:

• 
  Владение методами создания сетевых сервисов html (get put);
  
• 
  Навыки формирования ajax запросов
  
• 
  Навыки настройки OS Linux и Nginx;
  

Для администраторов объектных баз данных КИС, навыки и знания зависят как минимум от выбранной среды хранения данных (файловый/dav) и технологии доступа к данным в ИС (файловый/dav/html/etc...).

2Назначение и условия применения

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

ПП обеспечивает унификацию и автоматизацию следующих функций:

• 
  Унификация методов хранения и доступа к разнородной информации в среде КИС
  
• 
  Автоматизацию методов получения, обработки и хранения разнородной информации в единой среде КИС;
  
• 
  Создание интерфейсного ядра единой комплексной информационной системы;
  
• 
  Персонализация объектных баз данных по владельцу (автору) информации;
  
• 
  Создание и многовариантное объединение множества персональных объектных баз данных ИС различных пользователей/департаментов/подразделений/филиалов организации в единую ИС/КИС.
  
• 
  Объединение и публикация открытых персональных баз данных ИС/КИС в виде выделеных простых публичных ИС (сайт, портал).
  
• 
  Автоматизация общего для всех подразделений бизнес-процесса ввода и сохранения информации (информационные библиотеки, базы данных, архивы);
  
• 
  Формирование КИС методом многовариантного объединения ИС в требуемые конфигурации и создания специализированных или универсальных интерфейсов взаимодействия;
  
• 
  Единый принцип проектирования и создания тиражируемых виджетов получения, обработки и вывода информации в интерактивном интерфейсе КИС.
  
• 
  Автоматизирует принцип «необходимой достаточности» доступной информации при отсутствующем доступе к глобальным сетям и иным каналам связи. (Управление персональными объектными базами данных ИС в режиме оff-line или online в зависимости от варианта хранения базы данных входящей в состав ИС.)
  

2.2Условия применения ПП, ИС, КИС

Работа пользователя с интерактивным web-интерфейсом КИС возможна на любом компьютере, планшете, смартфоне, терминале имеющем современный интернет-браузер.

Доступ и отображение информации обеспечивается:

1. 
   локально (CD/DVD-ROM, Флеш-накопители, Жесткий диск ПК, etc...);
   
2. 
   Файловый доступ (файл-серверы MS, SAMBA, Novell)
   
3. 
   Глобально (ресурсы сетей интернет и интранет, сервис-провайдеры, хостинг, облако Amazon S3 AWS);
   
4. 
   смешано (формирование интерфейса локального и глобального доступа к активным на данный момент разнородным информационным ресурсам)
   

Работа разработчика интерактивного web-интерфейса КИС возможна с любого компьютера c графической оболочкой. Операционные системы (Windows, Linux, Mac OS, etc...)
Работа редактора ИС/КИС (ввод/корректировка объектных баз данных) возможна на компьютере с операционной системой Windows и программы редактора ITCodEdit.exe.

В перспективе развитие web-интерфейса редактора ИС/КИС.

2.3Комплект и лицензии ПП

1. 
   Формат объектных баз данных ITCOD. Основан на формате CSV. Лицензия: Creative Commons (Общественное достояние);
   
2. 
   Itcod.js — полиморфный интерактивный адаптивный Web-интерфейс, основанный на технологии Web-виджетов. Обеспечивает процедуру формирования динамических интерфейсов, взаимодействия виджетов с объектными базами данных и внешними сервисами. Это кросс-браузерное и кросс-платформенное приложение, работающее с любого носителя данных (локально без интернет, и как сайт в интернет) в браузере пользователя. Лицензия: Двойная Open Source GPLv3 позволяющая создавать открытые проекты и коммерческая ITCOD Development Licence обеспечивающая создание коммерческих продуктов.
   
3. 
   Web-виджеты — более 170 виджетов, обеспечивающих создание базовых функций полиморфных интерактивных интерфейсов. Виджет является простой самостоятельной JS-функцией, и, в зависимости от назначения, взаимодействует с пользователем, с базами данных, с внешними сервисами. Виджет оперирует полученными данными из различных источников и запускает выполнение заложенных в него логических операций. Лицензия LGPL – позволяет использовать их как в коммерческих, так и в бесплатных проектах
   
4. 
   HTML-шаблон — структура хранения настроек интерфейса и формирования интерфейса в дереве DOM браузера. Лицензия: На усмотрение разработчика (владельца ИС).
   
5. 
   ITCodEdit.exe – Редактор электронных каталогов ITCod. Программа для OS Windows. Предоставляет удобный процесс формирования объектнвх баз данных (электронных каталогов) в offline режиме с последующей публикацией изменений. Лицензия: FreeWare ITCOD License. Бесллатное использование в некоммерческих целях, для обучения и для учебных заведений РФ.
   
6. 
   Персонифицированный доступ к интернет-сервису хранения и публикации электронных каталогов (банк электронных каталогов).
   

2.4Интеграция и совместимость

ПП позволяет взаимодействовать и оперировать локальной информацией описанной в объектных базах данных itcod. Предоставляет возможности доступа к внешним сервисам обеспечивающим любой из интерфейсов взаимодействия webAPI, JSImport, XMLHttpRequest. Корректировка и формирование информации в объектной базе данных может выполняться прозрачно любым программным обеспечением специализированных ИС имеющим функции работы с текстовыми файлами (чтение/запись). Режим импорт/экспорт рекомендуется только при первичном ручном формировании сложных объектных баз данных. В дальнейшем рекомендуется исключить ручную обработку из бизнес-процесса ввода информации.

ПП не совместима с программными продуктами не имеющими интерфейсов взаимодействия с внешними ИС.

2.5Стратегия внедрения и развития КИС в организации

В зависимости от размера организации и организационной структуры, внедрение и развитие КИС может осуществляться различными методами. Для малых предприятий целесообразно последовательное (поэтапное) внедрение и объединение специализированных ИС подразделений в единую КИС. Для крупных, параллельное или смешанное внедрение КИС.

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

1. 
   Информация первична. Анализ и выработка управленческих решений напрямую зависят от доступной руководству информации. Владеют информацией ваши сотрудники. Обеспечьте себя эффективными инструментами получения и обработки информацией. Создайте и актуализируйте персонифицированные объектные базы данных основных бизнес-процессов организации. Для привлечения клиентов формируйте и публикуйте в сети интернет ИС с интересной информацией (это сайт, портал).
   
2. 
   Человеческий фактор. Успешность и скорость внедрения КИС напрямую зависят от желания и возможностей руководства и ключевых менеджеров организации. Важное значение имеет креативность мышления руководства и сотрудников IT подразделения.
   
3. 
   От простого к сложному. Начните с наиболее простых бизнес-процессов и переходите постепенно к более сложным. В большинстве случаев можно начать с ИС обеспечивающей доступ клиентов к вашей информации (сайт, портал), далее развивайте информационные библиотеки и архивы, далее постепенно расширяйте КИС на все подразделения, вовлекая все бизнес-процессы и всех сотрудников в обработку информации и выработку решений.
   
4. 
   Удовлетворяйте первичные потребности. Расширяйте аналитические и сервисные возможности КИС в соответствии с текущими потребностей организации.
   
5. 
   Комфорт обязателен. Улучшайте интерфейсы обеспечивающие комфортное взаимодействие пользователей и информации в КИС.
   
6. 
   Не платите, если это возможно. Используйте открытые разработки и удачные решения.
   
7. 
   Платите хорошо если необходимо. Привлекайте внешних специалистов для решения узкоспециализированных задач. Используйте готовые коммерческие решения и сервисы для достижения требуемого вам результата.
   
8. 
   Продавайте. Разработав для себя, превратите в продукт/услугу/сервис и продавайте.
   
9. 
   Делитесь если выгодно. Делитесь с другими разработчиками, если с вами делятся. Бартер рабочих решений финансово выгоден согласно правилу 6.
   
10. 
    Не тратьте больше, чем приобретаете. Определите и обеспечьте выгоду на каждом этапе развития КИС. Повышение эффективности принятия решений это выгода.
    
11. 
    Не прыгайте через голову. Каждый этап процесса развития КИС должен опираться на уже включенные в КИС бизнес-процессы.
    
12. 
    Меняйте приоритеты и цели незаметно. Резкая смена приоритета или цели путает сотрудников и тормозит процесс развития КИС. Устанавливайте приоритеты последовательно, меняйте цели незаметно.
    

3Подготовка к работе

3.1Подготовка к работе пользователя КИС

• 
  Для получения информации запустить браузер и ввести адрес ресурса формирующего интерактивный web-интерфейс единого прозрачного доступа ко всем активным ресурсам КИС
  
• 
  Для ввода информации в персонифицированную объектную базу данных использовать редактор ITCodEdit.
  

3.2Подготовка к работе редактора/разработчика ИС/КИС

Для осуществления процедуры редактирования данных ИС/КИС необходимо:

• 
  Скачать архив itcod.zip содержащий программы редактирования и интерфейсов wwii itcod;
  
• 
  Распаковать архив в удобное место (желательно на отдельный диск разработчика);
  
• 
  Запустить программу ITCodEdit.exe;
  
• 
  Следовать шагам мастера создания электронного каталога или выполнять действия в собственной последовательности;
  
  Все программы являются мобильными (portable) и не требует инсталяции! Работают с любого локального носителя данных. Наличие интернет требуется только при публикации каталога в банк электронных каталогов ITCod.
  

Для разработчика ИС/КИС необходимо обеспечить удобную возможность редактирования текстовых и графических (растровых файлов). Это может быть например: встроенный текстовый редактор оболочки Far manager (c поддержкой кодировки UTF8) или gedit. Для редактирования растровой графики например: GIMP.

Для разработки программ (виджетов) на Java Script разработчик самостоятельно выбирает редактор с подстветкой синтаксиса JS который ему наиболее удобен и привычен.

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

Разработчику ИС/КИС не требуются программы для создания локального web-сервера на рабочем месте для тестирования. Интерфейс WWII является полностью AJAX-приложением и работает локально на ПК пользователя, генерирует DOM в браузере клиента посредством загружаемых по требованию JS-виджетов.

4Описание операций установки и эксплуатации

4.1Первичное получение и распаковка архива ПП разработчика ИС/КИС

Все фалы и структура папок ПП, расположены в архивном файле itcod.zip

• 
  Перед распаковкой, необходимо выбрать наиболее удобное для работы локальное место на ПК или место на файловом сервере. Не рекомендуется выполнять распаковку в директории временного хранения и на рабочий стол операционной системы.
  
• 
  Распаковать архив в выбранное место.
  
• 
  После того, как процедура распаковки файлов будет завершена, в выбранном месте будет создана папка ITCod.
  

Папка ITCod содержит:

• 
  программу ITCodEdit (off-line редактирования электронных каталогов itcod (объектных баз данных)) и dll-библиотеки для работы программы,
  
• 
  электронный каталог itcod содержащий программу формирования интерактивного web-интерфейса, js-библиотеки, web-application, документацию разработчика.
  

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

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

4.2Настройка ПП

Настройка ПП не требуется.

Платформа готова к эксплуатации с момента распаковки и размещения в необходимой среде обмена информацией (локально/глобально).

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

5Аварийные ситуации ПП разработчика КИС

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

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

• 
  Бесплатная версия — обратиться к разработчику на странице поддержки в соцсетях по адресам:
  
• 
  VK – http://vk.com/itcodapi/
  
• 
  FB - https://www.facebook.com/groups/itcod/
  
• 
  Коммерческая версия ПП - Обратиться в службу поддержки, по электронной почте и при необходимости по телефону.
  
  
  

6Партнёрство и сотрудничество

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

7Рекомендации по освоению

Для дальнейшего освоения рекомендуется изучить документы:

1. 
   Архитектура интерфейса WWII ITCOD (manual-wwii-itcod.doc)
   
2. 
   JS Программирование WWII ITCOD (manual-js-itcod.doc)
   
3. 
   Концепция и формат объектной базы данных ITCOD (manusl-odb-itcod.doc)
   
4. 
   Концепция построения КИС ITCOD (manual-cis-itcod.doc)
   

8Авторы и разработчики

Формат БД, WWII ITCod, виджеты, документация - Вдовытченко Ю.Н. - max@itcod.com

Формат БД, редактор БД (ITCodEdit.exe) - Манжула B.M.

(c)ITCod (тм)

Кострома, 2014-2015 гг.