compile-api
Compiles the API and saves the result to the database.
Parameters
Login parameters:
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.
-
/copyapi <folder path>: Specifies where to copy the imx-api.tgz to.
-
/copyapidll <API DLL path>: Specifies which API DLL file to use. The /solution and /branch parameters are ignored if you use this parameter.
-
/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.
Related topics
repl
Starts the ImxClient command line tool in REPL mode.
In this mode, the following actions are performed in an infinite loop:
-
Read commands from stdin.
-
Forward commands to the relevant plugin.
-
Output the results of processing to stdout.
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 parameters:
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
install-apiserver
Installs an API Server on the local Internet Information Services (IIS).
Parameters
Login parameters:
Required parameters:
-
/app <application name>: Specifies which name is used for the application (for example, in the brower's titlebar).
-
/sessioncert <certificate thumbprint>: Specifies which (installed) certificate is used for creating and verifying session tokens.
TIP: For example, to obtain a certificate thumbprint, you can use the Manage computer certificates Windows function and find the thumbprint through the certificate's detailed information.
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.
-
-u: Allows insecure HTTP connections to the API Server website. By default, the API Server website can only be opened over an encrypted connection.
-
/site <site name>: Specifies the website on the IIS under which the web application will be installed. If you do not enter anything, the website is found automatically (normally Default website).
-
/searchservice <URL>: Specifies the application server's URL that the search service you want to use is hosted on.
NOTE: If you would like to use the full text search, then you must specify an application server. You can enter the application server in the configuration file at a later date.
Related topics
