Websoft Omnicode Extension for VS Code. Websoft.OmniCode is a Visual Studio Code extension that provides a set of tools to work with Websoft HCM. Websoft OmniCode for HCM is a Visual Studio Code extension providing a toolkit for working with Websoft HCM. Comprehensive documentation on installing the editor and using it can be found here. Capabilities The editor allows you to develop objects for the Websoft HCM system using Server-Side Java Script and C# programming languages. In C#, it supports code compilation and debugging, as well as building not just individual files or objects, but entire projects. The editor enables working with the following types of objects: Server Agents; Code Libraries; Remote Actions; Remote Collections; Statistics; Web Templates. System Requirements Websoft HCM To ensure the proper functioning of the editor, the latest version of Websoft HCM is required, which can be downloaded from the official client Portal. Microsoft .Net SDK For debugging and running C# code, the version of Microsoft .Net SDK that Websoft HCM is compiled against (.net 6.0) is necessary. It can be downloaded from the official source. C# Dev Kit For debugging and running C# code, the C# Dev Kit extension is required, which can be installed from the Visual Studio Code Marketplace. Websoft.DotNetBuild and Websoft.OmniCode Components Components Websoft.DotNetBuild and Websoft.OmniCode are required to compile the code and run the editor on the server side. They can be downloaded from the official client Portal (in the Components tab) and extracted to the directory ...\WebSoft\WebSoftServer\components. Configuration File xHttp.ini In the file ...\WebSoft\WebSoftServer\xHttp.ini, the following parameters need to be set: DOTNETCORE-PATH: dotnetcore/core; The parameter DOTNETLIBS-PATH should include the components directory in its list (comma-separated); DOTNETCORE-DEBUG: 1 (to enable debug message logging). Environment Variables It is necessary to add operating system environment variables: WebTutorServerDir = [path to the Websoft HCM server]; DebugWebTutorServerDir = [path to the Websoft HCM server]; DefaultNetCoreTargetFramework = net6.0; DefaultNetStandardTargetFramework = netstandard2.1; WEBSOFT_MSBUILD_SDK_PATH = [path to the DOTNET SDK installation directory]. Installation Install the extension from the Visual Studio Code Marketplace: Open the Extensions (Ctrl+Shift+X) panel; Type Omnicode in the search string; Click Install. Getting Started In the Explorer panel under the WEBSOFT HCM LINK SERVERS section, click the Link Server button and select a folder in your local directory where objects from the server will be downloaded. Enter the address of the server you wish to synchronize the editor with. Log in to the Portal. A token will be issued, allowing the editor to sync with the server. Select the necessary object types for synchronization and click OK. Возможности Редактор предоставляет возможность разрабатывать объекты системы Websoft HCM на языках программирования Server-Side Java Script и C#. При этом на языке C# доступна компиляция и отладка кода, а также формирование билда не отдельного файла или объекта, а проекта в целом. Редактор позволяет работать с типами объектов: агенты сервера (Agents); библиотеки программного кода (CodeLibraries); удаленные действия (RemoteActions); выборки (RemoteCollections); показатели (Statistics); шаблоны документов (WebTemplates). Системные требования Websoft HCM Для корректной работы редактора необходима актуальная версия Websoft HCM, которую можно скачать с официального клиентского Портала. Microsoft .Net SDK Для отладки и запуска кода на C# необходима версия Microsoft .Net SDK, под которую откомпилирован Websoft HCM (.net 6.0). Ее можно скачать с официального источника. C# Dev Kit Для отладки и запуска кода на C# необходимо расширение C# Dev Kit, которое можно установить из магазина приложений Visual Studio Code Marketplace. Компоненты Websoft.DotNetBuild и Websoft.OmniCode Для компиляции кода и работы редактора на стороне сервера необходимы компоненты Websoft.DotNetBuild и Websoft.OmniCode, которые можно скачать с официального клиентского Портала (вкладка Компоненты) и распаковать в папку ...\WebSoft\WebSoftServer\components. Конфигурационный файл xHttp.ini В файле ...\WebSoft\WebSoftServer\xHttp.ini необходимо установить параметры: DOTNETCORE-PATH: dotnetcore/core; в параметре DOTNETLIBS-PATH в списке (через запятую) должен присутствовать каталог components; DOTNETCORE-DEBUG: 1 (для включения в журналы сообщений об отладке). Переменные среды Необходимо добавить переменные среды операционной системы: WebTutorServerDir = [путь до сервера Websoft HCM]; DebugWebTutorServerDir = [путь до сервера Websoft HCM]; DefaultNetCoreTargetFramework = net6.0; DefaultNetStandardTargetFramework = netstandard2.1; WEBSOFT_MSBUILD_SDK_PATH = [путь до каталога установки DOTNET SDK]. Установка Установите расширение из магазина приложений Visual Studio Code Marketplace: Откройте вкладку Extensions (Ctrl+Shift+X); В строке поиска введите OmniCode; Нажмите Install; Быстрый старт Во вкладке Explorer в разделе WEBSOFT HCM LINK SERVERS нажмите кнопку Link Server и выберите папку в вашей локальной директории, в которую будут выгружены объекты с сервера. Введите адрес сервера, с которым необходимо синхронизировать редактор. Авторизуйтесь на Портале. В результате будет выдан токен, с помощью которого редактор сможет синхронизироваться с сервером. Выберите необходимые типы объектов для синхронизации и нажмите ОК. |