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

Identity Manager 8.2 - 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 methods API Server ImxClient command line program

get-filestate

Compares the local file structure with the file structure in the database.

Using the QBM | ImxClient | get-filestate | NewFilesExcludePatterns configuration parameter, you can define which files are excluded from the synchronization. This prevents excessive load during synchronization. The node_modules and imx-modules folders are excluded from the synchronization by default.
You can adjust the configuration parameters in the Designer. When setting the rules, use the formats defined here:
https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.filesystemglobbing.matcher

Use the | character to delimit multiple entries.

NOTE: This configuration parameter is generally only used to exclude new files from the synchronization. Files that already exist in the database are not taken into account.

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.

  • /targets <target1;target2;...>: Specifies which machine roles you want to use. If you leave this empty, the HTML Development machine role is used.

  • /workspace <directory path>: Specifies the working directory where the files you want to match are located. If you do not enter anything here, the current directory is used.

Related topics

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

  • /workspace <API project path>: Specifies the working directory where the files are to be installed. If you do not enter anything here, the current directory is used.

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

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

setup-workspace

Sets up the Angular working directory.

Parameters

Optional parameter:

  • /path <working directory path>: Specifies the working directory. If you do not enter anything here, the current directory is used.

Related topics

workspace-info

Queries the state of the Angular working directory (existing applications and last API client update).

Parameters

Optional parameter:

  • /workspace: Specifies which working directory to query. If you do not enter anything here, the current directory is used.

Related topics
Documents connexes

The document was helpful.

Sélectionner une évaluation

I easily found the information I needed.

Sélectionner une évaluation