Debugging
Running and debugging HTML applications is possible with the Angular CLI toolchain's standard tools.
For example, you can use the ng serve qer-app-portal command to debug the Web Portal HTML application.
To debug an HTML application
-
Host the API Server locally (see Hosting API Servers locally).
-
Start a command line program.
-
Change to the Angular workspace directory.
-
Run the following command:
npm run start <HTML application>
This starts a web server that is accessible by default under http://localhost:4200 and hosts the HTML application.
-
Start debugging in an appropriate development environment (for example, Visual Studio Code).
Hosting API Servers locally
To debug and develop an HTML application you need an instance of an API Server for connecting HTML applications. To do this, you can host an API Server locally.
NOTE: HTML applications connect with the API Server through the URL defined in the HTML application's environment.ts file. The default URL that runs under a locally hosted API Server, is http://localhost:8182.
To host an API Server locally
-
Start a command line program.
-
Change to the Angular workspace directory.
-
Run the following command:
imxclient.exe run-apiserver -B
Debugging with plugins
You can also debug with plugins. Debugging with plugins only works if the local API Server can find the plugin.
To debug a static Angular library
-
Host the API Server locally (see Hosting API Servers locally).
-
Start a command line program.
-
Change to the Angular workspace directory.
-
Run the following command:
npm run build:watch <Angular library>
-
Start another command line program.
-
Change to the Angular workspace directory.
-
Run the following command:
npm run start <HTML application>
This starts a web server that is accessible by default under http://localhost:4200 and hosts the HTML application.
-
Start debugging in an appropriate development environment (for example, Visual Studio Code).
To debug an Angular plugin library
-
Host the API Server locally (see Hosting API Servers locally).
-
Start a command line program.
-
Change to the Angular workspace directory.
-
Run the following command:
npm run build:watch:dynamic <Angular plugin library>
-
Start another command line program.
-
Change to the Angular workspace directory.
-
Run the following command:
npm run start <HTML application>
This starts a web server that is accessible by default under http://localhost:4200 and hosts the HTML application.
-
Start debugging in an appropriate development environment (for example, Visual Studio Code).
Developing HTML applications with the Visual Studio Code extension
Developing HTML applications with the Visual Studio Code extension
In this section, you will find information on how to use with the One Identity Visual Studio Code extension.
You can use the Visual Studio Code extension to launch the ImxClient command line 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
Related topics
