Command-line switches for the DOORS client and interoperation server

You can use command-line switches to override the registry settings when the IBM® Engineering Requirements Management DOORS® (DOORS) client or interoperation server starts.

For a list of IBM Engineering Requirements Management DOORS (DOORS) database server command-line switches, see Command-line switches for the database server.

The following table include switches that use addins folders to provide DXL programs for creating database explorer menus, module menus, attributes, and layout DXL columns. For more information on the use of DXL in addins folders, see "The DXL Library and Addins menus" in the DXL Reference Manual.

Table 1. DOORS client command-line switches
Switch (abbreviation) Parameter Description
-addins (-a) addins_folders One or more paths to the folders that contain your DXL add-ins files.

Use semicolons (;) to separate the entries, with no spaces after the semicolons. Paths can be local paths, conventional drive mappings, or UNC (universal naming convention) paths.

Each addins folder that you reference with the -addins switch creates a new menu in formal modules. Menu commands are defined by the DXL program in the specified folder.

-attributeaddins (-A) dxl_attributes_folders One or more paths to the folders that contain the programs that you can use for DXL attributes.

Use semicolons (;) to separate the entries, with no spaces after the semicolons. Paths can be local paths, conventional drive mappings, or UNC (universal naming convention) paths.

Each addins folder that you reference with the -attributeaddins switch contains a DXL program that you can use to create an attribute in a formal module. To access the DXL attribute in a module, select Edit > Attributes > New > DXL attribute > Browse.

-batch (-b) dxl_program Runs DOORS in batch mode. DOORS starts without the GUI (it suppresses the login screen and the database explorer), runs the specified DXL program, and then stops.

In batch mode, you normally need other switches like -user, -password and -project to log in and specify the current project.

The parameter of the -batch switch specifies the file that contains the DXL program that you want to run in batch mode.

For example,
C:\> doors -b dxl_programs\batch_analysis.dxl -p Car -u "Jill" 
-caching (-k)   Enables streaming for the transfer of data between the database server and the client. This option can improve data transfer performance over a WAN.
CAUTION:
While data is loading, it is cached to the localdata area in the client machine, which might pose a security risk. The data is cleared when loading is complete.
-certName card_name:cert Identifies the label of the certificate that is used to identify the client during secure authentication.

If you are using the pkcs#11 standard, the card_name is identified by -pkcs11token, and cert is the name of the certificate your system is using. For example, "Crescendo C700:certOne".

-cli (-C) dxl_string or "#include <dxl_program> DXL code that runs when DOORS starts before the splash screen is displayed. The parameter is either:
  • A DXL code fragment
  • A #include statement that specifies the path to a DXL program
-data (-d) port@server Specifies which DOORS database to use.

The parameter specifies the port that the server is using and the name of the server computer (for example, 36677@myserver).

-defopenmode (-o) Either

READ_ONLY

READ_WRITE

READ_WRITE_SHARED

Sets the edit mode that formal modules are opened in when you double-click them in the database explorer.

The parameter is READ_WRITE for exclusive edit mode and READ_WRITE_SHARED for shareable edit mode.

Note: This parameter must be uppercase, unless you use the single letter abbreviations (r, w, and s).
-defopenlinkmode (-O) Either:

READ_ONLY

READ_WRITE

READ_WRITE_SHARED

Sets the edit mode that formal modules are opened in as the result of following a link.

The parameter is READ_WRITE for exclusive edit mode and READ_WRITE_SHARED for shareable edit mode.

Note: This parameter must be uppercase, unless you use the single letter abbreviations (r, w, and s).
-dxl (-D) dxl_string or "#include <dxl_program>" DXL that runs immediately after DOORS starts. The parameter is either:
  • A DXL code fragment
  • A #include statement that specifies the path to a DXL program
-home (-H) doors_home The DOORS home directory, including the full path to the folder that DOORS is installed into.
-certdb folder_name Identifies the folder that contains the key database files that contain the keys for the Rational® Directory Server and DOORS SSL.

The default is DOORS\9.version\certdb\.

If you want to put the key database files for DOORS SSL in a separate folder, use the -keyDB switch. The -keyDB switch takes precedence over -certdb.

-keyDB filename The full path to the key database file that contains the keys that are used for DOORS SSL authentication and validation, including the file name.

The default is DOORS\9.version\certdb\client_authentication.kdb.

This switch takes precedence over -certdb. You can specify a location for the Rational Directory Server key database folder by using -certdb and specify a separate location for the DOORS SSL key database file by using -keyDB.

-layoutaddins (-L) layout_dxl_folders One or more paths for layout DXL folders.

Use semicolons (;) to separate entries, with no spaces after the semicolons. Paths can be local paths, conventional drive mappings, or UNC (universal naming convention) paths.

Each addins folder that you reference with the -layoutaddins switch contains a DXL program that you can use to create a layout DXL column in a formal module. To access the layout DXL program in a module, select Insert > Column > Layout DXL > Browse. The properties of the column are defined by the DXL program in the specified folder.

-localdata (-f) folder_name A folder in the local computer that is used for temporary storage of data that is copied from the DOORS database server.
-logxconfig (-X) full_file_name The full name of the log4cxx configuration file, for example C:\Logs\Client\logging-config-client.xml. Log4cxx is a framework for logging application messages.
When you use this parameter in the command line or the registry, the client records application messages in the specified configuration file. Six levels of message are logged.
  • TRACE
  • DEBUG
  • INFO, including ACK, CONFIRM, and QUERY
  • WARNING
  • ERROR
  • FATAL
-notriggers (-T)   Turns off triggers. You must be either a database manager or a custom user who has the power to manage the database to turn off triggers
-password (-P) password The password for the session.
-pkcs11driver driver If you are using the pkcs#11 standard, this switch identifies the name of the driver for the card reader, for example c:\windows\system32\aetpkssw.dll.

Use this switch when you are using smart cards that are based on public key infrastructure (PKI) authentication to log in to DOORS.

-pkcs11token card_name If you are using the pkcs#11 standard, this switch identifies the type of smart card the system is using, for example "Crescendo C700".
-project (-p) project_name The name of the project that you want to open at the start of the session. The contents of the project are displayed in the right pane of the database explorer.

If you use the -batch switch, the parameter specifies the current project.

-projectaddins (-J) project_addins_ folders One or more paths for project DXL add-ins directories.

Use semicolons (;) to separate entries in the list, with no spaces after the semicolons. Paths can be local paths, conventional drive mappings, or UNC (universal naming convention) paths.

Each addins folder that you reference with the -projectaddins switch creates a new menu in the database explorer. Menu commands are defined by the DXL program in the specified folder.

-user (-u) username The user name of the user for the session.
-W nowait When you are running a batch process, and there are any errors or printed output, they are sent to a command window. DOORS continues to run until the command window is closed.

Using -W as part of the command line when you run a batch process closes any command windows automatically and stops DOORS.

This table lists the command-line switches that you use when you are running the DOORS client as an interoperation server:
Table 2. Command-line switches for the interoperation server
Switch (abbreviation) Parameter Description
-brokerHost DWAbroker This switch identifies the IBM Engineering Requirements Management DOORS - Web Access (DWA) broker, where DWAbroker is the hostname of the computer that the DWA server is running on.
-brokerPort port This switch identifies the number of the port that the DWA broker is running on. The default port is 61616.
-data (-d) port@server Specifies which DOORS database to use.

The parameter specifies the port that the server is using and the name of the server computer (for example, 36677@myserver).

-interop   This switch runs the DOORS client as an interoperation server.
-lightServer  

This switch instructs the interoperation server not to service any module open commands. This switch ensures that a server is always available to handle lighter load tasks, such as authenticating a login.

Enable this switch for one interoperation server in each set of four interoperation servers.

-logfile (-l) full_file_name The full name of the log file for the interoperation server, for example C:\temp\interop.log.

When you use this parameter in the command line, the system records any reported DXL errors to a file instead of showing the errors on the screen.

When you use this parameter in the registry, the system takes the information that is recorded in the Windows event log and records it in the log file and in the application log. The records have DOORS_DB_SERVER in the Source field.

Use this parameter with -logLevel.

-logLevel integer The amount of information to include in the log file.

Use this parameter with -logfile.

-maxMemory integer The maximum amount of memory that is allocated to running the interoperation server. For more information, see Installation topology and minimum requirements.

Feedback