branch
Manages compilation branches in the database.
Parameters
If the command is called without specifying any parameters, this command outputs the total number of compilation branches and their IDs from the database.
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.
-
/id <compilation branch ID>: Queries the field name and corresponding values of a compilation branch.
-
-c /id <new compilation branch ID>: Creates a new compilation branch.
To also specify a description of the compilation branch, use /description <description>.
-
-d /id <compilation branch ID>: Deletes a compilation branch.
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
run-apiserver
Starts or stops a self-hosted API Server.
This command requires a database connection.
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.
-
-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.
-
/asmdir <filepath>: Loads the ZIP files containing the API DLLs and HTML files from the specified directory.
-
/apidll <filename>: Loads the API from the specified file instead of the database.
-
-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
