Specifying Arguments in the JADE Command Line

The JADE command line (or program target), used when running a JADE application from outside of the development environment, contains arguments that enable you to specify your JADE configuration. Each element of the command line has an identifying prefix, followed by an equals sign (=) and a specified value.

Command line elements can be delimited by a space, a tab, or a comma. Arguments containing these delimiters must be enclosed in single quotes ('') or double quote ("") characters.

You can define arguments in the [JadeCommandLine] section of the JADE initialization file that you would normally specify on the command line and you can define two‑level initialization file section names so that multiple programs on the same host can share a JADE initialization file. For details, see "Two-Level Section Names" and "Sharing JADE Initialization Files", in the JADE Initialization File Reference. See also "Placing Initialization File Parameters on the Command Line", in the following subsection.

As the command line structure of the batch JADE Database utility program (jdbutilb) differs from that of other JADE applications, the specification of a command line name argument that matches an initialization file section unique identifier does not apply.

Unless your JADE initialization file is located in the bin directory, specify the ini argument on the shortcut command line rather than in the [JadeCommandLine] section so that the executable knows immediately the location of the JADE initialization file that contains all information required by the program.

You can use the server argument in a command line to specify the server Universal Resource Identifier (URI) target database and the client-server transport, instead of the server and path arguments in a command line and the ServerNodeSpecifications parameter in the [JadeClient] section of the JADE initialization file. For details, see "Format of the Server URI String", earlier in this chapter.

For details about:

Running JADE in thin client mode, see "Invoking a JADE Presentation Client" under "Running the Application Server and Presentation Clients", in Chapter 2 of the JADE Thin Client Guide
Running a JADE client application as a standard (fat) client or a presentation (thin) client from the JADE executable (jade.exe) command line, see "Running a JADE Client Application using jade.exe", in Chapter 1 of the JADE Runtime Application Guide
For information about the arguments that enable you to handle multiple copies of JADE, see "Handling Multiple Copies of the JADE Program", later in this chapter

The command line arguments are listed in the following table.

Argument	Specifies …	Example
app	Application name	app=Jade
path	Full path of your JADE database directory containing your *.dat JADE files	path=c:\jade\system
schema	Schema name (mandatory except when app=Jade)	schema=Faults
ini	JADE initialization file path	ini=c:\jade\system\jade.ini
[server]	Server type	server=SingleUser
[thinClient]	That jade.exe checks only arguments required to run in thin client mode	thinClient=false
[name]	That the program checks for a matching initialization file section name	name=SecureAppServer
[newcopy]	A new copy of jade.exe is to be started	newcopy=false
[host]	Host server node name or IP address	host=cnwchcs38
[port]	Port name or number of the host (server) node	port=6015
[interface]	TCP/IP name or the IP address of the client (local) node	interface=cnwme1c
[localport]	Port name or number of the client (local) node	localport=5017
[appServer]	Remote TCP/IP address or name of the application server	appServer=JadeServer
[appServerPort]	TCP/IP port number of the application server	appServerPort=1500
[startAppParameters] and [endAppParameters]	Arguments to enable HugeStringArray string elements to be collected from the command line arguments and passed to the initialization method so that you can run non-GUI standard or thin clients from the jade executable or non‑GUI client jadclient program command line	startAppParameters c:\jade\unittest.xml DailyTests codecoverage=true c:\jade\logs\unittest.log endAppParameters
[endJade]	The end of JADE-specific arguments (applicable only to the non-GUI client jadclient program, and ignored for all other JADE programs)	endJade
[arguments]	Optional user-defined arguments for the jadclient program	MyNonJadeApp.exe

When specifying your JADE command line:

You must include the application (app) argument.
You must include the schema argument (except when app=Jade).
For JADE executables, you must include fully qualified name of your JADE initialization file in the ini argument.

You must include the path (path) argument. The path argument specifies the location of the JADE database. The database path cannot be greater than 260 characters.

When running in multiuser mode, the path is always relative to the viewpoint of the server node; for example, c:\jade\system refers to the c: drive of the server node and not that of the local client workstation.

You should specify the fully qualified path name.

When you specify a relative path name in the path argument of the command line, the path name is first converted to an absolute path, by using the following rule.

A relative path name with a single leading slash character is pre‑pended by the first two characters of the JADE HOME directory on the server node (that is, drive‑letter:), which is assumed to be the parent of the bin directory. For example, if your installation directory is Jade\bin (that is, your JADE HOME directory is Jade) and you specify path=system, the full directory path is Jade\system on the server).

In the following examples, the JADE HOME directory is assumed to be c:\jade.

Path Specified in the Command Line	Actual Path
path=/jade71/system	c:/jade71/system
path=system	c:/jade/system

The ini argument specifies the location of the JADE initialization file. Letters specifying the drive are relative to the viewpoint of the client node. The initialization file defaults to Jade.ini, located in your database (system) path.
The optional server argument specifies SingleUser or MultiUser.

If you do not specify a server value, the Server parameter in the [Jade] section of the JADE initialization file is used. If this parameter is not specified in the JADE initialization file, the server defaults to MultiUser.
When you specify the name of a port rather than the number in the optional port argument, the port name cannot start with a numeric value.
Identifying prefixes are case‑insensitive.
Spaces are required only between the end of one argument and the start of the next.
Names and paths with embedded spaces should be enclosed in double quote ("") or single quote ('') characters.
If you want to specify arguments to your non‑GUI client jadclient or jade application, specify the startAppParameters argument as the last of the JADE arguments before the first of your own arguments in the jadclient or jade.exe command line.

The jadclient or jade program treats processing arguments enclosed in double ("") or single ('') quotation marks after the startAppParameters argument as single-string entries in the HugeStringArray. The handling of strings in this HugeStringArray is application‑specific. For example, dir=program files is treated as a two‑string entry and dir="program files" is treated as a one‑string entry. How these entries are handled is determined by your application.

Support for the endJade argument is maintained to provide backward compatibility for existing applications. It is recommended that your applications use the startAppParameters and endAppParameters arguments.

All other programs (for example, jadapp.exe and jadload.exe) do not parse the command line beyond the startAppParameters argument, so any subsequent arguments will be ignored.
Specify arguments (options) once only, in any order.

If an argument on the command line is duplicated, the last occurrence found on the command line is used.
When running JADE thin client applications in multiuser mode, ensure that the TCP/IP port number specified in the jadapp (or jadappb) command line appServerPort argument is a different port number from that specified for the database server (for example, the jadrap JADE Remote Node Access program).

The database server TCP/IP port number is specified in the ServerNodeSpecifications parameter remote port value in the [JadeClient] section and the NetworkSpecification parameter IP‑address value in the [JadeServer] section of the JADE initialization file.

In multiuser mode, you can optionally use:

The host command line argument, to specify the host server node name or IP address.

This argument specifies a host name that is resolvable by the Domain Name Server (DNS) or host file, and has a maximum length of 255 characters.
The port command line argument, to specify the host port name or number.

If you use this argument to specify the port name, you must update the applicable file in a Windows operating system, as follows.
```
/<winnt>/system32/drivers/etc/services
```
```
/<windows9x>/services
```
A port name cannot begin with a numeric value.
The interface command line argument, to specify the client (local) node name or IP address.

This argument specifies a host name that is resolvable by the Domain Name Server (DNS) or host file, and has a maximum length of 255 characters.
The localport command line argument, to specify the client (local) port name or number.

If you use this argument to specify the local port name, you must update the applicable file in a Windows operating system, as follows.
```
/<winnt>/system32/drivers/etc/services
```
```
/<windows9x>/services
```
A local port name cannot begin with a numeric value.

Specify the optional interface and localport arguments if you want to bind a specific network adapter in a server node that has more than one network adapter installed; for example, to allow an administrator to ensure connections from clients connect on the fastest interface or to allow easier security when used in conjunction with a firewall or router access list. (By default, JADE defaults to the primary network adapter in the node.)

If you do not specify a host or a port argument, the ServerNodeSpecifications parameter value in the [JadeClient] section of the JADE initialization file is used. If neither of these values is specified in the JADE initialization file, they default to LocalHost and 6005, respectively.

The host, port, interface, and localport command line arguments, if specified, override (but do not update) the ServerNodeSpecifications parameter [host‑name or IP‑address], [remote‑port], [local‑interface‑name or IP‑address], or [local‑port] values, respectively, in the [JadeClient] section of the JADE initialization file.

If you are running multiple copies of JADE, you can have multiple jade.exe shortcuts using the same JADE initialization file (jade.ini) by using the optional name argument, instead of having separate files for each copy of JADE that you run. For details about multiple JADE programs on the same host sharing a JADE initialization file, see "Sharing JADE Initialization Files", in the JADE Initialization File Reference.