18.3 X_RUN Parameter Summary

These parameters have been listed in alphabetical order so that you can more easily find them.

If a parameter is specified more than once, then the last value processed is used.

If executing X_RUN on IBM i, only the PROC= parameter is required.

When used, the parameter must be followed by an = sign and the value, without any spaces.

Some of these parameters are very specialized and you will find details about them by following the link.

Param.

Meaning / Values

Req

Default Value

ASPW=

Application Server Password

No

Refer to 18.4.1 User ID and Password Default Values

ASUS=

Application Server User

No

Refer to 18.4.1 User ID and Password Default Values

BTN2=

Function key to simulate when mouse button 2 is double clicked. Not supported on Linux.

No

Prompt key

BTN3=

Function key to simulate when mouse button 3 is double clicked.

No

Prompt key

CDLL=

The name of the .DLL that should be used for communications to an attached server.

Note: LCOMGR32.DLL must be used when connecting to a Visual LANSA Server.

No

The CMTH parameter is set to the relevant default value (used for both development and execution connections to servers) when the Visual LANSA system is installed.

CIPH=

The symmetric cipher to use when LANSA calls OpenSSL. This value is case sensitive. Possible values are listed in the OpenSSL documentation at www.openssl.org/docs. The value is one that is accepted by the EVP_get_cipherbyname API.

 

The default is aes-256-cbc
No other values are currently supported or tested. Use at your own risk.

CMTH=

The communication method that should be used for conversations with any attached server.

T = Native TCP/IP

The C and T values are identical and can be used interchangeably. They are provided to allow you to more easily remember which value to use.

Note: C or T must be specified when connecting to a Visual LANSA Server.

No

The CMTH parameter is set to the relevant default value (used for both development and execution connections to servers) when the Visual LANSA system is installed.

DASO=

Data Area Storage Option parameter. It may be set to 'D' or 'F'.

D indicates that data area value storage and locking should be emulated using table LX_DTA and the standard LOCK_OBJECT/UNLOCK_OBJECT logic.

F indicates that data area value storage and locking should be emulated using flat operating system files stored in the same directory as any relative record number assignment files (refer to the RPTH= parameter). Locking and unlocking is achieved by using the appropriate operating system facilities for low level file access.

Refer to the LANSA Application Design Guide for Guidelines, Rules and Limitations that apply when using the DASO=F option.

No

D is the default value.

DATF=

Date format to be used. Allowed values are DMY, MDY and YMD. If running in SuperServer mode to an IBM i server, this causes the job on the IBM i server to be run  with this date format which may differ from the IBM i system date format, QDATFMT.

No

X96SDF column from LX_F96

DATS=

Is used to specify from where to retrieve the date and date format.

S: Specifies that the date and date format are to be retrieved from the system values

J: Specifies that the date and date format are to be retrieved from the job attributes

Note: IBM i only and is equivalent to the DATE_SRCE parameter of the LANSA command.

No

S is the default value.

DBCL=

Database Connection Level

1.   Handles database connections as in Visual LANSA V11.3 and earlier. Note that DBCF flags may still effect this connection, but they are not supported. Therefore, do not attempt to use DBCF flags when DBCL=1.

2.   New database connection logic and support for DBCF flags.

No

2

DBCF=

Database Connection Flags

This option has been included for future flexibility, but currently is not supported. For further details refer to 18.4.2 DBCF Flags.

When this parameter is set on the X_RUN command line or equivalent, it only affects the main LANSA database, including SUBMITTED jobs and SuperServer jobs. It does not affect PC Other Files.

This parameter is unusual in that it can be specified many times. Each setting takes the form: DBCF=<flag>:[Y/N], where the flag is one of the values specified in 18.4.2 DBCF Flags and Y sets the flag on and N sets it off. For example, DBCF=CT_INTEGRATED_LOGON:Y

No

CT_INTEGRATED_LOGON:Y

DBCC=

Cursor Concurrency
ODBC default = 1 - SQL Server only

Refer to LANSA and SQL Server - Configuration Options in the Tips and Techniques on the LANSA web site.

 

Defaults to Read Only (1)

DBCT=

Cursor Type:
ODBC default = 0 - SQL Server only.

Refer to LANSA and SQL Server - Configuration Options in the Tips and Techniques on the LANSA web site.

No

Defaults to Static cursor (3)

DBHT=

Details used, such as the Computer Name and Port, for debugging.

No

The DBHT parameter is created from the LANSA Settings. Refer to Debug in the Visual LANSA User Guide.
You would normally not use this parameter.

DBID=

Database Id
When executing X_RUN on IBM i, this parameter is not needed.

Refer to 18.4.3 DBID, DBUT, DBII and DBIT Parameters for details

No

The default is to *LOCAL on IBM i
and LX_LANSA on other platforms.

DBII=

Internal/Repository Database Identifier.

Refer to 18.4.3 DBID, DBUT, DBII and DBIT Parameters for details

No

Defaults to the same value as DBID=, so if they are the same you do not need to specify DBIT

DBIT=

The type of dictionary/repository database specified in the DBII= parameter. If the DBII= parameter is not supplied, the DBUT database type will be used.

Refer to 18.4.3 DBID, DBUT, DBII and DBIT Parameters for details

No

The default values are:
MSSQLS for Windows
ODBCORACLE for Linux.

 

DBLK=

Database Lock Timeout in seconds.

Setting this parameter overrides the LOCK_TIMEOUT setting in X_DBMENV.DAT for ALL databases. There are database-specific settings related to LOCK_TIMEOUT apart from the timeout itself, so it is imperative that you review 18.8 Lock Timeout.

No

The default is 0

A value of 0 indicates there is no timeout.

DBMR=

Enable MARS - SQL Server only.

Refer to LANSA and SQL Server - Configuration Options in the Tips and Techniques on the LANSA web site.

No

Defaults to No.

DBSA=

When using Adaptive Server Anywhere, after 240 minutes of no activity from a client, by default, it is disconnected.

This can cause a problem if connections are idle for long periods. To ensure there is activity on all open connections, they are periodically activated.

This argument specifies how often this happens. The value is specified in minutes.

No

10

DBSP=

Set savepoint - SQL Server only.

Refer to LANSA and SQL Server - Configuration Options in the Tips and Techniques on the LANSA web site.

No

Defaults to No.

DBSS=

May be used to adjust the maximum number of reusable SQL statements that are cached for reuse.
For details, refer to 18.4.4 DBSS Parameter - Performance Tuning.

No

The default is 50.

DBTB=

Trim DBCS Blanks.
'Y' = Yes or 'N' = No.

When DBTB=Y, when it receives focus, any input capable alphanumeric shift J field presented by a Function or Component will have DBCS blanks trimmed from it. There is no change to the behavior when such a field loses focus.

Examples of controls that would exhibit this behavior include input capable fields in browse lists and in RDMLX list-type controls such as grid and list view.

This does NOT include fields presented by Active-X controls (or any COM object), unless the Active-X Control is generated by LANSA.

No

Y

DBTC

Attempt Database Trusted Connection before userid/password connection.

When this is set to 'Y', then a trusted connection is attempted before using a User ID and password to establish the connection.
If DBTC is set to 'Y', DBCL is automatically set to 2.

If DBTC is set to N, a log in using the Usr ID and Password is attempted.

No

No

DBUG=

Turn on debugging

'Y' (Yes) or 'N' (No)

No

'N'

DBUS=

User name for the database login. When executing X_RUN on IBM i, this parameter is ignored.
On other platforms, after logging on to the database, the value of DBUS is changed to reflect what was required to logon to the database. For example, if trusted connections are being used then SQL Server will return an empty value for user ID. This value is then assigned into DBUS. Therefore when GET_SESSION_VALUE is used it may be empty. It is also altered by the default behavior.

No

USER= argument. Refer also to 18.4.1 User ID and Password Default Values.

DBUT=

The type of user database specified in the DBID=parameter.

Refer to 18.4.3 DBID, DBUT, DBII and DBIT Parameters for details

No

The default values are:
MSSQLS for Windows
ODBCORACLE for Linux.

DELI=

Delete packages from the host monitor after installation.

RDMLX check in or deliver to copies package(s) to the target, x_hmrqst\<user> directory on IBM i,  from where it is installed.  After installation is completed the package(s) will be automatically deleted unless you have a value of DELI=N in X_LANSA.pro

Allowable values for this parameter are Y (Yes) and N (No).

No

Y

DEVE=

User is a developer

'Y' (Yes) or 'N' (No)

No

'N'

DPTH=

Directory in which emulated IBM i data queues are to be created / accessed.

No

<sysdir\x_ppp (where ppp is the partition name).

DRIV= or ROOT=

The path containing Visual LANSA.

This parameter is no longer required in Windows environments.

No

If Linux then '/lansa', else the path from which X_RUN.exe was executed, provided it contains 'X_LANSA'

EDLC=

The parameter only applies to DBCS. It controls whether any DBCS string being entered or assigned is checked for length compatibility with EBCDIC based DBCS systems that use the shift in and shift out characters.

Allowable values for this parameter are Y (Yes) and N (No).

Use EXTREME CAUTION when turning this option off (value N).
This will allow you to store DBCS strings that are fundamentally incompatible with EBCDIC shifted systems. A later design change to, say, a client/server application, that involves an EBCDIC server (such as an IBM i) may cause severe DBCS string storage/truncation problems.

Note that when EDLC is enabled (default value, or value Y), there are still cases where EDLC length checking does not occur:

1.  In a Form or Reusable Part, where the field is not shown on the screen or defined as a component (no DEFINE_COM), and the value is assigned by a Change command or RDMLX assignment (:=)

2.  In a Function, where the value is assigned by a Change command or RDMLX assignment (:=).

No

Y

EXCH=

Exchange file name

(Designed for internal LANSA use only)

No

Null

EXPM=

Name of file to contain *LIMPORT export messages.

No

import.log in temporary directory.

EXPR=

Path that contains the file(s) for *LIMPORT to import.

If the value of this parameter is the special value 'QDLS\<folder>', then the import will be attempted via a direct connection to the IBM i N.B. the parameters PSLU and PSPW must be specified (as a minimum).

No

The standard File Open dialog is presented.

EXPS=

Action to take when importing object security records.
D = Delete: all existing security records for an object will be deleted before import.
R = Replace: an existing user security record will be replaced with a matching incoming record.
A = Append Only: all existing user security records will be retained, matching incoming records will generate a duplicate warning.

No

D

FATL=

Y= forces the display of fatal errors in client-side applications when QUET=Y.
Refer also to 18.4.13 QUET & FATL Parameters (Quiet Mode of Operation & Fatal) for further information.

 

 

FLDX=

Interpret Numeric Keypad.
Enter Key as a Field Exit key (i.e. The Tab Key).
This will occur on all controls except push buttons. That is, entry fields, check boxes, radio buttons and all lists.
'Y' (Yes) or 'N' (No)

No

Y

FORM=

Form name

No

Null

FUNC=

Function name

No

Null

FXQF=

Force *.XQ* flat, read-only, repository files into a Visual LANSA environment using this parameter set to  FXQF=*ALL. Refer to 18.4.5 FXQX Parameters for information.

 

 

FXQM=

Use this parameter to control the maximum number of flat files that are kept concurrently open.
Refer to 18.4.5 FXQX Parameters for information.

No

 

GUSR=

Group User Name

No

*NONE

HELP=

Specifies the run-time help system to be used.
OLD indicates old-style two-window help.
STD indicates the default single-window help with tab control for Contents and Index.
WIN is reserved for Windows Help. This is no longer to be used for new applications.

HTM is reserved for HTML Help.

No

STD for Windows.

OLD (forced) for all other operating systems.

HLPF=

Specifies the help file to be used for HTML Help (HELP=HTM).

Note: From Windows version Vista onwards, the viewer for HLP files will no longer be distributed by Microsoft.

For Windows Help, the filename is specified minus the language code and file-type extension. For example, HLPF=MYHELP might be expanded to MYHELPFRA.HLP.
For HTML Help, the filename is minus the file-type extension. For example, HLPF=MYHELP would be expanded to MYHELP.CHM.
For HELP=STD or HELP=OLD, the value of this parameter is ignored.

This means that when you use X_RUN HELP=WIN HLPF=C:\TEMP\MYHELP, the actual file being looked for will be named C:\TEMP\MYHLPFRA.HLP (if LANS-FRA is used) or C:\TEMP\MYHELPENG.HLP (if LANG-ENG is used).

No

Depends on value of HELP.
For WIN, the default is the Visual LANSA Help File.
For HTM it is the HTML Help version of the Visual LANSA Help File.

The default location for help files is the X_LANSA\EXECUTE\<language> directory.

HSKC=

Enables High Speed Key Checking. This feature should only be used for Windows or Linux platforms.

For information refer to 18.4.6 HSKC Parameter.

No

 

ICWD=

Change working directory on startup to x_lansa. Only supported on IBM i.
Y = Yes   N = No.

No

N

INIT=

Specifies a function to be automatically executed on application startup. Refer to 18.4.7 INIT and TERM Parameters for information.

No

 

ITxx=

Trace Parameters. For information, go to 18.4.8 ITxx - Trace Parameters.

No

 

JOBN=

Job Name

No

Null

LANG=

Language.
When executing X_RUN on IBM i, this parameter is not necessary.

Yes

The default is the partition default language from the LANSA command.

LDAV=

LDA (local data area) file name

No

Null

LOCK=

Y indicates that Object Locks should be obtained when executing a LANSA object. This is a read-only lock which blocks requests to obtain exclusive access to the object. For example, compiling an object requires exclusive access. Thus a Form cannot be compiled whilst it is being executed.

LOCK=Y should only be used in a development environment. It has no purpose in a deployed environment.

No

 

LOGO=

Indicates whether to show a logo indicating the version and date of Visual LANSA system being used. Allowed parameter values are Y and N.

No

N

LPTH=

Fully qualified root directory for storage of BLOB and CLOB disk files.

Requires an ending '\'.

No

Refer TPTH

MENU=

This parameter determines whether new icon and bitmap style menus and action bars should be used.

No

Y

MODE=

'I' (interactive) or
'B' (batch)

No

B for Linux otherwise 'I'.

ODBA=

Deprecated. Number of database connections now automatically determined by LANSA.

 

 

ODBI=

Used to specify the transaction isolation level for all ODBC database connections.
See ODBI Parameter for details.

No

Default is 0 (zero).

PARM=

Parameter file name

(Designed for internal LANSA use only)

No

Null

PART=

Partition
When executing X_RUN on IBM i, this parameter is not needed.

Yes

The default is to SYS from the LANSA command.

PBCM=

Specifies the color to be used for Column Headings. Values are G=Green, W=Black, R=Red, T=Turquoise, Y=Yellow, P=Pink, B=Blue. Invalid values are ignored.

No

B

PBFP=

Specifies the color to be used for Field Prompts (i.e. Labels and Descriptions). Values allowed are G=Green, W=Black, R=Red, T=Turquoise, Y=Yellow, P=Pink, B=Blue. Invalid values are ignored.

No

W

PPTH=

Fully qualified directory for report files if PRTR=*PATH.
Requires an ending '\'.

No

x_lansa\x_ppp\ on the DRIV=path where ppp=partition.

PROC=

Process name

Yes

 

PROG=

This parameter allows you to rename the X_RUN.exe file while allowing the SUBMIT command to work correctly.

Refer to 18.4.11 PROG Parameter for details.

No

 

PRTR=

Printer port name (e.g. LPT1, LPT2) or special value *PATH which indicates reports are to be output to a file rather than a printer. For Linux this should be the same dest name which would be used by the lp command.
N.B. Use of PRTR with any value other than *PATH is deprecated for Windows and is no longer supported. Existing applications may continue to function correctly, but LANSA does not warrant its use. Use the WPxx parameters instead.

No

Linux: *PATH

Windows: LPT1

PSPW=

Primary Password for Server and Client

No

PSWD= argument.
Refer to 18.4.1 User ID and Password Default Values for details.

PSTC=

Specifies that Windows Authentication is used. Refer to 18.4.1 User ID and Password Default Values for details.

No

Default is N.

PSUS=

Primary Server User.

No

Refer to 18.4.1 User ID and Password Default Values for details.

PSWD=

Password for the database login.
When executing X_RUN on IBM i, this parameter is ignored.

No

PSPW= argument. Refer to 18.4.1 User ID and Password Default Values for details.

PSxx=

Please note The PSxx parameters are primarily provided to aid developers in testing applications in SuperServer mode.
Refer to 18.4.12 PSxx Server Parameters for the parameters available in the PSxx range.

No

 

QCHK=

Indicates approximately how long an active monitor should wait before checking the job queue. Refer to Additional Job Queue Monitor Parameters for details.

No

Default is 10 seconds

QHLD=

Indicates how long a held job queue monitor should wait before rechecking the job queue directory for release instructions. Refer to Additional Job Queue Monitor Parameters for details.

No

Default is 30 seconds

QENC=

Specifies that the job details are to be encrypted before placing them on the queue. Refer to Encrypting the Job Queue Details for details.

Yes

Default is N

QUET=

Used to force a batch job into a quiet mode when  normal error and status reporting activities are suppressed.

Refer to 18.4.13 QUET & FATL Parameters (Quiet Mode of Operation & Fatal) for details.

Yes

QUET=N is the default.

RNDM=

Render Mode. H = Hardware, S=Software

No

Default value is H.

RNDR=

Render Style. W = Win32, M = Mixed, X = DirectX

No

Default value is W.

RPTH=

Fully qualified directory for RRNO (relative record number) files.
Requires an ending '\'.

Note that if Visual LANSA is installed on a server, then this path must be located on the server.

No

x_lansa\x_ppp\ on the DRIV=path where ppp=partition.

RRNA=

The number of RRN (Relative Record Number) assignments that are to be pre-allocated when inserting data into a table.
Refer to 18.4.14 RRNA and RRNB Parameters - Performance Tuning for details.

Yes

The default value is 1.

RRNB=

Specifies whether Windows operating system file buffering is to be used when accessing the RRN or *AUTONUM data area assignment files. Specify this argument as Y or N.
Refer to 18.4.14 RRNA and RRNB Parameters - Performance Tuning for details.

 

The default is N.

TASK=

Task identifier to be used when executing applications that are performing development tasks (such as those using the specialized Built-In Functions).

No

Null

TERM=

Specifies a function to be automatically executed on application shutdown. Refer to 18.4.7 INIT and TERM Parameters for information.

 

 

TPTH=

Fully qualified directory for temporary files.

No

Refer to 18.4.15 TPTH Parameter for how TPTH is derived.

UDEF=

User Defined Parameter.
256 byte alpha to be used to pass information into LANSA on the command line.

Use GET_SESSION_VALUE and SET_SESSION_VALUE to get and set the value from RDML.

This parameter has no other use in LANSA. It is provided purely for the use of RDML developers to more easily communicate between LANSA jobs/processes.

No

Empty/blank.

UPCD=

MSI Upgrade Code.
This is set automatically by the MSI Install. It is not recommended to alter it.

No

Null

USER=

User name for Server and Client.
When executing X_RUN on IBM i, this parameter is ignored. USER is the actual IBM i user.

Yes

Refer to 18.4.1 User ID and Password Default Values for defaults.

USEX=

Default User ID used when establishing connections to servers.
When the user id is passed to X_RUN, it puts the exact case in the USEX parameter, the same as the SET_SESSION_VALUE now does.

 

USER is the basis of USEX.

WDTM=

Controls the Windows Desktop Heap in which the process is created.
Refer to 18.4.16 WDTM Parameter (Windows Desktop Heap) for information.

Yes

WDTM=N is the default.

WPxx=

Refer to 18.4.17 WPxx - Windows Printing Extensions for these parameters.

No

 

XAFP=

Indicates whether all fields defined in a function should be exchanged when prompting. Only use this option when position 499 of the system data area (DC@A01) of an associated LANSA for the IBM i system is set to Y. Do NOT use this option in any other circumstances.

Y = exchange all fields on prompt other = do not exchange all fields.

No

N

XCMD=

Obscure certain details in the command line. Refer to 18.4.18 XCMD Parameter for details.

No

Default is N.

XENV=

 Sets a LANSA environment variable. For details, refer to Regional Settings

No