Chat now with support
Chat with 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

fetch-files

Loads all files of the HTML Development machine role from the database and saves them in a local file.

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.

  • /path <path to target folder>: Enter the path to the folder in which you want to save the files. If you do not enter anything here, the current directory is used.

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

Related topics

push-files

Saves files that you have changed locally back to the database.

Parameters

Login parameters:

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

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

Mandatory parameter:

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

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.

  • /path <path to the folder>: Specifies the directory where the altered files are kept that will now be saved in the database.

  • /tag <uid>: Specifies the UID of a change tag.

  • /add <file1;file2;...>: Specifies which new database files are added. Use relative paths.

  • /del <file1;file2;...>: Specifies which database files are deleted. Use relative paths.

  • -C: Prevents the saving of changed files and saves only new files, and deletes files from the database.

Related topics

get-apistate

Queries the compilation status of the API 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. Example: 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 this parameter in the Designer. Use the following formats when defining the rules:

https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.filesystemglobbing.matcher

Use the | character to separate 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.

  • /path <path to the folder>: Specifies the directory where the files you want to compare are kept. 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