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
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.
-
/solution <path to solution project file>: Specifies the path to the solution project file to use. If you leave this parameter empty, a database project is used.
-
/mode <compile mode>: Specifies the compilation mode:
-
normal: Runs a complete compilation (default mode).
-
nostore: Assemblies are not saved in the database.
-
nocompile: Creates only C# code. The compilation is not executed.
-
nocodegen: Executes only the compilation. No C# code is generated.
-
-E: Enables extended checks.
-
-D: Compiles with debug information.
-
/csharpout <path to folder>: Specifies the path to the folder in which you want to save the C# files.
-
/copyapi <path to folder>: Specifies the path to the folder to which you want to copy the imx-api.tgz file.
-
/apidll <path to an API DLL>: Specifies the path of the API DLL file to use. The /solution and /branch parameters are ignored if you use this parameter.
-
/branch <compilation branch ID>: Specifies the compilation branch under which the project is saved. You must also specify the parameter -D.
-
/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
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.
-
/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.
-
-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.
-
/updatecredentials Domain=<domain name>;Account=<user account>;Password=<password>: Specifies the credentials to use for automatically updating the API Server. Example: Domain=MyDomain;Account=MyAccount;Password=foo
-
/apptoken <application token>: Specifies the application token for the API Server.
-
/pool <application pool>: Specifies the name of the application pool to use. If you do not enter anything here, a new application pool is created that the web application is installed on.
Related topics
