Chat now with support
Chat mit Support

Identity Manager 8.2.1 - API Development Guide

Basic principles of API development Examples and help – Software Development Kit API configuration Implementing your own APIs API Designer Quick start – Creating an API with the API Designer 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 methods ImxClient command line program

help

Displays a list of available commands.

Parameters

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

Example: help fetch-files

Related topics

compile-app

Runs HTML5 package compilation.

This command performs the following steps:

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

  2. Runs 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.

Parameters

Login parameters:

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

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

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.

  • /workspace <path to working directory>: Specifies the working directory. This folder contains the application to be compiled. This folder normally contains the package.json file of the application. If you do not enter anything here, the current directory is used.

  • /app <application project name>: Specifies which application project to compile. If you do not specify anything here, all application projects are compiled.

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

  • -D: Runs debug compilation.

  • N: Prevents saving to the database.

  • /copyto <file path>: Saves the result of the compilation as ZIP files in a folder.

  • /exclude <module name>: Omits packages of a module at compile time (for example, AOB).

Related topics

compile-api

Compiles the API and saves the result to the database.

Parameters

Login parameters:

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

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

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. Example: QBM.AppServer.Client.

  • /solution <solution project file path>: Specifies the path to the solution project file to use. If you leave this parameter empty, a database project is used.

  • /mode <compile mode>: Specifies the compilation mode:

    • normal: Runs a complete compilation (default mode).

    • nostore: Assemblies are not saved in the database.

    • nocompile: Creates only C# code. The compilation is not run.

    • nocodegen: Runs only the compilation. No C# code is generated.

  • -E: Enables extended checks.

  • -D: Compiles with debug information.

  • /csharpout <folder path>: Specifies the path to the folder in which you want to save the C# files.

  • /copyapi <folder path>: Specifies where to copy the imx-api.tgz to.

  • /copyapidll <API DLL path>: Specifies which API DLL file to use. The /solution and /branch parameters are ignored if you use this parameter.

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

  • /nowarn <error1,error2,...>: Specifies which errors are ignored during compilation. Enter the codes for the warnings, separated by commas.

  • /warnaserror <error1,error2,...>: Specifies which warnings are displayed as errors during compilation. Enter the codes for the warnings, separated by commas.

Related topics

repl

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 plugin.

  • Output the results of processing to stdout.

Related topics
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen