Tchater maintenant avec le support
Tchattez avec un ingénieur du support

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

setup-web

Installs necessary files for the development of TypeScript clients.

Parameters

Login parameter:

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

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

Optional parameter.

  • /conndialog <Option>: Specify 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.

  • /root: Enter the path to the main folder.

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

  • /path <API project path>: Specifies the directory that the files are installed in. If you do not enter anything here, the current directory is used.

  • /branch <Compilation branch ID> Specifies the compilation branch for installing the files.

If you do not use any of the following parameters, all the install steps are carried out. Once you use one of the parameters, only the corresponding install steps are carried out. You can uses multiple parameters.

  • -A: Create a link to the assets folder.

  • -L: Initialize the libraries.

  • -P: Binds Plugins to the web application.

Related topics

run-apiserver

Starts or stops a self-hosted API Server.

This command requires a database connection.

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.

  • -S: Stops the API Server.

  • /baseaddress <URL with port>: Specifies the web application's root URL and port.

  • /baseurl <root URL>: Specifies the web application's URL.

  • /branch <compilation branch ID>: Specifies the compilation branch with the API you want to start the API Server for.

  • -D: Loads debug assemblies.

  • -C: Compiles the API with source data from the database.

  • -T: Queries the status of the current API Server.

  • -B: Locks the console.

  • /compile <solution file path>: Compiles the API with source data from the given (local) solution project.

  • /excludedMiddlewares <middleware name1, middleware name2, ...>: Specifies which middleware services are not be made available. Enter multiple values separated by a comma.

Related topics

check-translations

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

Parameters

Login parameters:

  • /conn <database connection>: Specifies the database 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.

Related topics

version

Shows the version of the ImxClient command line program in use.

Related topics
Documents connexes

The document was helpful.

Sélectionner une évaluation

I easily found the information I needed.

Sélectionner une évaluation