Chat now with support
Chat with Support

Identity Manager 9.2.1 - API Development Guide

get-apistate

Queries the compilation status of the API 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

  • /branch <compilation branch ID>: Queries the compilation status of the API saved under this compilation branch.

  • /htmlapp <name of the HTML package>: Returns data for the specified HTML package.

  • -D: Returns data for debug assemblies.

  • -R: Returns data for release assemblies.

Related topics

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 specifying the rules, use the format defined in:
https://docs.microsoft.com/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 parameter:

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

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

Required parameters:

  • /targets <target1;target2;...>: Specifies which machine roles you want to use.

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

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

inject-package

Installs packages from a tgz file into the node_modules directory of the working directory.

This is intended to be used only with local, dependency-free packages that do not require a full NPM installation.

Parameter

Required parameters:

  • /inject <package1>,<package2>,...: Specifies which packages to install. Enter the packages' names, separated by commas.

Optional parameter:

  • /workspace <working directory path>: Specifies the working directory where the packages will be installed in the node_modules subdirectory. If you do not enter anything here, the current directory is used.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating