This guide shows web developers how to view One Identity Manager HTML applications as code and how to understand their internal functionality. For that purpose, One Identity provides you with an extension for Visual Studio Code.
The online version of One Identity Manager documentation is available in the Support Portal under Online documentation. Videos providing further information are available at www.YouTube.com/OneIdentity.
Architecture of One Identity Manager HTML applications
One Identity Manager manages a folder structure that contains the source files for all HTML applications. In the data model, this folder structure is stored as part of automatic software updates and it is assigned the machine role HTML Development.
You can store this folder structure locally in a development folder. In the development folder, the folders for database modules are stored at the top level. Below that you will find a folder for each HTML application. See section Creating a development folder to find out how to create a development folder.
The HTML applications are structured as nodeJS applications that use the Angular framework. Generally, any HTML applications that can be compiled as nodeJS applications are supported.
The HTML applications use the API Client to communicate with the One Identity Manager API. API Client is an npm library that is automatically generated and stored to the database during API compilation. API Client controls all network access on the API Server.
Much of the logic for HTML applications is realized by plugins that can be used independently of a specific HTML application. You can also use this logic for your own applications.
HTML Application development
In this section, you will find information on how to deal with the One Identity Visual Studio Code extension.
You can use the Visual Studio Code extension to launch the ImxClient commandoline program directly in Visual Studio Code without any in-depth knowledge of the syntax:
The Visual Studio Code extension also provides you with the following helpful information:
- Status of the current database connection
- Information about the ImxClient used
- Information about the API Client used
- Status of the development order
- Compilation branch display
- Information on the last translation check
To install the One Identity Visual Studio Code extension
Start Visual Studio Code.
In Visual Studio Code, click Extensions in the left navigation.
In Extensions, click .... | Install from VSIX.
In the file browser, select the file vcode-extension.vsix in the One Identity Manager installation folder and click Install.
Restart Visual Studio Code.
In Visual Studio Code, click Explorer in the left navigation.
In Explorer, navigate to One Identity | Configuration.
Next to Imx client, click One Identity Manager: edit imx client path.
In the file browser, select the file ImxClient.exe in the One Identity Manager installation folder and click Open.