Adding plugins
Plugins are Angular libraries that are dynamically loaded at runtime. The plugins are managed by the API Server. Plugins are automatically detected by the API Server by searching the program directory for files named imx-plugin-config.json.
The following sample file specifies that the Angular plugin library ccc should be loaded into the qer-app-portal application. The name of the Angular module to be instantiated is CustomConfigModule.
{ |
"qer-app-portal":[ |
{ |
"Container":"ccc", |
"Name":"CustomConfigModule" |
} |
] |
} |
To add a plugin
-
On the API Server, create the file imxweb\<Angular plugin library name>\imx-plugin-config.json with the following content:
{ |
"<Name of the HTML application>":[ |
{ |
"Container":"<Name of the Angular plugin library>", |
"Name":"<Name of the Angular module>" |
} |
] |
} |
-
Import the file into your One Identity Manager database using the Software Loader and assign it to the API Server machine role. For more information on importing files using the Software Loader, see the One Identity Manager Operational Guide.
-
(Optional) To check if the HTML application loads the plugin correctly, open the <API Server URL>/imx/applications URL and check that the corresponding plugin appears at the HTML application position in the list.
Checking for missing translations
You can check HTML applications for missing user interface translations using the ImxClient command line program. For more information about the ImxClient command line program, see the One Identity Manager API Development Guide.
TIP: Translatable text is marked in the source code with the #LDS# prefix.
To check an HTML application for missing translations
-
Start the ImxClient command line program.
-
In the folder you want to check for missing translations, run the check-translations command.
This creates a report. The report shows you any files containing texts that have not yet been translated or have not been translated in full.
-
(Optional) To add translation keys and translations, use the Designer program. For more information about translations, see the One Identity Manager Configuration Guide.
Registering HTML applications
To deploy new HTML applications for use and display them on the API Server's home page, you must add the HTML applications to the database.
To add an HTML application to the database
-
Start the Designer program.
-
Connect to the relevant database.
-
In the navigation, click the Base data > Security settings > HTML applications category.
-
On the menu bar, click 
(Create a new object).
-
Click the new entry in the list.
-
In the Properties view, enter the HTML application data in the respective fields. Enter at least the following information:
-
Display name: Enter a name for the HTML application.
-
HTML application: Enter the path CCC/<name of your HTML application>.
-
Precompiled: Set the value to True.
Compiling and deploying Angular projects
To make an Angular project available through the API Server, you must compile the Angular project and compress it into a ZIP file.
To compile and deploy an Angular project
-
Start a command line program.
-
Change to the Angular workspace directory.
-
Run the following command:
ng build <project name>
-
Compress the contents of the directory containing the compilation (usually dist/<project name>) into a ZIP file named Html_<project name>.zip.
-
Copy the ZIP file to the imxweb\custom subfolder of your workspace.
TIP: If the folder does not exist, create it.
-
Import the ZIP file into your One Identity Manager database using the Software Loader and assign it to the Development and Testing machine role. For more information on importing files using the Software Loader, see the One Identity Manager Operational Guide.
-
Copy the ZIP file to the bin\imxweb\custom subfolder of your IIS installation.
TIP: If the folder does not exist, create it.
-
Import the ZIP file into your One Identity Manager database using the Software Loader and assign it to the Business API Server machine role.
