DocuWare SDK

DocuWare SDK  - (Java Application Programming Interface) формируют специализированный интерфейс для приложений

Простая интеграция DocuWare в другие приложения

Благодаря Software Developer Kit (SDK) вы можете интегрировать всеобъемлющие функции управления документами DocuWare в приложения пользователя. В нем имеются соответствующие интерфейсы для среды разработок разных видов. Благодаря этому основными функциями DocuWare можно воспользоваться в широком спектре приложений.

Архитектура DocuWare предоставляет различные высокоэффективные интерфейсы программирования для различных сред разработки. DocuWare имеет архитектуру клиент-сервер. На стороне сервера DocuWare работает с несколькими серверами, каждый из которых выполняет различные задачи. Например, сервер аутентификации отвечает за регистрацию и администрирование пользователей, в то время как сервер контента управляет доступом к документам. Клиент DocuWare обеспечивает такие пользовательские функциональные возможности, как представление, хранение, и поиск документов, а также администрирование и конфигурирование системы. На этой базе работает DocuWare TOOLKIT, обеспечивающий доступ к клиенту DocuWare и предоставляющий полный набор функций. Кроме того,DocuWare GAPI (General Application Programming Interface) является приложением .NET, которое имеет прямой доступ к серверам и может выполнить важные операции в DocuWare. На основе GAPI веб-службы и JAPI Java. Эти интерфейсы обеспечивают доступ к DocuWare и позволяют просто и надежно использовать программу из других приложений.

DocuWare TOOLKIT для языков программирования C, а также языков VB 6 и 4GL
Программный интерфейс для языков C позволяет использовать функции TOOLKIT для управления DocuWare в других приложениях. TOOLKIT контролирует важные функции DocuWare, связанные с обработкой с обработкой корзин, картотек и документов. Например, можно выбрать корзины или документы в пределах корзины и просмотреть их. Вы можете импортировать и индексировать документы, а также сохранять их в картотеках. Программа предоставляет самые разные функции для поиска и хранения документов в картотеках DocuWare. Пользователь может использовать диалоговые окна поиска и сохранения и просматривать документы, выбирая их из списка результатов. Интеграция интерфейса програм-мирования для языков C обеспечивается с помощью динамических или статических соединений с файлов DLL комплекса TOOLKIT. Каждая функция TOOLKIT имеет интерпретируемый код ошибок, что гарантирует оптимальную обработку ошибок и особых ситуаций. Для упрощения обработки функций TOOLKIT в языках программирования 4GL (например Microsoft Visual Basic) используется интерфейс COM (Component Object Model), который позволяет использовать автоматическую обработку с помощью OLE (Object Linking and Embedding). Для использования функций картотеки и корзины DocuWare должен быть запущен на компьютере. Только таким образом гарантируется аутентификация в системе DocuWare. Для функций, связанных с документами (например, их хранение), запуск DocuWare не требуется.

 

Интерфейс .NET в TOOLKIT для приложений .NET и C#
Интерфейс TOOLKIT .NET работает как упаковщик для интерфейса программирования C, позволяя языкам .NET использовать функции DocuWare TOOLKIT. Таким образом, просмотр документов также возможен из приложений VB.NET и С#, так как имеется возможность доступа к функциональным возможностям клиента. TOOLKIT .NET не отображает функции TOOLKIT в пропорциии 1:1, а работает в объектно-ориентированной среде. При этом он предлагает тот же самый набор функциональных возможностей, хотя и в другой форме. Такие операции, как поиск и редактирования, могут параллельно выполняться через GAPI.

DocuWare GAPI для VB.NET и C#
Основанный на .NET 2.0 интерфейс программирования GAPI яляется объектно-ориентированным и работает независимо от клиента DocuWare. Вместо того работы через клиента GAPI получает доступ к серверам DocuWare непосредственно через TCP/IP. Благодаря прямому доступу GAPI обеспечивает высокую эффективность, безо¬пасность и простоту использования. Для интеграции с приложениями .NET и С# используются ссылки на DOCUWARE.GAPI.DLL. Ошибки возвращаются как особые ситуации. Функциональные возможности GAPI и DocuWare TOOLKIT являются частично идентичными. Но так как GAPI работает без клиента, пользовательский интерфейс отсутствует. Команды GAPI для интеграции в приложения .NET и С# позволяют, например, выполнять поиск и сохранение документов в картотеке, изменять записи индекса, а также удалять, экспортировать и загружать документы. Кроме того, он также обеспечивает получение информации индивидуальных объектов / классов, например, имен всех пользователей в организации или параметров настройки, касающихся полей индекса картотеки.

Веб-службы и JAPI
Веб-службы, обеспечивающие взаимодействие между серверами DocuWare, разработанных на основе .NET, например с использованием среды Java. Веб-службы являются надстройкой на DocuWare GAPI (General Application Programming Interface). DocuWare обеспечивает пять свободно связанных служб, каждая из которых может использоваться отдельно. Каждый из пяти интерфейсов имеет ясно определенный диапазон функций. Службы имеют два разных вида: Compatible Web Services и Session Web Services. Обе группы имеют одинаковый набор функций,однако доступ к ним обеспечивается по-разному, кроме того, они могут использоваться в разных окружениях. Например, при подключении к клиенту Java вам потребуются Compatible Web Services. Compatible Web Services поддерживают сетевой протокол SOAP 1.1 (Simple Object Access Protocol). Session Services поддерживают протокол SOAP 1.2 и используются для подключения к клиенту .NET. Кроме того, на веб-службах основан и JAPI, обеспечивающий работу со средой Java.

Проверка и инициаторы
Благодаря общим или специфическим библиотекам контроля DocuWare позволяет выполнять проверки достоверности записей индекса на стороне сервера. Проверка достоверности осуществляется через .NET 2.0 DLL, которые могут содержать любое число проверок. Библиотеки DLL могут быть написаны партнером или самими клиентами, благодаря чему возможна их индивидуальная адаптация ко всем имеющимся требованиям. Проверка может выполняться как для записей в поле (проверка поля) или для любых записей (проверки индекса). DocuWare имеет библиотеку DLL (DOCUWARE. VALIDATORBASE. DLL) со всеми основными классами. Таким образом партнер или клиент использует эту DLL для создания своих собственных библиотек DLL. Эти DLL регистрируются в DocuWare Administration и присваиваются полям картотеки и/или индекса. При любой записи или обновлении какой-либо записи индекса система вызывает библиотеку и проверят записи, которые могут быть приняты или отклонены, для чего выводится соответствующее сообщение. В этом случае пользователь может исправить свои записи. Проверки выполняются при всех изменениях картотек и индекса, включая те случаи, когда устанавливается метка, изменяющая записи индекса. Проверка полей может, например, определить, является ли дата более поздней, чем текущая дата, а также проверить, чтобы какое-либо значение не превышало определенный лимит. Проверка индекса может использовать внешний источник данных для проверки того, совпадает ли введенный номер клиента с номером клиента.
Интеграция библиотек .NET библиотек обеспечивает и другую функцию: так как DLL могут содержать любой программный код, они могут использоваться как инициаторы для управления процессами. Например, можно указать необходимость отправки уведомления всем пользователям в случае сохранения документа с определенными критериями индекса. Кроме того, можно инициировать ввод записи во внешней базе данных, если запись индекса изменяется на определенное значение. Благодаря синхронизации с внешней базой данных в случае изменения поля состояния (например, маркером) может быть изменено другое поле индекса, которое управляет переадресацией определенному пользователь с помощью DocuWare CONTENT-FOLDER.

Функции TOOLKIT (основные)

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

Корзина

• Число всех документов в корзине
• Составление всех документов DocuWare в корзине
• Составление списка всех имен файлов и документов в корзине
• Выбор или отмена выбора всех документов в активной корзине
• Выбор документа
• Составление списка всех зарегистрированных корзин
• Указание пути к активной корзине
• Активация корзины
• Открытие и активация корзины
• Просмотр документа из корзины
• Импорт документа в корзину
• Обновление активной корзины
• Сшивание выделенных доку-ментов в корзине

Картотека

• Составление списка всех зарегистрированных картотек
• Выбор целевой картотеки
• Открытие и активация картотеки
• Сохранение документа в картотеке
• Поиск документа
• Число записей в списке результатов
• Печать документа из списка результатов
• Просмотр документа из списка результатов
• Открытие зарегистрированного приложения для обработки документа
• Удаление документа из картотеки
• Копирование документа в корзину
• Сохранение списка результатов в виде файла
• Заполнение открытого меню сохранения/поиска ключевыми/ индексными словами
• Изменение индекса для доку-ментов с указанными ключевыми словами
• Генерация записи базы данных

Документ

• Открытие заголовка документа DocuWare
• Считывание и ввод текста, даты, числового поля или поля примечания
• Преобразование формата файла (черный/белый) в формат DocuWare TIFF G4
• Наложение документов TIFF

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

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

A. Клиент

• Составление списка всех возможных серверов аутентификации для соединения
• Регистрация пользователя через DocuWare или Windows

B. Информация
Организация

• Имя и глобальный уникальный идентификатор (GUID) для всех групп, профилей и ролей
• Список всех пользователей или прямого доступа через имя/GUID

Пользователь

• Имя и GUID
• Распределенные картотеки
• Распределенные группы, профили, роли
• Список всех прав относительно картотек, полей индекса картотек и функциональных возможностей (права меню)

Картотека

• Имя, GUID, цвет и описание
• Поля включая метки, имя, тип, GUID, номер индекса, длина базы данных
• Параметры настройки для полного текста и дочерней картотеки

Документ

• Страницы документа DocuWare для сохраненного документа
• Данные индекса, текстовые примечании
• Системные поля

C. Операции
Файл - кабинет

• Вызов (поиск): для списков совпадений могут быть определены любые поля картотеки
• Определение критериев поиска для полей и системных полей; использование расширенных критериев поиска; объединение критериев операторами И/ИЛИ
• Списки совпадений в виде блока как .NET DataTable
• Сохранение
• Поиск документа по идентификатору

Документ

Все документы

• Изменение записей индекса n Удаление документа или страниц документа DocuWare
• Добавление страниц документа DocuWare в конце
• Изменение текстового примечания
• Экспорт документа или страниц документа DocuWare в файловую систему

Сохраненные (архивированные) документы

• Выгрузка или загрузка файлов документа DocuWare из пути/по пути
• Выгрузка или загрузка файлов документа DocuWare из/в кэш GAPI
• Непрерывная загрузка файлов документа DocuWare в виде потока данных
• Установка пометок, включая пометки с полями