Chat now with support
Chat mit Support

Identity Manager 9.3 - API Development Guide

check-translations

Searches for captions (multilingual text) with missing translations in a particular folder and its subfolders.

Parameters

Login parameter:

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

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

Required parameters:

  • /path <path to folder>: Specifies the path to the folder you want to check.

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.ServiceClientFactory, QBM.AppServer.Client

Related topics

compile-api

Compiles the API. This performs the following steps:

  • Verifies the API definition

  • Compiles a TypeScript API client library

  • Creates a DialogAEDS EP object in the database for each API endpoint

Parameters

Login parameter:

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

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

Optional parameter:

  • /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.ServiceClientFactory, QBM.AppServer.Client

  • N: Prevents saving to the database.

  • /modules <module1, module2>: Specifies which modules are included. If you do not enter anything here, all modules are included. Enter the modules' names, delimited by commas.

  • /clientmodules <module1,module2,...>: Specifies the modules for which API code is generated. If you do not enter anything here, API code is generated every module. Enter the packages' names, delimited by commas.

  • /packagename <name>: Specifies the API client package name. The default value is imx-api.

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

  • /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.

  • /endpointdef {filename}: Specifies that the API endpoint list is written to file instead of creating DialogAEDS objects.

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 parameter:

  • /conn <database connection>: Specifies the database you want 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.ServiceClientFactory, QBM.AppServer.Client

  • /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.

  • -D: Runs debug compilation.

  • -S: Skips running the npm install command in the application folder.

  • -P: Prevents libraries being build in the application folder.

  • /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

connect

Establishes a database connection.

If a connection to a database has already been established, this is closed and a new connection is then established.

Parameters

Login parameter:

  • /conn <database connection>: Specifies the database you want 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.ServiceClientFactory, QBM.AppServer.Client

Related topics
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen