Chat now with support
Chat with Support

We are currently experiencing an our phone support and are working diligently to restore services. For support, please sign in and create a case or email for assistance

Identity Manager 8.1.4 - API Designer User and Development Guide

API Designer Basic principles of API development Examples and help – Software Development Kit Quick start – Creating an API Working with the API Designer
Starting the API Designer Project types User interface Global settings Database objects Labeling changes Find and replace Multilingual captions Managing database queries Managing tabs Managing layouts Displaying the change history (command list) Bookmarks Compiling an API Managing versions (compilation branches) Testing an API Linking C# projects to the API Designer
API projects API files API Server ImxClient command line program

ImxClient command overview

The following chapters contain a list of all ImxClient commands that you can run.

Related topics


Displays a list of available commands.


To view help for a specific command, add the command as a parameter.

Example: help fetch-files

Related topics


Executes HTML5 package compilation.

This command performs the following steps:

  1. Executes the npm install command in the application folder.

  2. Executes the npm run build command in the package folder.

  3. Creates the output in subdirectory dist
    .The output is stored as a zip file in the database.


Login parameters:

  • /conn <database connection>: Specifies the database to connect to.

  • /dialog <dialog authentication>: Specifies the dialog authentication.

Required parameters:

  • /path <path to main folder>: Enter the path to the main folder. This folder contains the application to be compiled. This folder normally contains the package.json file of the application.

Optional parameter:

  • /conndialog <Option>: Specifies whether a login window is displayed for the database connection. The following options are possible:

    • off: The login window is not shown. If the database is not connected, an attempt is made to establish a connection.

    • show: The login window is shown (even is a database is already connected) and the new connection replaces the old one.

    • fallback (default): The current database connection is used. If the database is not connected, an attempt is made to establish a connection.

  • /factory <target system>: Specifies the target system for the connection. Enter this parameter if you want to establish a connection to the application server.

  • N: Prevents saving to the database.

  • -D: Executes debug compilation.

  • /branch <compilation branch ID>: Saves the compiled result under the specified compilation branch. You must also specify the parameter -D.

Related topics


Starts the ImxClient command line tool in REPL mode.

In this mode, the following actions are performed in an infinite loop:

  • Read commands from stdin.

  • Forward commands to the relevant plug-in.

  • Output the results of processing to stdout.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating