Разработчику веб-модулей
Contents
Веб-доступ системы DIRECTUM является веб-приложением, в котором клиентом выступает проводник веб-клиента, а веб-сервером – сервер веб-доступа.
Один экземпляр веб-доступа может иметь несколько веб-модулей.
В дополнение к точкам конфигурирования, существует возможность выполнения программного кода как на стороне сервера, так и на стороне веб-браузера. Таким образом, чтобы реализовать специфические требования, достаточно модифицировать веб-модули, не требуется изменять код платформы веб-доступа.
Веб-доступ можно модифицировать под нужды организации, разрабатывая свои веб-модули и представления веб-клиента или изменяя существующие.
Алгоритм разработки веб-модуля:
| 1. | Развернуть сервер веб-доступа. В результате: |
| • | добавится папка с файлами сервера веб-доступа. По умолчанию C:\Inetpub\wwwroot\DIRECTUMWebAccess\; |
| • | в структуре IIS добавится новый веб-сайт «Сервер веб-доступа к DIRECTUM» и пул приложений для созданного узла. |
| 2. | Установить стандартные шаблоны разработки: |
| a) | В папке %PROGRAMFILES(x86)%\DIRECTUM Company\WebDevTools\WebModuleTemplates запустить файл install.bat. Откроется окно для ввода командной строки. |
Папка, помимо установочного файла, содержит:
| • | папку «Visual Basic» – шаблоны для проектов, созданных на языке Visual Basic; |
| • | папку «Visual C#» – шаблоны для проектов, созданных на языке С#. |
Примечание
Если папка Documents перемещена и находится не в папке %USERPROFILE%, то в файле install.bat нужно указать новый путь до папки Documents.
| b) | Ввести значение y и нажать на клавишу ENTER. |
В результате при создании новых проектов в программе Microsoft Visual Studio будут доступны стандартные шаблоны разработки.
| 3. | Запустить Visual Studio и создать проект на основе шаблона. |
Файлы веб-модуля будут созданы автоматически.
Примечание
Вместо создания проекта в Microsoft Visual Studio, можно скопировать файлы стандартного веб-модуля и редактировать их в любом текстовом редакторе. Для удобства рекомендуется работать в Visual Studio.
| 4. | Разработать веб-модуль. При этом можно использовать: |
| • | XML-файл. Например, ограничить права доступа на компоненты, модифицировать карточки объектов и т.д. |
При появлении новых элементов (кнопок, закладок и т.п.) или изменении названий существующих, добавляйте и переопределяйте строки в файлах локализации;
| • | библиотеки для реализации сложной логики работы веб-доступа: |
| • | JavaScript-библиотека для реализации логики отдельных действий веб-модуля. Например, прописать вычисления, выполняемые при нажатии на кнопку панели действий справочника. Файл библиотеки с функцией следует размещать в папке js корневой папки веб-сайта; |
| • | Dll-библиотека. Например, применить фильтрацию для записей справочника или значений выпадающего списка. Файл библиотеки с классом следует размещать в папке bin корневой папки веб-сайта. |
Если нужно связать платформу IS-Builder и веб-доступ, т.е. получить внешние данные, используйте веб-сервисы.
Для запроса параметров отчетов, сценариев, действий, фильтрации справочников в системе могут использоваться прикладные диалоги. Обеспечьте работоспособность таких компонент в веб-клиенте с помощью вызова диалогов.
Если созданы библиотеки, необходимо прописать их включение в XML-файле:
| • | JavaScript-библиотеку – в атрибуте jsfile элемента Extension, если библиотека необходима для всех объектов, или в атрибуте customcardformclass секции Cards для карточки объекта; |
| • | Dll-библиотеку – в атрибуте class элемента Extension указать полное имя сборки. |
Примечание
Примеры разработки веб-модулей см. в статье на DIRECTUM Club.
При разработке пользуйтесь:
| • | серверным API веб-доступа. Он предоставляет интерфейс программирования приложений для работы с объектами системы DIRECTUM на платформе Microsoft .NET. По умолчанию файлы API расположены в папке %PROGRAMFILES(x86)%\DIRECTUM Company\WebDevTools\WebAccess.API. |
Руководство по серверному API веб-доступа содержит описание пространств имен WebAccess.API, WebAccess.API.Exceptions, WebAccess.API.Ports, их классов, делегатов, интерфейсов, перечислений, а также примеры использования;
| • | клиентским API веб-доступа. Он предоставляет средства для управления элементами веб-страниц и доступа к данным DIRECTUM на JavaScript при помощи классов. |
Руководство по клиентскому API веб-доступа можно использовать для решения прикладных задач, таких как создание и открытие документа, запуск мастеров действий, отправка задачи по типовому маршруту и т.п.;
Учтите, что при разработке не рекомендуется использовать переменные окружения, файлы и реестры. Ограничения по разработке веб-модулей см. в документе «DIRECTUM 5.6. Ограничения веб-доступа».
| 5. | Опубликовать веб-модуль. |
| 6. | Протестировать и отладить работу веб-модуля. В том числе, в разных браузерах, потому что браузеры немного по-разному воспринимают код JavaScript. |
Если необходимо, внести изменения в файлы веб-модуля и снова опубликовать.
| 7. | Перезапустить пул приложений веб-доступа или службу IIS. |
| © Компания DIRECTUM, 2018 | Сообщество пользователей DIRECTUM |